/api/CadastroReceitaPessoaFisica

💡 O endpoint /api/CadastroReceitaPessoaFisica permite consultar dados cadastrais detalhados de uma pessoa física com base no CPF. A consulta combina dados de fontes oficiais, inferências e informações da Receita Federal, como situação cadastral, nome do pai e informações de óbito.

Introdução

A API Cadastro + Receita Federal - Pessoa Física oferece informações completas de uma pessoa física, incluindo:

  • Dados básicos de cadastro;
  • Situação cadastral perante a Receita Federal;
  • Informações de óbito e histórico cadastral;
  • Contatos, endereços e mais.

Essa API é ideal para onboarding de clientes e fornecedores, bem como para análise de risco/crédito.


URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/CadastroReceitaPessoaFisica

Esse endpoint retorna dados detalhados de uma pessoa física.

Regras

  1. Apenas um CPF deve ser enviado por requisição.
  2. O endpoint permite a geração de um comprovante em PDF, caso o parâmetro GERARCOMPROVANTE seja informado (adicional de 50% no valor da consulta).

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

Cadastro

  • CPF: Cadastro de Pessoa Física.
  • Nome: Nome completo da pessoa.
  • Sexo: Gênero da pessoa.
  • Data de Nascimento: Data de nascimento no formato dd/MM/yyyy.
  • Nome da Mãe: Nome completo da mãe.
  • Idade: Idade calculada com base na data de nascimento.
  • Signo: Signo zodiacal.
  • 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 principal associado à pessoa.
  • Renda Estimada: Estimativa de renda mensal.

Receita Federal

  • Número do CPF: CPF completo, incluindo dígito verificador.
  • Nome Pessoa Física: Nome oficial registrado na Receita Federal.
  • Situação Cadastral: Status cadastral perante a Receita Federal.
  • Flag Possui Óbito: Indica se há registro de óbito para o CPF.

Parâmetros

NomeTipoObrigatórioDescrição
CPFstringSimCPF da pessoa (com ou sem formatação).
TOKENstringSimToken de autenticação.
GERARCOMPROVANTEbooleanNãoDefine se um comprovante PDF deve ser gerado.

Exemplo de Requisição

Usando cURL

curl -X 'GET' \
  'https://apiv3.directd.com.br/api/CadastroReceitaPessoaFisica?CPF=12345678901&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE&GERARCOMPROVANTE=true' \
  -H 'accept: application/json'

Erros Comuns

CódigoDescrição
400Requisição inválida: parâmetros incorretos.
401Não autenticado: token inválido ou ausente.
403Não autorizado: saldo insuficiente para realizar a consulta.
404Não encontrado: registro não localizado.