Skip to main content
POST
cURL

Quando usar

A classificação errou o tipo, a régua mudou, ou a leitura merece outra tentativa.

Reprocessar não cobra de novo

A cobrança é por documento, não por tentativa. Sem stages, roda o pipeline inteiro. Com um subconjunto de CLASSIFY, EXTRACT e VALIDATE, as etapas de fora reaproveitam a tentativa anterior. Confira stages.executed e stages.reused no resultado. forceType corrige uma classificação errada. Como ele afirma o tipo, a conferência EXPECTED_TYPE_MATCH sai SKIP naquela tentativa.

Dois limites

  • Documento que um operador já decidiu responde 409. Mande overrideFeedback: true para substituir a decisão pelo parecer novo.
  • Cada documento aceita até 5 tentativas. Depois disso, a resposta é 429 com Limite de reprocessamentos atingido.
A resposta 202 traz documentId, status (RECEIVED) e attempt, a tentativa que acabou de começar.
Contexto e vocabulário em Análise documental. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Path Parameters

id
string
required

Id do cadastro.

docId
string
required

Id do documento.

Body

application/json
forceType
enum<string>

Força o tipo documental (corrige uma classificação errada) e, com isso, dispensa a etapa de classificação.

Available options:
CONTRATO_SOCIAL,
ALTERACAO_CONTRATUAL,
ESTATUTO_SOCIAL,
REQUERIMENTO_EMPRESARIO,
PROCURACAO_PJ,
IRPJ_ECF,
DECLARACAO_FATURAMENTO,
CERTIDAO_JUNTA,
ATA_ASSEMBLEIA,
DOC_IDENTIDADE,
COMPROVANTE_RESIDENCIA,
DIRPF,
COMPROVANTE_RENDA,
CERTIDAO_PF,
PROCURACAO_PF,
FORA_DE_ESCOPO,
NAO_IDENTIFICADO,
CERTIDAO_PGFN_PJ,
CERTIDAO_FGTS,
CADIN_FEDERAL,
CADIN_ESTADUAL,
CERTIDAO_QSA,
CERTIFICADO_SIMPLES_NACIONAL,
ESOCIAL_PJ,
COMPROVACAO_ESTADO_CIVIL,
DEMONSTRACOES_FINANCEIRAS,
EXTRATO_BANCARIO
stages
enum<string>[]

Etapas a reexecutar. Omitir significa reprocessar tudo (classificar, extrair e validar). Cada etapa de fora da lista é pulada e o resultado da tentativa anterior é reaproveitado, o que aparece no resultado do documento em stages.reused. Pular EXTRACT exige tentativa anterior com extração gravada: sem ela a etapa roda normalmente, nunca devolvendo resultado vazio. Reexecutar EXTRACT força a revalidação mesmo que VALIDATE não esteja na lista: parecer antigo sobre extração nova seria mentira.

Available options:
CLASSIFY,
EXTRACT,
VALIDATE
Example:
callbackUrl
string

Webhook chamado quando o reprocessamento terminar.

overrideFeedback
boolean

Confirma a substituição da decisão que um operador já tomou sobre o parecer. Sem ela, documento já decidido recusa o reprocessamento com 409: a decisão humana não pode ser apagada em silêncio pelo parecer da tentativa nova.

Response

Confirmacao do reprocessamento (202), com a tentativa nova. O documento volta a RECEIVED.

documentId
string
status
string

Sempre RECEIVED nesta resposta.

attempt
integer

A tentativa que acabou de comecar.