Pular para o conteúdo principal

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​

CampoTipoObrigatórioDescrição
AuthorizationstringSimChave 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": "12345678901"
}
CampoTipoObrigatórioDescrição
documentstringSimCPF válido

Casos de sucesso​

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

CampoTipoDescrição
_idstringIdentificador do documento
retiredbooleanIndica se a pessoa está aposentada
recentlyGraduatedbooleanIndica se a pessoa se formou recentemente
recentlyMarriedbooleanIndica se a pessoa se casou recentemente
recentChildbooleanIndica se a pessoa teve um filho recentemente
recentGrandchildbooleanIndica se a pessoa teve um neto recentemente
adolescentChildbooleanIndica se a pessoa possui um filho adolescente
inMourningbooleanIndica se a pessoa está em luto
recentlyHiredbooleanIndica se a pessoa foi contratada recentemente
recentlyEntrepreneurialbooleanIndica se a pessoa iniciou um empreendimento recentemente

Exemplo caso de sucesso​

{
"_id": "12345678901",
"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"]
}