Registration Data - Brazil

Consulta responsável por retornar dados de cadastro de um CPF - Brazil.

Casos de Uso

Integração com Registration Data - Brazil | Consulta de Dados Cadastrais e Empresariais
Onboarding KYC e validação de identidade
Análise de risco/crédito com dados cadastrais e socioeconômicos
Prevenção a fraude em abertura de conta e cadastro

Aplicações

Prevenção de Roubo de Identidade

Benefícios

Documentação de Registration Data - Brazil | Consulta de Dados Cadastrais e Empresariais acessível e atualizada
Dados atualizados e padronizados
Aumento de aprovação com menos atrito
Conformidade com políticas internas e LGPD

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.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br/api/RegistrationData/Brazil

Endpoint

GET https://apiv3.directd.com.br/api/RegistrationData/Brazil?Cpf={0}&Name={1}&Surname={2}&Dob{3}&Token=Seu_Token

Descrição: Endpoint para realizar consultas Registration Data - Brazil.

Nota: Esta consulta não gera comprovantes.

Campos Retornados

Age: Idade do indivíduo
City: Cidade do registro em questão
Complement: Complemento do endereço do registro em questão
CPF: CPF do indivíduo
Date of Birth: Data de nascimento do indivíduo
E-mail Address: Endereço de e-mail da entidade
Gender: Gênero do indivíduo
List of Addresses: Lista os endereços do indivíduo
List of Phones: Telefones vinculados ao indivíduo
Lista de E-mail: E-mails vinculados à entidade
Name: Nome do indivíduo/registro
Name of Mother: Nome da mãe do indivíduo
Neighborhood: Bairro do endereço
Number: Número do registro em questão
Phone Number: Número de telefone incluindo DDD
Phone Type: Informa o tipo de telefone, como por exemplo, se ele é fixo ou celular
Postal Code: Número CEP/código postal do endereço
Salary Range: Renda estimada do indivíduo consultado
State: Nome do estado
Street: Nome da rua, avenida, travessa, alameda ou outros onde está localizado o endereço.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`DOB{3}`	string	Não
`SURNAME`	string	Sim
`NAME`	string	Sim
`CPF`	string	Sim	O parâmetro CPF pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.
`TOKEN`	string	Sim	O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "string",
    "consultaUid": "string",
    "chave": "string",
    "usuario": "string",
    "mensagem": "string",
    "ip": "string",
    "resultadoId": 0,
    "resultado": "string",
    "apiVersao": "v3",
    "enviarCallback": false,
    "gerarComprovante": false,
    "urlComprovante": "string",
    "assincrono": true,
    "data": "dd/MM/yyyy HH:mm:ss",
    "tempoExecucaoMs": 0
  },
  "retorno": {
    "name": "string",
    "dateOfBirth": "string",
    "gender": "string",
    "age": 0,
    "phones": [
      {
        "phoneNumber": "string",
        "phoneType": "string"
      }
    ],
    "addresses": [
      {
        "street": "string",
        "number": "string",
        "complement": "string",
        "neighborhood": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string"
      }
    ],
    "emails": [
      {
        "emailAddress": "string"
      }
    ],
    "salaryRange": "string",
    "estimatedSalary": "string",
    "cpf": "string",
    "nameMother": "string"
  }
}

Erros Comuns

Código	Descrição
400	Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos.
401	Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso.
403	Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível.
404	Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado.
408	Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido.
500	Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte.
503	Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte.

Notas Importantes

Informe apenas um único documento por requisição
Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228