As APIs separam quatro dimensões que não devem ser tratadas como sinônimos:
  • estado indica em que etapa o recurso está;
  • resultado descreve o que a operação encontrou;
  • cobertura informa quanto da execução foi conclusivo;
  • cobrança registra o efeito financeiro da operação.
Uma execução pode, por exemplo, estar completed e ainda retornar no_match. Isso é um resultado válido, não uma falha técnica.

Formatos de sucesso

Os códigos e exemplos específicos de cada operação aparecem na página da própria rota. O formato comum de falhas está na seção Erros, ao final da documentação.

Dossiê

completed representa cobertura integral. needs_review é terminal e entrega um resultado parcial útil. failed indica que a execução não atingiu a cobertura mínima do contrato.

Rastro

Somente found e not_found são conclusivos. Bloqueio, indisponibilidade, erro ou resposta ambígua nunca significam que o dado não existe.

Lente

no_result, no_match e no_face são resultados de negócio: a análise termina como completed, e a dimensão financeira informa se houve reembolso. O estado financeiro não substitui o estado da execução. Consulte Cobrança para interpretar débito, confirmação e reembolso.