Name KYC

O Name KYC realiza a verificação e retorno do nome completo de uma pessoa com base nos dados fornecidos, como parte do processo de identificação e validação de identidade.

---

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

Este endpoint retorna exclusivamente o nome da pessoa associada ao CPF consultado, como parte do processo de verificação KYC.

Método

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

Corpo da requisição

{
    "document": "123124141512",
}

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

Exemplo caso de sucesso

{
 "_id": "12345678909",
 "name": "Pessoa",
 "document": "12345678909",
}

---

Caso o documento informado pertença a uma pessoa menor de idade, o único dado retornado será a indicação de que se trata de um menor de idade.

Campo	Tipo	Descrição
isAdult	boolean	Retorna se a pessoa é adulta (verdadeiro ou falso)

Exemplo consulta menor de idade

{
 "isAdult": 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"
 ]
}