Detalhes

Códigos de erro

Erros vêm sempre no envelope padrão, com success: false, um error curto e uma message explicativa.

HTTP	error	O que aconteceu
200	`Sem resultado`	A consulta funcionou, mas a fonte não encontrou nada para o valor consultado. Não é cobrada.
400	`Validação Falhou`	Algum parâmetro está em formato inválido (CPF, CEP, nome, etc.).
400	`Formato Inválido`	Campo com formato incorreto — ex.: cpfParcial com caracteres não numéricos.
401	`Não Autorizado`	Chave de API ausente ou inválida no cabeçalho Authorization.
403	`Assinatura Inativa`	Não há assinatura ativa na conta.
403	`Plano sem Acesso API`	Seu plano atual não permite integração via API.
403	`Módulo Bloqueado no Plano`	O módulo desse endpoint não está liberado para a API no seu plano.
403	`Limite Não Configurado`	Não há cota configurada para esse módulo no seu plano.
403	`Limite Esgotado`	A cota diária do módulo acabou e a 'Consulta adicional via API' está desativada. Ative-a no perfil para cobrar do saldo ao exceder.
403	`Erro Financeiro`	Saldo insuficiente para a operação solicitada.
404	`Módulo Inexistente`	O módulo requisitado não existe.
403	`Módulo Inativo`	O módulo foi desativado e não está disponível para consulta.
503	`Módulo em Manutenção`	O módulo está temporariamente em manutenção. Tente novamente mais tarde.
503	`Fonte Indisponível`	A fonte de dados não respondeu. Tente novamente em instantes. Não é cobrada.
400	`Erro de Execução`	Erro inesperado ao processar a requisição. Tente novamente.

O que fazer em cada caso

200 Sem resultado — a fonte não encontrou nada para o valor consultado. Não é falha: não repita a chamada. Não é cobrada.
400 — corrija o parâmetro antes de tentar de novo; repetir a mesma chamada dá o mesmo erro.
401 e 403 — chave, plano, cota ou saldo. Só muda depois de ajustar a conta ou esperar a cota renovar.
503 — a fonte ou o módulo está fora do ar. Tente de novo em alguns instantes, com espera crescente entre as tentativas. Não é cobrada.