Códigos de erro
Esta página é a fonte única de verdade para tratamento de erros. Códigos de erro específicos de SDK estão documentados na página Tratamento de erros de cada SDK; esta página cobre erros no nível do contrato de API.
Códigos de status HTTP
| Código | Significado |
|---|---|
200 OK | Requisição realizada com sucesso. |
400 Bad Request | Payload malformado ou campos obrigatórios ausentes. O corpo identifica os campos problemáticos. |
401 Unauthorized | Autenticação ausente, expirada ou inválida. |
403 Forbidden | Autenticação válida, mas o tenant não está habilitado para o recurso solicitado (ex.: chamada de uma capacidade não incluída na sua APIKEY). |
404 Not Found | O recurso não existe ou não pertence ao tenant autenticado. |
409 Conflict | O recurso existe, mas não está no estado correto para a operação (ex.: busca de documentos de um processo ainda em andamento). |
410 Gone | O recurso existia, mas foi excluído conforme a política de retenção (endpoints de busca de documentos), ou o processo existe mas encerrou em estado de erro — veja Obter Processo. |
429 Too Many Requests | Você atingiu o limite de taxa. Tente novamente com backoff exponencial. |
5xx | Erro da plataforma. Tente novamente com backoff; se persistir, contate o suporte com o corpo da resposta e o timestamp. |
Política de retry
| Status | Deve tentar novamente? | Como |
|---|---|---|
5xx | Sim | Backoff exponencial (1s, 2s, 4s, 8s, …). Limite de 5 tentativas. |
429 | Sim | Respeite o header Retry-After se presente; caso contrário, backoff exponencial. |
4xx (outros) | Não | A requisição está incorreta. Corrija a entrada antes de tentar novamente. |
401 | Condicionalmente | Renove o access token uma vez. Se a nova requisição também retornar 401, o problema é estrutural — não tente novamente. |
A plataforma IDCloud atualmente não expõe um mecanismo de idempotency-key nos endpoints de criação. Tenha cuidado ao tentar novamente Criar Processo — um erro de rede em um 5xx pode ter efetivamente tido sucesso no lado do servidor, e uma nova tentativa criaria um processo duplicado. Em caso de dúvida, recupere os processos recentes pelo seu ID de correlação interno antes de tentar novamente.
Onde ficam os erros do SDK
Os catálogos de erros do Android SDK, iOS SDK e Flutter SDK estão documentados na página de Tratamento de erros dedicada de cada SDK:
Estes cobrem erros do lado do dispositivo (permissão de câmera negada, timeout de captura, rede inacessível no dispositivo) — separados dos erros do lado da API documentados aqui.