Related People KYC

O Related People KYC realiza a verificação e retorno das pessoas relacionadas a uma pessoa com base no documento informado, como parte do processo de identificação e análise de vínculos familiares e sociais.

---

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

Este endpoint retorna as pessoas relacionadas à pessoa vinculada ao CPF consultado, com base no processo de verificação KYC.

Método

POST http://kyc.del.tech/kyc/related-people

Corpo da requisição

{
  "document": "98765432100"
}

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
name	string	Nome da pessoa relacionada
people	array	Lista de pessoas relacionadas

Campos do objeto people

Campo	Tipo	Descrição
_id	string	Identificador do documento
people	array	Lista de pessoas relacionadas
relationType	string	Tipo de relação (ex.: MOTHER, FATHER, UNCLE)
level	string	Nível de relação (ex.: DIRECT, INDIRECT)
startDate	string	Data de início do vínculo
endDate	string	Data de término do vínculo

Exemplo caso de sucesso

{
  "_id": "98765432100",
  "people": [
    {
      "name": "ANA PAULA SILVA SOUZA",
      "relationType": "MOTHER",
      "level": "DIRECT",
      "startDate": "2000-01-01T00:00:00Z",
      "endDate": "9999-12-31T23:59:59.9999999"
    },
    {
      "name": "JOÃO CARLOS SOUZA",
      "relationType": "FATHER",
      "level": "DIRECT",
      "startDate": "2000-01-01T00:00:00Z",
      "endDate": "9999-12-31T23:59:59.9999999"
    },
    {
      "name": "MARIA EDUARDA SOUZA",
      "relationType": "SISTER",
      "level": "DIRECT",
      "startDate": "2010-06-15T00:00:00Z",
      "endDate": "9999-12-31T23:59:59.9999999"
    }
  ]
}

---

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"]
}