💡A API Enriquecimento de Lead permite obter dados de cadastro de um indivíduo (CPF) a partir de um e-mail e/ou celular. Essa API utiliza fontes oficiais combinadas com inferências para retornar informações relevantes.
Introdução
A API Enriquecimento de Lead é projetada para fornecer informações completas sobre um lead a partir de informações básicas como celular e e-mail. Diferente da API Cadastro Pessoa Física, esta API é utilizada informando o e-mail e/ou celular do indivíduo a ser consultado. Ideal para campanhas de marketing, onboarding de clientes, análises de risco e compliance.
Fonte: Fornecedor Externo
Valor da Consulta: R$ 0,16
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br
Endpoint
GET /api/EnriquecimentoLead
Descrição: Endpoint para realizar a consulta de enriquecimento de leads.
Nota: Esta consulta não gera comprovantes.
Autenticação
Para acessar esta API, é necessário fornecer um token de autenticação.
Regras de Autenticação:
- O token deve ser enviado como parâmetro na URL da requisição.
- O token é obrigatório para realizar consultas.
- Em caso de dúvidas sobre o token, entre em contato com: suporte@directd.com.br
Campos da API
Informações Pessoais
- CPF: Cadastro de Pessoa Física.
- Nome: Nome completo do indivíduo.
- Sexo: Masculino ou Feminino.
- Data de Nascimento: Data de nascimento do indivíduo.
- Idade: Idade calculada com base na data de nascimento.
- Signo: Signo do zodíaco associado à data de nascimento.
- Nome da Mãe: Nome completo da mãe.
Telefones
- Lista de Telefones:
- Número: Número completo com DDD.
- Operadora: Operadora associada ao número.
- Tipo: Móvel ou Fixo.
- WhatsApp: Indica se o número é vinculado ao WhatsApp.
- Telemarketing Bloqueado: Indica se o número está bloqueado para telemarketing.
Endereços
- Lista de Endereços:
- Logradouro, Número, Complemento: Endereço completo.
- Bairro, Cidade, UF, CEP: Localização detalhada.
E-mails
- Lista de E-mails: Endereços de e-mail associados.
Renda
- Renda Estimada: Valor estimado da renda mensal.
- Faixa Salarial: Faixa de renda estimada.
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CELULAR | string | Não | O parâmetro CELULAR pode ser enviado com ou sem formatação. |
string | Não | O parâmetro EMAIL deve possuir formatação válida. | |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, entre em contato com: suporte@directd.com.br |
Exemplos de Requisição
Usando cURL
curl 'https://apiv3.directd.com.br/api/EnriquecimentoLead?EMAIL=example@example.com&TOKEN=seu_token_aqui'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "Enriquecimento de Lead",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"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"
}
}
Outros Códigos de Resposta
Código | Descrição |
---|---|
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: 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. |
Aplicações
- Prevenção de Autuações Fiscais
- Onboarding de Clientes e Fornecedores
- Prevenção de Lavagem de Dinheiro
- Análise de Risco/Crédito
- Compliance/ESG
- Prevenção de Roubo de Identidade
Notas Importantes
- Utilize apenas um parâmetro de consulta por vez (CELULAR ou EMAIL).
- Certifique-se de que o token de autenticação está ativo e válido.
- Informe apenas um único documento por requisição.