Envio e análise de documentos pessoais com ID One

Este endpoint possibilita o envio das imagens de documentos do cliente pessoa física para análise no processo de Onboarding via Id One.

⚠️
Importante
As imagens enviadas passarão por análise automatizada. Certifique-se de que os arquivos atendam aos requisitos de formato e tamanho antes do envio.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O parceiro possua um clientId válido.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/kyc/id-one/individual/{clientId}/{documentNumber}

curl --location 'https://sandbox.hiperbanco.com.br/kyc/id-one/individual/{clientId}/{documentNumber}' \
--header 'version: cutting-edge' \
--header 'Content-Type: multipart/form-data' \
--form 'documentType="RG"' \
--form 'documentSide="FRONT"' \
--form 'image=@"/path/to/file"'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição	Especificação
`clientId`	`path`	Obrigatório. ID do cliente.	UUID
`documentNumber`	`path`	Obrigatório. Número do CPF do cliente.	Informe somente números.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato de formulário (formData):

Nome	Tipo	Descrição	Especificação
`documentType`	`text`	Obrigatório. Tipo do documento. Pode ser `"CNH"`, `"RG"`, `"RNE"`, `"DNI"` ou `"CRNM"`.	—
`documentSide`	`text`	Obrigatório. Lado do documento: `"FRONT"` ou `"BACK"`.	—
`image`	`file`	Obrigatório. Arquivo da imagem no formato `.jpeg`, `.jpg` ou `.png`. Tamanho máximo: 10MB.	—

--form 'documentType="RG"' \
--form 'documentSide="FRONT"' \
--form 'image=@"/path/to/file"'

❗️
Atenção
Apenas imagens nos formatos .jpeg, .jpg e .png são aceitas. Arquivos com outros formatos ou com tamanho superior a 10MB serão rejeitados.

Resposta (Response)

O status code 200 indicará sucesso na operação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`message`	`string`	Mensagem de confirmação do envio.
`token`	`string`	Token gerado após o recebimento bem-sucedido do arquivo.

{
    "message": "File uploaded successfully",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`400`	`INVALID_INPUT`	A requisição apresenta dados inválidos.	Ocorre quando os parâmetros de rota ou campos do body não atendem às validações.
`400`	`INVALID_CPF`	The documentNumber field must be a valid CPF.	Ocorre quando o CPF possui 11 dígitos, mas não é um CPF válido.
`404`	`CLIENT_NOT_FOUND`	Client not found.	O cliente informado não foi encontrado.
`404`	`ONBOARDING_NOT_FOUND`	Onboarding not found.	O Onboarding do cliente informado não foi encontrado.
`422`	`FILE_REQUIRED`	File (image) is required.	A imagem é obrigatória e não foi enviada na requisição.
`422`	`FILE_MIME_TYPE_NOT_ALLOWED`	File type 'application/pdf' is not allowed. Allowed types: image/jpeg, image/png, image/jpg	O formato do arquivo enviado não é permitido.
`422`	`FILE_SIZE_EXCEEDED`	File size exceeds the maximum allowed limit of 10MB.	O arquivo excede o tamanho máximo permitido de 10MB.
`422`	`INVALID_FILE_NAME`	Invalid file name. File name contains dangerous characters.	O nome do arquivo contém caracteres inválidos ou extensão não permitida.
`500`	`INTERNAL_SERVER_ERROR`	Internal server error.	Erro interno do servidor.

Eventos

Este endpoint não possui eventos relacionados a ele.