💡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. Ideal para campanhas de marketing, onboarding de clientes, análises de risco e compliance.

URL Base

A API está hospedada no seguinte endereço:

https://api.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:

  1. O token deve ser enviado como parâmetro na URL da requisição.
  2. O token é obrigatório para realizar consultas.

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.

Parâmetros

NomeTipoObrigatórioDescrição
CELULARstringNãoCelular do indivíduo. Pode ser enviado com ou sem formatação.
EMAILstringNãoE-mail do indivíduo. Deve ter uma formatação válida.
TOKENstringSimToken de autenticação necessário para a consulta.

Exemplos de Requisição

Usando cURL

curl 'https://api.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": "lead-123456",
    "usuario": "Ana",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 900
  },
  "retorno": {
    "cpf": "123.456.789-09",
    "nome": "João Silva",
    "sexo": "Masculino",
    "dataNascimento": "15/03/1990",
    "idade": 33,
    "signo": "Peixes",
    "nomeMae": "Maria Silva",
    "telefones": [
      {
        "telefoneComDDD": "(11) 91234-5678",
        "telemarketingBloqueado": false,
        "operadora": "Vivo",
        "tipoTelefone": "Móvel",
        "whatsApp": true}
    ],
    "enderecos": [
      {
        "logradouro": "Rua das Flores",
        "numero": "123",
        "complemento": "Apto 101",
        "bairro": "Jardim",
        "cidade": "São Paulo",
        "uf": "SP",
        "cep": "12345-678"
      }
    ],
    "emails": [
      {
        "enderecoEmail": "joao.silva@example.com"
      }
    ],
    "rendaEstimada": "R$ 5.000,00"
  }
}

9. 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.
408Tempo esgotado: consulta não foi concluída no prazo.
500Erro interno: falha no processamento da consulta.
503Serviço em manutenção: indisponível temporariamente.

10. 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.