Envio e análise de documentos pessoais com ID One
stable
Este endpoint possibilita o envio da selfie e dos documentos pessoais do cliente para dar início ao processo de Onboarding.
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.
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é 35 minutos (em 65% dos casos retornam em até 6 minutos e em 85% retornam em até 12).
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://api-mtls.sandbox.bankly.com.br/document-analysis/{{documentNumber}}/deepface
--request POST
--url 'https://api-mtls.sandbox.bankly.com.br/document-analysis/{{documentNumber}}/deepface' \
--header 'api-version: 1' \
--header 'x-correlation-id: GUID' \
--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
--url 'https://api-mtls.sandbox.bankly.com.br/document-analysis/{{documentNumber}}/deepface' \
--header 'Api-version: 1' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'x-correlation-id: GUID' \
--form 'documentType="RG"' \
--form 'documentSide="FRONT"' \
--form 'provider="BANKLY"' \
--form 'image=@"/path/to/file"'
Importante
Recordamos que a selfie deverá ser enviada ao Bankly 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.
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
Scope | Descrição |
---|---|
kyc.document.deepface.write | Concede acesso para envio de imagens para análise com ID One. |
Cabeçalhos (Headers)
Nome | Descrição |
---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-correlation-id | Obrigatório. Informe um GUID, sendo um novo cada requisição. |
Parâmetros da rota (Path)
No path desta requisição, envie o seguinte campo:
Nome | Tipo | Descrição | Especificação |
---|---|---|---|
documentNumber | path | Obrigatório. Número do documento CPF do cliente pessoal ou representante legal da empresa. | Informe somente os números. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato de formulário:
Nome | Tipo | Descrição |
---|---|---|
documentType | text | Obrigatório. Tipo do documento RG, CNH, RNE, DNI, CRNM e SELFIE). |
documentSide | text | Obrigatório. Lado do documento (FRONT ou BACK). Quando o tipo do documento for SELFIE, este parâmetro será desprezado. |
image | file | Obrigatório. Arquivo da imagem no formato .jpeg, .jpg ou .png. |
provider | text | Obrigatório. Esse campo deve trazer o valor "UNICO_CHECK" apenas para o envio de selfie, e “BANKLY” para o envio das imagens dos documentos. |
providerMetadata | json | Item obrigatório apenas se o provider apresentar o valor "UNICO_CHECK". Trata-se de um JSON contendo propriedades sobre o documento. |
providerMetadata.isLastDocument | bool | Obrigatório. Para garantir sucesso no envio do documento, esse campo sempre deve ser enviado com o valor true. |
providerMetadata.encrypted | string | Obrigatório. Esse campo deve ser preenchido com o valor do campo encrypted , retornado ao efetuar uma captura de imagem com sucesso utilizando o SDK da Unico. |
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 202 indicará sucesso no envio das imagens.
Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:
Nome | Tipo | Descrição |
---|---|---|
token | string | Token que identifica a imagem enviada. |
{
"token": "tokenDoDocumentoEnviado"
}
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:
Nome do evento | Descrição |
---|---|
DOCUMENT_WAS_RECEIVED | A imagem do documento foi recebida, porém ela pode ainda não ter sido completamente analisada. |
Updated about 2 months ago