Skip to main content
POST
cURL

Quando usar

Segundo passo do envio assíncrono: o arquivo já está no armazenamento e você dispara a análise.

Os dois campos de tipo

expectedType pede um tipo e a conferência roda. typeHint afirma o tipo e a classificação é pulada. Enviando os dois, typeHint vence. O resultado chega pelo callbackUrl, pelo webhook da organização, ou por Status do documento.
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.

Body

application/json
key
string
required

A key devolvida pelo presign, exatamente como veio.

fileName
string
required

Nome do arquivo que fica no dossie.

typeHint
enum<string>

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.

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
expectedType
enum<string>

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).

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
personDocument
string

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

callbackUrl
string

URL chamada quando o documento terminar de processar.

Response

documentId do documento em processamento (202).

documentId
string
status
enum<string>
Available options:
RECEIVED,
CLASSIFYING,
CLASSIFIED,
EXTRACTING,
EXTRACTED,
VALIDATING,
VALIDATED,
FAILED,
MANUAL_REVIEW,
OUT_OF_SCOPE,
REJECTED_QUALITY