Indicators KYC

O Indicators KYC realiza a verificação e retorno de diversos indicadores associados a uma pessoa com base no documento informado, como parte do processo de análise e avaliação 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 indicadores por CPF

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

Método

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

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
indicators	object	Objeto contendo os indicadores associados ao documento

Os indicadores podem conter os seguintes campos:

Campo	Tipo	Descrição
_id	string	Identificador do documento
rating	string	Classificação que varia de A (melhor resultado) a H (pior resultado)
score	number	Valor entre 0 (menos significativo) e 1 (mais significativo), quando aplicável

Exemplo caso de sucesso

{
    "_id": "12345678909",
    "indicators": {
        "employmentStability": {
            "rating": "B"
        },
        "entrepreneurshipLevel": {
            "rating": "C"
        },
        "findabilityByAddress": {
            "rating": "A",
            "score": 0.12
        },
        "findabilityByPhone": {
            "rating": "E",
            "score": 0.87
        },
        "findabilityByEmail": {
            "rating": "D",
            "score": 0.65
        },
        "generalFindability": {
            "rating": "B",
            "score": 0.54
        },
        "litigiousnessLevel": {
            "rating": "F"
        },
        "diversityExposureLevel": {
            "rating": "A"
        }
    }

---

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