Envio e análise de documentos pessoais com ID One

Este endpoint possibilita o envio dos documentos pessoais do cliente após a captura da selfie para dar andamento 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.

❗️

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.

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 'Authorization: Bearer {{accessToken}}' \
--header 'x-correlation-id: GUID' \
--form 'documentType="RG"' \
--form 'documentSide="FRONT"' \
--form 'provider="BANKLY"' \
--form 'image=@"/path/to/file"'

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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

Corpo da requisição (Body)

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

--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:

{ 
    "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: