Criação Processo Selfie

Este endpoint possibilita o envio da selfie 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 siga as orientações da documentação da Unico Webview 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/kyc/id-one/individual/selfie/{clientId}/{documentNumber}

curl --location 'https://sandbox.hiperbanco.com.br/kyc/id-one/individual/selfie/{{clientId}}/{{documentNumber}}' \
--header 'version: cutting-edge'

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)

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.

Resposta (Response)

O status code 202 indicará sucesso na criação do processo de selfie.

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

Nome	Tipo	Descrição
`userRedirectUrl`	`string`	URL da Webview para onde o cliente deverá ser redirecionado para a selfie.
`expiresAt`	`string`	Data e hora de expiração da URL gerada (formato ISO 8601).

{
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "expiresAt": "2023-10-09T15:15:25.417105Z"
}

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. Apresente este código no suporte: `{correlationId}`.	Ocorre quando `clientId` ou `documentNumber` não atendem às validações. O `clientId` deve ser um UUID e o `documentNumber` deve conter exatamente 11 caracteres numéricos.
`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.	Cliente não encontrado.
`500`	`INTERNAL_SERVER_ERROR`	Internal server error.	Erro interno do servidor.

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.