Pular para o conteúdo

Erros

Nenhuma resposta 4xx ou 5xx consome crédito nem gera cobrança de excedente.

Formato do erro

Todo erro vem em JSON com error e, na maioria dos casos, message. Alguns trazem também code, que é o valor estável para tratar no seu código.

402 Payment Required

1{2 "error": "Payment Required",3 "message": "Limite de créditos excedido",4 "code": "CREDITS_EXHAUSTED"5}
StatusErroQuando aconteceO que fazer
400Invalid CPF formatO CPF não tem 11 dígitos numéricos.Corrija o CPF antes de reenviar.
400Invalid birthdatebirthdate ausente ou fora do formato AAAA-MM-DD.Envie uma data válida.
400INVALID_BATCH · INVALID_QUERYLote vazio, com mais de 1.000 itens ou mal formado; ou parâmetros de paginação inválidos.Ajuste o corpo ou a query.
401Invalid or missing API keyCabeçalho x-api-key ausente, chave inválida ou revogada, ou chave de outro ambiente (código WRONG_ENVIRONMENT).Confira a chave no painel.
402CREDITS_EXHAUSTEDPlano gratuito sem créditos no ciclo, ou lote maior que o saldo.Aguarde a renovação ou contrate um plano.
403ACCOUNT_BLOCKEDConta suspensa ou bloqueada.Fale com o suporte.
404CPF not foundCPF válido, mas sem correspondência na fonte oficial (ou data de nascimento divergente).É um resultado normal. Não tente de novo com os mesmos dados.
400INVALID_DOCUMENTValidação de documento: o corpo não traz `document` como texto.Envie o CPF ou o CNPJ no campo document.
400INVALID_CNPJ_FORMATO CNPJ não tem 14 caracteres ou os dígitos verificadores não conferem.Corrija o CNPJ. Para só conferir o número, use POST /v1/validate.
404CNPJ not foundCNPJ válido, mas sem registro nos Dados Abertos (código CNPJ_NOT_FOUND).É um resultado normal. Não tente de novo com os mesmos dados.
404BATCH_NOT_FOUNDLote inexistente, de outra conta ou expirado (24 horas).Envie o lote novamente.
422Invalid check digitOs dígitos verificadores do CPF não conferem.Corrija o CPF.
429Rate limit exceededVocê passou do limite de requisições por segundo do plano.Espere o tempo do cabeçalho Retry-After.
429Too many attempts for this CPFDatas de nascimento diferentes demais foram testadas para este CPF (código CPF_ATTEMPTS_EXCEEDED). A trava vale só para esse CPF.Confira a data de nascimento com o titular e espere o tempo do Retry-After. Não cobra crédito.
429Too many unsuccessful lookupsA conta teve consultas sem resultado (404) demais em pouco tempo (código ACCOUNT_MISS_BUDGET_EXCEEDED).Valide os dados antes de consultar e espere o Retry-After. Se for engano, fale com o suporte.
429Batch rate limit exceeded / Too many batches in progressOs lotes enviaram itens demais por minuto ou há itens demais aguardando processamento (códigos BATCH_RATE_LIMITED e BATCH_BACKLOG).Espere os lotes em andamento terminarem e envie o próximo.
500 · 503Service unavailableFalha temporária na infraestrutura ou na fonte oficial.Tente de novo com intervalo crescente.