Skip to main content
As duas APIs usam os mesmos códigos de status HTTP, mas o corpo do erro muda de uma API para a outra. Trate o corpo conforme a API que você chamou.

Códigos de status comuns

API de Anti Fraude

O corpo traz uma mensagem estável em detail:
Nas rotas /analyses, o corpo de erro traz também elapsed_ms, os milissegundos inteiros que o servidor gastou até montar o erro, como chave irmã de detail:
O 409 ocorre quando a identidade da pessoa ou empresa consultada é ambígua. Endpoints que criam recursos cobráveis (POST /analyses, POST /reports, POST /adverse-media) checam o limite do plano antes de executar. Além dos erros documentados em cada página, eles podem retornar 429 com {"detail": "quota_exceeded"} (limite de uso do período esgotado) ou 403 com {"detail": "feature_not_in_plan"} (o plano atual não inclui o recurso). Esse 403 é diferente do 403 de escopo insuficiente, embora tenha o mesmo status. Algumas mensagens de erro do grafo vêm em inglês (por exemplo, "Graph node was not found."). O formato {"detail": "<mensagem>"} é o mesmo.

O caso do 422

Na API de Anti Fraude, o 422 traz detail como uma lista de erros por campo:
Trate detail como texto nos demais status e como lista de objetos apenas no 422.

API de Dados

O corpo traz um objeto erro com codigo e mensagem:
Aqui o 422 usa o mesmo formato, sem lista por campo. A lista completa de códigos está em Erros da API de Dados.