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

StatusCodeSignificado
200OKRequisição processada com sucesso.
202AcceptedJob assíncrono criado. Faça polling em poll_url.
401invalid_api_key / revoked_api_keyFalha de autenticação.
402insufficient_creditsCréditos insuficientes pra completar a operação.
403plan_does_not_allow_api / insufficient_scopePlano não permite ou escopo da chave não cobre a operação.
404not_foundRecurso (ex: CNPJ, job_id) não existe.
409idempotency_conflict / idempotency_in_progressConflito de Idempotency-Key. Veja seção dedicada.
422validation_errorBody ou query params inválidos.
429rate_limitedExcedeu rate limit. Aguarde Retry-After segundos.
500internal_errorErro 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.