Envio e análise de documentos pessoais com ID One - Representante Legal (PJ)

Este endpoint possibilita o envio da selfie e dos documentos pessoais do representante legal de uma empresa PJ (LTDA, SA e TS).

⚠️

Importante

A selfie deve ser enviada antes das outras imagens e é preciso aguardar que ela seja aprovada antes de iniciar a captura das imagens dos documentos.

O documento verso é a ultima imagem a ser enviada.

Tempo de análise das selfies

Uma pequena parcela das imagens das selfies não pode ser analisada de forma automática, devido à identificação de:

• Rostos diferentes para o mesmo CPF;
• Rostos semelhantes para diferentes CPFs;
• Pontos biométricos semelhantes a alguma pessoa já identificada como suspeita de fraude.

Nesses casos, é preciso realizar a análise manual das imagens, que fará com que o tempo de SLA de resposta aumente para até 4 horas (em 65% dos casos retornam em até 24 minutos e em 85% retornam em até 50 minutos).

❗️

Atenção

Para aumentar as chances de aprovação no Onboarding, é preciso seguir todas as recomendações contidas na página Orientações para envio de fotos.

Pré-requisito

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

• O parceiro tenha feito a integração com o Biometric SDK da Unico para a captura das selfies.

📘

Nota

Recordamos que as fotos do documento deverão ser capturadas a partir da máscara do parceiro.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Onboarding/idOneRepresentativeLegal?idClient={{clientId}}&documentNumber={{documentNumber))

--request POST 'https://sandbox.hiperbanco.com.br/Onboarding/idOneRepresentativeLegal?idClient={{clientId}}&documentNumber={{documentNumber))' \
--header 'version: cutting-edge' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {{accessToken}}' \
--form 'documentType="SELFIE"' \
--form 'documentSide="FRONT"' \
--form 'provider="UNICO_CHECK"' \
--form 'providerMetadata="{\"isLastDocument\": true,\"encrypted\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCE****************G2JPEDKdi3kUzIZCr5mnGAdT//2Q==\"}"' \
--form 'image=@"/path/to/file"'

--request POST 'https://sandbox.hiperbanco.com.br/Onboarding/idOneRepresentativeLegal?idClient={{clientId}}&documentNumber={{documentNumber))' \
--header 'version: cutting-edge' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {{accessToken}}' \
--form 'documentType="RG"' \
--form 'documentSide="FRONT"' \
--form 'provider="BANKLY"' \
--form 'image=@"/path/to/file"'

⚠️

Importante

Recordamos que a selfie deverá ser enviada ao Hiperbanco dentro do intervalo máximo de 10 minutos, contando a partir do momento captura da foto, devido ao tempo de expiração do token JWT. Caso a imagem seja enviada após esse período, ela será recusada e o parceiro deverá solicitar ao cliente uma nova captura de selfie. Após o envio da selfie, não há tempo limite para finalizar o Onboarding.

Cabeçalhos (Headers)

Parâmetros da rota (Path / Query)

Corpo da requisição (Body)

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

📘

Nota

Recomendamos orientar o seu cliente a não sorrir nas selfies.

--form 'documentType="SELFIE"' \
--form 'documentSide="FRONT"' \
--form 'provider="UNICO_CHECK"' \
--form 'providerMetadata="{\"isLastDocument\": true,\"encrypted\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCE****************G2JPEDKdi3kUzIZCr5mnGAdT//2Q==\"}"' \
--form 'image=@"/path/to/file"'

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

Resposta (Response)

O status code 200 indicará sucesso no envio das imagens.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

{
    "message": "Arquivo enviado com sucesso",
    "token": "88vVlwqYGfG6aS1PaIBgSMRKFC2yxGIu"
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: