Pular para o conteúdo principal

Extended KYC

O KYC estendido retorna a data de nascimento além das informações básicas e possibilita consultar dados de uma pessoa menor de idade


Autenticação

A API utiliza autenticação baseada em chave de API (API Key), que deve ser enviada no cabeçalho das requisições para garantir o acesso seguro aos endpoints.

Cabeçalho da requisição

CampoTipoObrigatórioDescrição
AuthorizationstringSimChave de API

Buscar detalhes estendidos por CPF

Este endpoint retorna informações detalhadas sobre a pessoa associada ao CPF consultado, como parte do processo de verificação KYC. Como descrito abaixo, há um campo destinado à data de nascimento.

Método

POST http://kyc.del.tech/kyc/extended

Corpo da requisição

{
"document": "123124141512",
"birthDate": "2002-12-22"
}
CampoTipoObrigatórioDescrição
documentstringSimCPF válido
birthDatedateNãoData de nascimento

Casos de sucesso

Caso obtenha uma resposta 200 segue abaixo todas as informações que poderão ser retornadas:

CampoTipoDescrição
_idstringIdentificador do documento
namestringNome da pessoa consultada
documentstringDocumento da pessoa sem máscara
ageintIdade da pessoa
isAdultbooleanRetorna se a pessoa é adulta (verdadeiro ou falso)
isAlivebooleanRetorna se a pessoa está viva (verdadeiro ou falso)
cpfStatusstringRetorna o status do CPF da pessoa – (CANCELADA ou REGULAR)
birthDatedateRetorna a data de nascimento
isPepbooleanRetorna se a pessoa é PEP (verdadeiro ou falso)
responseTimeMilisecondsintRetorna o tempo de processamento dos dados na API em milissegundos

Exemplo

{
"_id": "12345678909",
"name": "Pessoa",
"document": "12345678909",
"age": 60,
"isAdult": true,
"isAlive": true,
"cpfStatus": "CANCELADA",
"birthDate": "1965-01-01T00:00:00Z",
"isPep": false,
"responseTimeMiliseconds": 9
}

Caso o documento informado pertença a uma pessoa menor de idade, os dados só serão compartilhados se o campo "birthDate" for preenchido corretamente na requisição. Caso contrário, o único dado retornado será a indicação de que se trata de um menor de idade.

CampoTipoDescrição
isAdultbooleanRetorna se a pessoa é adulta (verdadeiro ou falso)
responseTimeMilisecondsintRetorna o tempo de processamento dos dados na API em milissegundos

Exemplo

{
"isAdult": false,
"responseTimeMiliseconds": 9
}

Casos de Erro

400 - Requisição inválida

Caso o documento informado não esteja em um formato válido

{
"status": 400,
"timestamp": "2024-06-01T20:59:59.999Z",
"responseTimeMiliseconds": 9,
"errors": [
"Documento inválido"
]
}

401 - Não autorizado

Caso não seja enviado um token válido.

{
"status": 401,
"timestamp": "2024-06-01T20:59:59.999Z",
"responseTimeMiliseconds": 9,
"errors": [
"Unauthorized"
]
}