Criação Processo Selfie
Este endpoint possibilita o envio da _selfie_do cliente para dar início ao processo de Onboarding.
ImportanteA 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çãoPara 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 siga as orientações da documentação da Unico Webview para a captura das selfies.
NotaRecordamos 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/documents/create-processcurl --location 'https://api-mtls.sandbox.bankly.com.br/documents/create-process' \
--header 'api-version: 1' \
--header 'Content-Type: application/json' \
--header 'x-correlation-id: correlationvalido' \
--header 'Authorization: Bearer tokenvalido' \
--header 'Cookie: __cf_bm=kmZusaqFw_RWH.vmXAgvdfsuRINXswzuJPaqpCcQLFc-1774896609.0033662-1.0.1.1-B5ASurhSHDG0e9OXcyK.xSYD2y1_Z6lfD7exyezvOavFro7F5rqVveAIsqCGH5fgjCbaBFbBkyJrCrN4LEtJG3eQhHG8dW.OlzdT4MnNlwBXWNCLCiMxZcf5ExeubGiu' \
--data '{
"documentNumber": "xxxxx",
"documentType": "SELFIE",
"documentSide": ""
}'
ImportanteA selfie deverá ser enviada pela Webview. A URL do Webview é válida dentro do prazo máximo de 7 dias ou até ser utilizada.
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.process.write | Concede acesso para criação do processo. |
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. |
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. Ex: SELFIE |
documentSide | text | Obrigatório. Lado do documento, que pode ser "FRONT" ou "BACK". Quando o tipo do documento for "SELFIE", este parâmetro será desprezado. |
documentNumber | text | Obrigatório. Número do documento do cliente pessoal ou representante legal da empresa (CPF) |
--form 'documentType="SELFIE"' \
--form 'documentNumber="01234567890"' \
--form 'documentSide=""'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:
{
"userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
"expiresAt": "2023-10-09T15:15:25.417105Z"
}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 16 hours ago
