---
title: "Lead Enriquecido por E-mail ou Celular"
description: "API Lead Enriquecido por E-mail ou Celular"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/de1c7f30-142b-48bf-8b0e-a6460c479c06
markdown: https://doc.apibrasil.io/apis/creditos/de1c7f30-142b-48bf-8b0e-a6460c479c06.md
source: apibrasil-documentation
---

# Lead Enriquecido por E-mail ou Celular

> API Lead Enriquecido por E-mail ou Celular

- **Categoria:** Consulta CPF
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 0,64 por consulta
- **Limite:** 990.000 por mês
- **Cadastro:** exige CNPJ
- **Versão:** v2
- **Publicada por:** APIBrasil
- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/de1c7f30-142b-48bf-8b0e-a6460c479c06/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

Autenticação: cabeçalho `Authorization: Bearer <token>`. Nada além disso.

Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção.

## Endpoints (1 endpoint)

### 1. POST /consulta/cpf/credits

Envie um POST com tipo=enriquecimento-lead e o celular (10 ou 11 dígitos com DDD, com ou sem máscara e +55) e/ou o email; ao menos um dos dois é obrigatório e cada um informado é validado. A resposta vem em data.dados e traz a situação (consta ou nada_consta), a entrada usada (email e celular), o documento, nome, sexo, data de nascimento, idade, signo, nome da mãe, renda_estimada (valor e texto), faixa_salarial, a lista telefones (numero, tipo, operadora, whatsapp e telemarketing_bloqueado), a lista enderecos, a lista emails, o perfil_lead (possui_whatsapp, possui_email, possui_telefone, renda_informada e faixa_etaria), um resumo com os totais e o link pdf do relatório. A cobrança acontece quando o contato é consultado e a resposta sai com HTTP 200, inclusive quando nada é encontrado para o e-mail ou celular (situacao nada_consta, com listas vazias e PDF); resposta sem conteúdo aproveitável (HTTP 404), e-mail ou celular recusado (400) e falhas de consulta (4xx/5xx) não são cobrados; campo celular ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia completa, sem cobrança, para qualquer celular válido.

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Corpo da requisição**

```json
{
  "tipo": "enriquecimento-lead",
  "celular": "11987654321",
  "email": "fulano.teste@exemplo.test",
  "homolog": true
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"enriquecimento-lead","celular":"11987654321","email":"fulano.teste@exemplo.test","homolog":true}'
```

Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação.

**Resposta de exemplo, do catálogo**

```json
{
  "user": {
    "first_name": "[omitido]",
    "email": "[omitido]",
    "cellphone": "[omitido]",
    "notification": "yes"
  },
  "balance": "399,360",
  "balance_before": "400,000",
  "tax": "0,640",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 0,64.",
  "valor_consulta": 0.64,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "dados": {
      "data_nascimento": "01/01/1990",
      "documento": "404.428.201-35",
      "emails": [
        "[omitido]"
      ],
      "enderecos": [
        {
          "bairro": "CENTRO",
          "cep": "01000000",
          "cidade": "EXEMPLO",
          "complemento": "APTO 1",
          "logradouro": "RUA DE TESTE",
          "numero": "100",
          "uf": "SP"
        }
      ],
      "entrada": {
        "celular": "11987654321",
        "email": "[omitido]"
      },
      "faixa_salarial": "Faixa 2 salários mínimos",
      "idade": 36,
      "nome": "FULANO DE TESTE",
      "nome_mae": "MARIA DE TESTE",
      "pdf": "(link do PDF da consulta)",
      "perfil_lead": {
        "faixa_etaria": "35_a_44",
        "possui_email": true,
        "possui_telefone": true,
        "possui_whatsapp": true,
        "renda_informada": true
      },
      "renda_estimada": {
        "texto": "3500",
        "valor": 3500
      },
      "resumo": {
        "total_emails": 1,
        "total_enderecos": 1,
        "total_telefones": 1
      },
      "sexo": "Masculino",
      "signo": "Capricórnio",
      "situacao": "localizado",
      "telefones": [
        {
          "numero": "11987654321",
          "operadora": "OPERADORA TESTE",
          "telemarketing_bloqueado": false,
          "tipo": "Celular",
          "whatsapp": true
        }
      ]
    }
  }
}
```

Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica.

## Armadilhas: o que uma integração erra sem avisar

Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto:

1. **O erro chega no CORPO, com HTTP 200.**
   A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`.

2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.**
   Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los.

3. **Cada chamada custa dinheiro.**
   Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas.

4. **HTTP 402 é saldo insuficiente, e repetir não resolve.**
   É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos.

5. **`extra_charges` cobra à parte do preço da consulta.**
   Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois.

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/de1c7f30-142b-48bf-8b0e-a6460c479c06/openapi.json
- Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md)
- SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md)
- Índice da documentação: https://doc.apibrasil.io/llms.txt
- Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/de1c7f30-142b-48bf-8b0e-a6460c479c06
