Life Stages KYC
O Life Stages KYC realiza a verificação e retorno dos estágios de vida de uma pessoa com base no documento informado, como parte do processo de identificação e análise comportamental.
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 estágios de vida por CPF
Este endpoint retorna os estágios de vida da pessoa associada ao CPF consultado, com base no processo de verificação KYC.
Método
POST http://kyc.del.tech/kyc/life-stages
Corpo da requisição
{
"document": "12345678909"
}
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 |
retired | boolean | Indica se a pessoa está aposentada |
recentlyGraduated | boolean | Indica se a pessoa se formou recentemente |
recentlyMarried | boolean | Indica se a pessoa se casou recentemente |
recentChild | boolean | Indica se a pessoa teve um filho recentemente |
recentGrandchild | boolean | Indica se a pessoa teve um neto recentemente |
adolescentChild | boolean | Indica se a pessoa possui um filho adolescente |
inMourning | boolean | Indica se a pessoa está em luto |
recentlyHired | boolean | Indica se a pessoa foi contratada recentemente |
recentlyEntrepreneurial | boolean | Indica se a pessoa iniciou um empreendimento recentemente |
Exemplo caso de sucesso
{
"_id": "12345678909",
"retired": true,
"recentlyGraduated": false,
"recentlyMarried": false,
"recentChild": false,
"recentGrandchild": false,
"adolescentChild": false,
"inMourning": false,
"recentlyHired": false,
"recentlyEntrepreneurial": false
}
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"]
}