API REST · v1.0.0
Documentação da API LeadCNPJ
Integre o LeadCNPJ ao seu CRM, ERP ou ferramenta de automação. Consulte CNPJs, busque empresas por filtros firmográficos e enriqueça listas em lote — tudo via REST.
Visão Geral
Erros e códigos
Todos os erros são retornados como JSON com formato consistente:
{
"error": {
"code": "invalid_api_key",
"message": "Chave de API não encontrada.",
"request_id": "01J9X8QKT9YBFZ3A5MPN2RD1WE"
}
}
Códigos de status
| Status | Code | Significado |
|---|---|---|
| 200 | OK | Requisição processada com sucesso. |
| 202 | Accepted | Job assíncrono criado. Faça polling em poll_url. |
| 401 | invalid_api_key / revoked_api_key | Falha de autenticação. |
| 402 | insufficient_credits | Créditos insuficientes pra completar a operação. |
| 403 | plan_does_not_allow_api / insufficient_scope | Plano não permite ou escopo da chave não cobre a operação. |
| 404 | not_found | Recurso (ex: CNPJ, job_id) não existe. |
| 409 | idempotency_conflict / idempotency_in_progress | Conflito de Idempotency-Key. Veja seção dedicada. |
| 422 | validation_error | Body ou query params inválidos. |
| 429 | rate_limited | Excedeu rate limit. Aguarde Retry-After segundos. |
| 500 | internal_error | Erro inesperado. Reporte ao suporte com o request_id. |
Request ID
Toda resposta inclui o header X-Request-Id com um ID único (formato ULID). Em caso de erro, envie esse ID ao suporte pra investigação rápida.