Orientações e respostas da equipe da Direct Data

💡O endpoint /api/CadastroPessoaFisicaPlus oferece consultas detalhadas de cadastro de uma pessoa física, utilizando o CPF como base. Além das informações básicas, também retorna dados adicionais, como nome do pai, situação cadastral na Receita Federal e indicador de óbito.

---

Introdução

A API Cadastro - Pessoa Física - Plus amplia as informações disponíveis no cadastro básico, incluindo:

• Dados cadastrais completos de uma pessoa física;
• Verificação da situação cadastral na Receita Federal;
• Informação sobre óbito, se aplicável;
• Dados adicionais como nome do pai e data da situação cadastral.

Ideal para onboarding de clientes e fornecedores e análise de risco/crédito.

---

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

Dados Retornados

• CPF: Cadastro de Pessoa Física do consultado.
• Nome: Nome completo do consultado.
• Sexo: Gênero informado.
• Data de Nascimento: Data de nascimento do consultado.
• Idade: Idade calculada com base na data de nascimento.
• Signo: Signo correspondente à data de nascimento.
• Nome da Mãe: Nome completo da mãe do consultado.
• Nome do Pai: Nome completo do pai do consultado.
• Telefones:
  • Telefone com DDD: Número de telefone com o DDD.
  • Flag Telemarketing Bloqueado: Indica se o número está bloqueado para telemarketing.
  • Operadora: Operadora telefônica associada ao número.
  • Tipo de Telefone: Ex.: celular, fixo.
  • Flag WhatsApp: Indica se o número está associado ao WhatsApp.
• Endereços:
  • Logradouro: Nome da rua/avenida.
  • Número: Número do imóvel.
  • Complemento: Detalhes adicionais do endereço.
  • Bairro: Bairro do endereço.
  • Cidade: Cidade do endereço.
  • UF: Unidade Federativa (Estado) do endereço.
  • CEP: Código de Endereçamento Postal.
• E-mails:
  • Endereço de E-mail: E-mail do consultado.
• Renda Estimada: Renda mensal estimada.
• Possui Óbito: Indicador se a pessoa está registrada como falecida.
• Situação Cadastral: Situação atual do CPF perante a Receita Federal.
• Data da Situação Cadastral: Data da última atualização da situação cadastral.

---

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=68ADA2C3-8016-47DA-ADE6-13AE239308FE' \
  -H 'accept: application/json'

---

7. Respostas

Sucesso (200)

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

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Cadastro - Pessoa Física - Plus",
    "consultaUid": "direct-123456",
    "mensagem": "Consulta realizada com sucesso.",
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 200
  },
  "retorno": {
    "cpf": "12345678900",
    "nome": "João da Silva",
    "sexo": "Masculino",
    "dataNascimento": "01/01/1980",
    "nomeMae": "Maria da Silva",
    "nomePai": "José da Silva",
    "idade": 44,
    "signo": "Capricórnio",
    "telefones": [
      {
        "telefoneComDDD": "(11) 91234-5678",
        "telemarketingBloqueado": true,
        "operadora": "Vivo",
        "tipoTelefone": "Celular",
        "whatsApp": true}
    ],
    "enderecos": [
      {
        "logradouro": "Rua Exemplo",
        "numero": "123",
        "complemento": "Apto 45",
        "bairro": "Centro",
        "cidade": "São Paulo",
        "uf": "SP",
        "cep": "01000-000"
      }
    ],
    "emails": [
      {
        "enderecoEmail": "joao.silva@email.com"
      }
    ],
    "rendaEstimada": "R$ 5.000,00",
    "possuiObito": false,
    "situacaoCadastral": "Regular",
    "dataSituacaoCadastral": "01/01/2024"
  }
}

---

8. 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}

---

Notas Importantes

• 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.