API - Cadastro - Pessoa Física - Plus

💡Consulta responsável por retornar dados de cadastro de um CPF recuperadas de fontes oficiais e combinadas com inferências e outros dados relacionados, com dados adicionais como nome do pai, situação cadastral perante a Receita Federal e se possui óbito.

---

Introdução

A API Cadastro - Pessoa Física - Plus retorna dados cadastrais completos de uma pessoa física, incluindo informações oficiais, inferências, dados de parentesco, ocupação, renda, situação cadastral, óbito e mais. Ideal para onboarding de clientes e fornecedores e análise de risco/crédito.

Fonte: Fornecedor Externo

---

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

---

Endpoint

GET /api/CadastroPessoaFisicaPlus

Esse endpoint retorna informações detalhadas de uma pessoa física, com dados adicionais.

Regras:

1. Apenas um CPF deve ser enviado por requisição.
2. Este endpoint não permite a geração de comprovantes.

---

Autenticação

A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401).

Regras de Autenticação

1. O TOKEN deve ser incluído como parâmetro obrigatório.
2. Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.

---

Campos da API

Campos Retornados

• CPF
• Nome
• Sexo / Gênero
• Data de Nascimento
• Idade
• Signo
• Nome da Mãe
• Nome do Pai
• Classe Social
• Código CBO
• Classificação Brasileira de Ocupações (CBO)
• Renda Estimada
• Renda e Faixa Salarial
• Situação Cadastral
• Data da Situação Cadastral
• Flag Possui Óbito
• Flag Tem Óbito
• Data de Óbito
• Telefones
  • Telefone com DDD
  • Flag Telemarketing Bloqueado
  • Operadora
  • Tipo de Telefone
  • Flag WhatsApp
• Endereços
  • Logradouro
  • Número
  • Complemento
  • Bairro
  • Cidade
  • UF
  • CEP
• E-mails
  • Endereço de E-mail
• Lista de Parentesco
  • Grau de Parentesco
  • CPF
  • Nome
  • Data de Nascimento
  • Gênero
  • Flag Óbito
  • Data de Óbito
• Lista de Telefones
• Lista de Endereço
• Lista de E-mail

---

Parâmetros

Parâmetros da Requisição

---

Exemplo de Requisição

Usando cURL

curl -X 'GET' \
  'https://apiv3.directd.com.br/api/CadastroPessoaFisicaPlus?CPF=12345678900&TOKEN=seu_token_aqui' \
  -H 'accept: application/json'

---

Respostas

Sucesso (200)

A consulta foi realizada com sucesso e retorna os dados cadastrais.

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "string",
    "consultaUid": "string",
    "chave": "string",
    "usuario": "string",
    "mensagem": "string",
    "ip": "string",
    "resultadoId": 0,
    "resultado": "string",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": "string",
    "assincrono": true,
    "data": "dd/MM/yyyy HH:mm:ss",
    "tempoExecucaoMs": 0
  },
  "retorno": {
    "cpf": "string",
    "nome": "string",
    "sexo": "string",
    "dataNascimento": "string",
    "nomeMae": "string",
    "nomePai": "string",
    "idade": 0,
    "signo": "string",
    "classeSocial": "string",
    "codigoCBO": "string",
    "cbo": "string",
    "rendaEstimada": "string",
    "rendaFaixaSalarial": "string",
    "situacaoCadastral": "string",
    "dataSituacaoCadastral": "string",
    "possuiObito": true,
    "obito": true,
    "dataObito": "string",
    "telefones": [
      {
        "telefoneComDDD": "string",
        "telemarketingBloqueado": true,
        "operadora": "string",
        "tipoTelefone": "string",
        "whatsApp": true
      }
    ],
    "enderecos": [
      {
        "logradouro": "string",
        "numero": "string",
        "complemento": "string",
        "bairro": "string",
        "cidade": "string",
        "uf": "string",
        "cep": "string"
      }
    ],
    "emails": [
      {
        "enderecoEmail": "string"
      }
    ],
    "parentescos": [
      {
        "grauParentesco": "string",
        "cpf": "string",
        "nome": "string",
        "dataNascimento": "string",
        "genero": "string",
        "isObito": true,
        "obito": true,
        "dataObito": "string"
      }
    ]
  }
}

---

Erros Comuns

Exemplo de Erro 400

{
  "metaDados": {
    "consultaNome": "Cadastro - Pessoa Física - Plus",
    "mensagem": "Parâmetro Inválido! CPF: 12345678900",
    "resultado": "Documento Entrada Inválida",
    "apiVersao": "v3"
  },
  "retorno": null
}

---

Aplicações

• Onboarding de Clientes e Fornecedores
• Análise de Risco/Crédito

---

Notas Importantes

• O valor da consulta é de R$ 0,36.
• Apenas um CPF deve ser enviado por consulta.
• Este endpoint não gera comprovantes.
• Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br.