registry

Reprocessar um documento

Roda o pipeline de novo. Sem stages, roda inteiro; com um subconjunto de CLASSIFY/EXTRACT/VALIDATE, as etapas de fora reaproveitam a tentativa anterior.

Duas regras que evitam surpresa: pular EXTRACT so funciona quando existe extracao gravada antes, e reexecutar EXTRACT sempre revalida. Confira stages.executed e stages.reused no resultado.

forceType corrige uma classificacao errada; como afirma o tipo, a conferencia EXPECTED_TYPE_MATCH sai SKIP naquela tentativa.

REPROCESSAR NAO COBRA DE NOVO: a cobranca e por documento, nao por tentativa.

post/v1/registry/{id}/documents/{docId}/reprocess

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/registry/{id}/documents/{docId}/reprocess
  • Auth: HTTP bearer

Path parameters

idstring required

Id do cadastro.

docIdstring required

Id do documento.

Request body

forceType'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'

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

stagesstring[]

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.

callbackUrlstring

Webhook chamado quando o reprocessamento terminar.

overrideFeedbackboolean

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.

Example request

{
  "stages": [
    "VALIDATE"
  ]
}

Response

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

documentIdstring
statusstring

Sempre RECEIVED nesta resposta.

attemptinteger

A tentativa que acabou de comecar.

Changes

No recorded changes to this operation across all 1 revision of this API.