Status e erros
O status HTTP e o status do body têm significados diferentes. Leia os dois.
Ainda não disponível. Estas páginas descrevem o contrato previsto para
/api/token-generate e /api/service-api, que ainda não respondem no servidor. A API ativa hoje é a REST v1.Como interpretar
| Resposta | Significado | O que fazer |
|---|---|---|
| HTTP 200 e status.code 200 | Consulta processada | Leia result |
| HTTP 200 e status.code 200, com result vazio | Pode ser falta de saldo: Not enough balance | Confira status.message e o saldo |
| HTTP 200 e status.code 400 | Dados inválidos ou service não liberado | Revise os campos e a liberação do service |
| HTTP 200 e status.code 401 | Produto inativo para esta credencial | Confirme o produto; gerar outro token não resolve |
| HTTP 401 ou 403 | Token ausente, expirado ou de outro ambiente | Gere outro token no ambiente certo |
| Tempo esgotado | A rede ou a fonte de dados demorou | Repita poucas vezes, com intervalo crescente |
Mensagens frequentes
| status.code | Mensagem | O que fazer |
|---|---|---|
| 400 | Don't have access to the service | Confira o alias e se o service está liberado |
| 400 | Imagem obrigatória não encontrada | Envie a imagem que o service exige |
| 400 | Face nao encontrada na base | Indexe a face antes de buscá-la |
| 400 | Não foi possível ler o documento | Envie uma imagem mais nítida do documento |
| 500 | Falha ao realizar consulta | Tente de novo depois; informe o externalId ao suporte |
Formato da falha
{
"result": {},
"status": {
"code": 400,
"message": "Serviço não disponível para este cliente."
}
}