/api/CadastroPessoaFisica
💡 O endpoint
/api/CadastroPessoaFisica
permite consultar dados detalhados sobre Pessoas Físicas, incluindo informações cadastrais, dados pessoais e informações de contato.
Introdução
A API Cadastro - Pessoa Física - Básica oferece dados detalhados sobre pessoas físicas, incluindo:
- Informações cadastrais básicas;
- Dados pessoais e demográficos;
- Informações de contato;
- Dados de localização;
- Estimativas de renda.
Essa API é ideal para:
- Onboarding de Clientes
- Análise de Risco/Crédito
- Compliance e Due Diligence
- Enriquecimento de dados pessoais
URL Base
https://apiv3.directd.com.br
Endpoint
GET /api/CadastroPessoaFisica
Autenticação
A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401
).
Regras de Autenticação
- O
TOKEN
deve ser incluído como parâmetro obrigatório. - Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.
Campos da API
Dados Retornados
Informações Básicas
- CPF: Número do Cadastro de Pessoa Física
- Nome: Nome completo da pessoa
- Nome da Mãe: Nome completo da mãe
- Data de Nascimento: Data de nascimento da pessoa
- Idade: Idade atual calculada
- Sexo: Gênero da pessoa
- Signo: Signo do zodíaco
Dados de Contato
- Telefones:
- Número com DDD
- Tipo de telefone
- Operadora
- Flag WhatsApp
- Flag Telemarketing Bloqueado
- E-mails: Lista de endereços de e-mail
Localização
- Endereço Completo:
- Logradouro
- Número
- Complemento
- Bairro
- Cidade
- UF
- CEP
Dados Financeiros
- Renda Estimada: Valor estimado da renda
- Faixa Salarial: Classificação por faixa de renda
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CPF | string | Sim | CPF da pessoa a ser consultada (com ou sem formatação). |
TOKEN | string | Sim | Token necessário para autenticação. |
Exemplo de Requisição
Usando cURL
curl -X 'GET' \
'https://apiv3.directd.com.br/api/CadastroPessoaFisica?CPF=12345678901&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE' \
-H 'accept: application/json'
Respostas
Sucesso (200)
A consulta foi realizada com sucesso e retorna os dados da Pessoa Física.
{
"metaDados": {
"consultaNome": "Cadastro - Pessoa Física",
"consultaUid": "direct-123456",
"mensagem": "Consulta realizada com sucesso.",
"resultado": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 200
},
"retorno": {
"cpf": "123.456.789-01",
"nome": "João da Silva",
"sexo": "Masculino",
"dataNascimento": "01/01/1980",
"nomeMae": "Maria da Silva",
"idade": 44,
"signo": "Capricórnio",
"telefones": [
{
"telefoneComDDD": "(11) 99999-9999",
"telemarketingBloqueado": false,
"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",
"rendaFaixaSalarial": "De R$ 3.000,00 a R$ 7.000,00"
}
}
Códigos de Resposta
Código | Descrição |
---|---|
200 | Sucesso: os dados da consulta foram retornados corretamente. |
201 | Sucesso: a requisição async foi criada com sucesso e está em processamento. |
202 | Em Processamento: a requisição async ainda está em processamento. |
400 | Requisição inválida: parâmetros incorretos. |
401 | Não autenticado: token inválido ou ausente. |
403 | Não autorizado: saldo indisponível para realizar a consulta. |
404 | Não encontrado: registro não localizado. |
408 | Tempo esgotado: servidor não respondeu no prazo estabelecido. |
500 | Erro interno: falha no processamento da requisição. |
503 | Serviço indisponível: consulta em manutenção. |
Notas Importantes
- Apenas um CPF deve ser enviado por consulta.
- Este endpoint não gera comprovantes.
- O valor da consulta é de R$ 0,16 por requisição.
- Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br.