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.
Cadastro + Receita Federal - Pessoa Física
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.
Casos de Uso
- Integração com Cadastro + Receita Federal - Pessoa Física
- 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
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Documentação de Cadastro + Receita Federal - Pessoa Física acessível e atualizada
- Dados atualizados e padronizados
- Aumento de aprovação com menos atrito
- Conformidade com políticas internas e LGPD
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/CadastroReceitaPessoaFisicaEndpoint
GET https://apiv3.directd.com.br/api/CadastroReceitaPessoaFisica?CPF={0}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Cadastro + Receita Federal - Pessoa Física.
Nota: Esta consulta gera comprovantes em PDF.
Esta API suporta geração de comprovantes em PDF
Campos Retornados
- Ano de Óbito: Ano de óbito, caso o indivíduo consultado veio a óbito
- Bairro: Bairro do endereço
- Cadastro: Retorna os dados de cadastro do documento consultado
- CEP: Número CEP do endereço
- Cidade: Cidade do registro em questão
- Código de Controle do Comprovante: Código de controle do comprovante
- Complemento: Complemento do endereço do registro em questão
- CPF: CPF do indivíduo
- Data da Consulta: Data da consulta
- Data de Emissão: Data da emissão do certificado
- Data de Inscrição: Data de inscrição
- Data de Nascimento: Data de nascimento do indivíduo
- Dígito Verificador: Digito verificador do indivíduo
- Endereço de E-mail: Endereço de e-mail da entidade
- Flag Data de Inscrição anterior a 1990: Informa se a data de inscrição na Receita Federal é anterior a 1990
- Flag Possui Óbito: Retorna se o indivíduo veio a óbito ou não. True(verdadeiro) ou false(falso)
- Flag Telemarketing Bloqueado: Informa se o telefone é bloqueado para telemarketing. True(verdadeiro) ou false(falso)
- Flag WhatsApp: Informa se o telefone está vinculado ao WhatsApp. True(verdadeiro) ou false(falso)
- Idade: Idade do indivíduo
- Lista de E-mail: E-mails vinculados à entidade
- Lista de Endereço: Lista os endereços do indivíduo
- Lista de Telefones: Telefones vinculados ao indivíduo
- Logradouro: Nome da rua, avenida, travessa, alameda ou outros onde está localizado o endereço.
- Nome: Nome do indivíduo/registro
- Nome da Mãe: Nome da mãe do indivíduo
- Nome da Pessoa Física: Informa o nome da pessoa física consultada
- Nome Social: Nome social do indivíduo
- Número: Número do registro em questão
- Número do CPF: Informa o número do CPF
- Operadora: Operadora do telefone
- Receita: Retorna os dados da Receita Federal referente ao documento consultado.
- Renda Estimada: Renda estimada do indivíduo consultado
- Sexo: Gênero do indivíduo
- Signo: Signo do indivíduo
- Situação Cadastral: Situação cadastral do indivíduo
- Telefone com DDD: Número de telefone incluindo DDD
- Tipo de Telefone: Informa o tipo de telefone, como por exemplo, se ele é fixo ou celular
- UF: Unidade Federativa (estado) referente ao registro
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CPF | string | Sim | O parâmetro CPF pode ser enviado com ou sem formatação. |
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": {
"cadastro": {
"cpf": "string",
"nome": "string",
"sexo": "string",
"dataNascimento": "string",
"nomeMae": "string",
"idade": 0,
"signo": "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"
}
],
"rendaEstimada": "string",
"rendaFaixaSalarial": "string"
},
"receita": {
"numeroCPF": "string",
"nomePessoaFisica": "string",
"nomeSocial": "string",
"dataNascimento": "string",
"situacaoCadastral": "string",
"dataInscricao": "string",
"dataInscricaoAnterior1990": true,
"digitoVerificador": "string",
"dataEmissao": "string",
"codigoControleComprovante": "string",
"dataConsulta": "string",
"possuiObito": true,
"anoObito": "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
- Para obter o comprovante desta consulta, utiliza-se: '&GerarComprovante=habilitar' na URL
- 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