Basic KYC

---

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 por CPF

Este endpoint retorna informações detalhadas da pessoa associada ao CPF consultado, como parte do processo de verificação KYC.

Método

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

Corpo da requisição

{
    "document": "12345678901"
}

Campo	Tipo	Obrigatório	Descrição
document	string	Sim	CPF válido

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 – (BIRTH DATE AND DOCUMENT DOESN'T MATCH, CANCELADA, CPF COM DADOS INCOMPLETOS, CPF DOES NOT EXIST IN RECEITA FEDERAL DATABASE, INVALID DOCUMENT, NULA, PENDENTE DE REGULARIZACAO, REGULAR, SUSPENSA, TITULAR FALECIDO)
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": "12345678901",
 "name": "Pessoa",
 "document": "12345678901",
 "age": 60,
 "isAdult": true,
 "isAlive": true,
 "cpfStatus": "CANCELADA",
 "isPep": false,
 "responseTimeMiliseconds": 9
}

---

Caso o documento da pessoa informada seja de um menor de idade, os dados desses indivíduos não podem ser compartilhados. Portanto, nesses cenários o único dado retornado é o indicador de que é 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"
 ]
}