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
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
Authorization | string | Sim | Chave 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"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
document | string | Sim | CPF válido |
birthDate | date | Não | Data de nascimento |
Casos de sucesso
Caso obtenha uma resposta 200 segue abaixo todas as informações que poderão ser retornadas:
Campo | Tipo | Descrição |
---|---|---|
_id | string | Identificador do documento |
name | string | Nome da pessoa consultada |
document | string | Documento da pessoa sem máscara |
age | int | Idade da pessoa |
isAdult | boolean | Retorna se a pessoa é adulta (verdadeiro ou falso) |
isAlive | boolean | Retorna se a pessoa está viva (verdadeiro ou falso) |
cpfStatus | string | Retorna o status do CPF da pessoa – (CANCELADA ou REGULAR) |
birthDate | date | Retorna a data de nascimento |
isPep | boolean | Retorna se a pessoa é PEP (verdadeiro ou falso) |
responseTimeMiliseconds | int | Retorna 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.
Campo | Tipo | Descrição |
---|---|---|
isAdult | boolean | Retorna se a pessoa é adulta (verdadeiro ou falso) |
responseTimeMiliseconds | int | Retorna 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"
]
}