Orientações e respostas da equipe da Direct Data

💡A API Registration Data - Brazil é destinada à consulta de dados cadastrais de um CPF no Brasil. Ela retorna informações pessoais, como nome, endereço, telefone e e-mail, além de dados relacionados à faixa salarial e outros atributos cadastrais.

Introdução

A API Registration Data - Brazil é ideal para validação de identidade e cadastro de pessoas físicas no Brasil. As informações são provenientes de uma base de dados confiável, proporcionando suporte essencial para a prevenção de fraudes e melhoria no processo de onboarding.

---

URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

---

Endpoint

Consulta de Cadastro

GET /api/RegistrationDataBrazil

Descrição: Endpoint para realizar a consulta de dados cadastrais de pessoas físicas.

Nota: A consulta pode ser realizada utilizando CPF ou combinando os parâmetros NAME, SURNAME e DOB.

---

Autenticação

Para acessar esta API, é necessário fornecer um token de autenticação.

Regras de Autenticação:

1. O token deve ser enviado como parâmetro na URL da requisição.
2. O token é obrigatório para realizar consultas.

---

Campos da API

Informações Cadastrais

• Name: Nome completo da pessoa.
• Surname: Sobrenome da pessoa.
• Date of Birth: Data de nascimento no formato yyyy/MM/dd.
• Gender: Gênero da pessoa.
• Age: Idade calculada a partir da data de nascimento.
• CPF: Cadastro de Pessoa Física.
• Name of Mother: Nome da mãe.

Informações de Contato

• Phones:
  • Phone Number: Número do telefone com DDD.
  • Phone Type: Tipo de telefone (fixo, celular, etc.).
• Addresses:
  • Street: Nome da rua.
  • Number: Número do endereço.
  • Complement: Complemento do endereço, se aplicável.
  • Neighborhood: Bairro.
  • City: Cidade.
  • State: Estado.
  • Postal Code: Código postal (CEP).
• Emails:
  • Email Address: Endereço de e-mail.

Informações Financeiras

• Salary Range: Faixa salarial estimada.

---

Parâmetros

---

Exemplos de Requisição

Usando CPF:

curl 'https://api.directd.com.br/api/RegistrationDataBrazil?CPF=12345678909&TOKEN=seu_token_aqui'

Usando Nome e Data de Nascimento:

curl 'https://api.directd.com.br/api/RegistrationDataBrazil?NAME=João&SURNAME=Silva&DOB=1980/03/15&TOKEN=seu_token_aqui'

---

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Registration Data - Brazil",
    "consultaUid": "regData-123456",
    "usuario": "João Silva",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 150
  },
  "retorno": {
    "name": "JOÃO SILVA",
    "dateOfBirth": "1980-03-15",
    "gender": "Masculino",
    "age": 44,
    "phones": [
      {
        "phoneNumber": "(11) 91234-5678",
        "phoneType": "Celular"
      }
    ],
    "addresses": [
      {
        "street": "Rua das Flores",
        "number": "123",
        "complement": "Apto 45",
        "neighborhood": "Jardim das Rosas",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "12345-678"
      }
    ],
    "emails": [
      {
        "emailAddress": "joao.silva@email.com"
      }
    ],
    "salaryRange": "Acima de R$ 5.000,00",
    "cpf": "123.456.789-09",
    "nameMother": "MARIA DA SILVA"
  }
}

---

Erros Comuns