Situações do documento
Todo documento tem um status, consultado em GET /v1/documents/{id} e enviado pelo webhook a cada mudança.
status | Significado |
|---|---|
queued | Na fila. Durante as tentativas automáticas, reason traz processing_failed. |
processing | Em extração. |
review | Em conferência humana (só quando o resultado precisa de revisão). |
completed | Liberado; o resultado pode ser buscado. |
rejected | Recusado; reason traz a categoria. |
error | O processamento falhou depois das tentativas automáticas. |
O caminho é queued → processing → completed, passando por review quando o resultado precisa de conferência humana. rejected e error são finais, até uma nova conferência pedida pelo portal.
GET /v1/documents/{id}
{
"id": "00000000-0000-4000-8000-000000000001",
"status": "review",
"reason": null,
"pages": 12,
"processing_seconds": 41.5,
"engine_version": "1.0.0",
"model_version": "1.0.0"
}Motivos
O campo reason é null na maior parte do tempo. Quando preenchido, é um código estável; nenhum motivo traz texto do documento.
reason | Com status | Significado |
|---|---|---|
processing_failed | queued | Falhou uma tentativa; o finstat tenta de novo sozinho. |
processing_failed | error | Falhou depois das tentativas, inclusive PDF acima de 100 páginas ou com páginas acima de A2. |
attempts_exhausted | error | As tentativas automáticas acabaram. |
client_request | review ou queued | A empresa pediu nova conferência pelo portal. |
| categoria de recusa | rejected | Veja a tabela abaixo. |
Categorias de recusa
| reason | Rótulo no portal |
|---|---|
INCORRECT_DATA | Dados incorretos |
DATE_MISMATCH | Data diferente da solicitada |
CORRUPTED_OR_PROTECTED | Documento corrompido ou protegido |
DUPLICATE_OR_ALREADY_ANALYZED | Documento duplicado |
BLANK_DOCUMENT | Documento em branco |
UNREADABLE_DOCUMENT | Documento ilegível |
INCOMPLETE_MISSING_PAGES | Faltam páginas ou contas |
INCOMPLETE_MISSING_FINANCIAL_STATEMENTS | Faltam demonstrações financeiras |
INCOMPLETE_WRONG_COMPANY | Documento de outra empresa |
REJECTED_BY_REQUEST | Rejeição solicitada |
INVALID_NATIONAL_REGISTRATION | CNPJ diferente do informado |
OTHER_REASON | Outro motivo |
Nova conferência
Um documento completed ou rejected pode voltar a review (ou a queued, se foi recusado antes de qualquer extração) quando a empresa pede nova conferência no portal, com reason client_request. Até a nova liberação, /result responde 409 e /history continua com a última versão liberada.