registry

Confirmar o upload e disparar a analise

Segundo passo do envio assincrono: confirma o arquivo que ja foi para o armazenamento e dispara o pipeline. Responde 202 com o documentId.

O resultado chega por webhook (registry.document.assessed) ou por get_document_status.

Sobre os dois campos de tipo: expectedType PEDE um tipo e a conferencia roda; typeHint AFIRMA o tipo e a classificacao e pulada. Enviando os dois, typeHint vence.

post/v1/registry/{id}/documents

Request

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

Path parameters

idstring required

Id do cadastro.

Request body

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

Afirma o tipo documental do arquivo: o pipeline ADOTA este tipo e PULA a etapa de classificação. Use quando a origem do arquivo já garante o tipo (o operador escolheu na tela, o formulário só aceita aquele documento). Como a classificação não roda, não existe leitura automática a confrontar e a verificação EXPECTED_TYPE_MATCH sai SKIP. Não use typeHint para dizer "eu pedi este documento": para isso existe o expectedType.

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

Tipo documental que a solicitação PEDIU. Não força nada e não pula etapa alguma: a classificação roda normalmente e o tipo lido é confrontado com este valor na verificação EXPECTED_TYPE_MATCH. Tipo lido igual ao pedido, a verificação passa; diferente, reprova o documento (ou vira ressalva quando a leitura do tipo está com pouca confiança). É o campo que pega o arquivo legítimo enviado no campo errado (uma declaração de IR subida como comprovante de residência), que sem ele seria classificado, validado e aprovado como o tipo que de fato é. Omitir significa envio livre no dossiê: sem pedido, a verificação sai SKIP. Combinado com typeHint no mesmo envio, o typeHint vence e a verificação sai SKIP (não há classificação a confrontar).

keystring required

A key devolvida pelo presign, exatamente como veio.

fileNamestring required

Nome do arquivo que fica no dossie.

personDocumentstring

CPF ou CNPJ de uma pessoa do quadro deste cadastro, para anexar o documento a ela. Precisa estar na arvore societaria.

callbackUrlstring

URL chamada quando o documento terminar de processar.

Response

documentId do documento em processamento (202).

documentIdstring
status'RECEIVED' | 'CLASSIFYING' | 'CLASSIFIED' | 'EXTRACTING' | 'EXTRACTED' | 'VALIDATING' | 'VALIDATED' | 'FAILED' | 'MANUAL_REVIEW' | 'OUT_OF_SCOPE' | 'REJECTED_QUALITY'

Changes

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