O endpoint /api/CadastroPessoaFisica permite consultar dados detalhados sobre Pessoas Físicas, incluindo informações cadastrais, dados pessoais e informações de contato.
Cadastro - Pessoa Física - Bá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.
Casos de Uso
- Onboarding e verificação de identidade (KYC)
- Análise de risco e crédito com dados cadastrais
- Prevenção à fraude em cadastros e transações
- Enriquecimento de perfis para segmentação
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Reduz custos operacionais com decisões automatizadas
- Melhora a acurácia na identificação de clientes
- Acelera o time-to-yes reduzindo atritos na jornada
- Aumenta a conformidade com políticas internas e LGPD
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/CadastroPessoaFisicaEndpoint
GET https://apiv3.directd.com.br/api/CadastroPessoaFisica?CPF={0}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Cadastro - Pessoa Física - Básica.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- Bairro: Bairro do endereço
- CEP: Número CEP do endereço
- Cidade: Cidade do registro em questão
- Complemento: Complemento do endereço do registro em questão
- CPF: CPF do indivíduo
- Data de Nascimento: Data de nascimento do indivíduo
- Endereço de E-mail: Endereço de e-mail da entidade
- 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
- Número: Número do registro em questão
- Operadora: Operadora do telefone
- Renda Estimada: Renda estimada do indivíduo consultado
- Sexo: Gênero do indivíduo
- Signo: Signo 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": {
"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"
}
}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 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