registry

Validar um documento e receber o parecer

Manda UM arquivo (PDF, JPG ou PNG, ate 15MB) e recebe classificacao, campos extraidos, verificacoes e parecer.

A ENTRADA E UNICA: voce nao diz que documento e. A plataforma reconhece sozinha 24 tipos (contrato social, alteracao contratual, estatuto, ata de assembleia, requerimento de empresario, procuracao PJ/PF, certidao da Junta, QSA, IRPJ/ECF, declaracao de faturamento, extrato bancario, certidao PGFN, FGTS, CADIN federal/estadual, Simples Nacional, eSocial, documento de identidade, comprovante de residencia, DIRPF, comprovante de renda, certidao PF, estado civil). O balanco (DEMONSTRACOES_FINANCEIRAS) e o 25o tipo com leitura propria, mas NAO e reconhecido sozinho: mande typeHint DEMONSTRACOES_FINANCEIRAS.

O FORMATO DA SAIDA DEPENDE DO TIPO IDENTIFICADO: o objeto extraction traz os campos daquele tipo. Todo campo folha vem como { value, confidence, page }; campo ausente vem com value null e confidence 0, nunca inventado.

Responde 200 com o resultado quando o pipeline fecha dentro de waitSeconds, ou 202 com { documentId, statusUrl } quando passa. No 202, continue com get_document_status.

Use expectedType para conferir se veio o documento CERTO: a classificacao roda normal e o tipo lido e confrontado com o pedido. E o que pega o arquivo legitimo enviado no campo errado. Use typeHint so quando a origem ja garante o tipo: ele PULA a classificacao.

O arquivo e arquivado no cadastro de expectedDocument, criando o cadastro se nao existir.

post/v1/registry/validate-document

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/registry/validate-document
  • Auth: HTTP bearer

Response

Resultado completo (200) com type, extraction, validation.checks[] e assessment; ou { documentId, statusUrl } (202) quando ainda processa.

documentIdstring
registryIdstring
type'CONTRATO_SOCIAL' | 'ALTERACAO_CONTRATUAL' | 'ESTATUTO_SOCIAL' | 'REQUERIMENTO_EMPRESARIO' | 'ATA_ASSEMBLEIA' | 'PROCURACAO_PJ' | 'CERTIDAO_JUNTA' | 'CERTIDAO_QSA' | 'IRPJ_ECF' | 'DECLARACAO_FATURAMENTO' | 'CERTIFICADO_SIMPLES_NACIONAL' | 'DEMONSTRACOES_FINANCEIRAS' | 'EXTRATO_BANCARIO' | 'CERTIDAO_PGFN_PJ' | 'CERTIDAO_FGTS' | 'CADIN_FEDERAL' | 'CADIN_ESTADUAL' | 'ESOCIAL_PJ' | 'DOC_IDENTIDADE' | 'COMPROVANTE_RESIDENCIA' | 'DIRPF' | 'COMPROVANTE_RENDA' | 'CERTIDAO_PF' | 'PROCURACAO_PF' | 'COMPROVACAO_ESTADO_CIVIL' | 'FORA_DE_ESCOPO' | 'NAO_IDENTIFICADO'

O tipo LIDO pela classificacao.

expectedType'CONTRATO_SOCIAL' | 'ALTERACAO_CONTRATUAL' | 'ESTATUTO_SOCIAL' | 'REQUERIMENTO_EMPRESARIO' | 'ATA_ASSEMBLEIA' | 'PROCURACAO_PJ' | 'CERTIDAO_JUNTA' | 'CERTIDAO_QSA' | 'IRPJ_ECF' | 'DECLARACAO_FATURAMENTO' | 'CERTIFICADO_SIMPLES_NACIONAL' | 'DEMONSTRACOES_FINANCEIRAS' | 'EXTRATO_BANCARIO' | 'CERTIDAO_PGFN_PJ' | 'CERTIDAO_FGTS' | 'CADIN_FEDERAL' | 'CADIN_ESTADUAL' | 'ESOCIAL_PJ' | 'DOC_IDENTIDADE' | 'COMPROVANTE_RESIDENCIA' | 'DIRPF' | 'COMPROVANTE_RENDA' | 'CERTIDAO_PF' | 'PROCURACAO_PF' | 'COMPROVACAO_ESTADO_CIVIL' | 'FORA_DE_ESCOPO' | 'NAO_IDENTIFICADO' | 'null' nullable

O tipo PEDIDO no envio. Sustenta a verificacao EXPECTED_TYPE_MATCH.

expectedTypesstring[]

O CONJUNTO pedido, quando o item nasceu de um requisito societario.

status'RECEIVED' | 'CLASSIFYING' | 'CLASSIFIED' | 'EXTRACTING' | 'EXTRACTED' | 'VALIDATING' | 'VALIDATED' | 'FAILED' | 'MANUAL_REVIEW' | 'OUT_OF_SCOPE' | 'REJECTED_QUALITY'
versioninteger
isCurrentboolean
ambiguousboolean

true quando outra alternativa passou de 0,35 de confianca.

statusReasonstring nullable

Por que o documento parou num terminal que nao e falha tecnica.

extractionobject nullable

Os campos lidos. A FORMA DEPENDE DO TIPO identificado: cada um dos 25 tipos tem o seu conjunto, documentado campo a campo em https://developers.gyramais.com.br/api-reference/kyc/formatos-de-retorno. Todo campo folha vem como { value, confidence, page }; campo ausente vem com value null e confidence 0.

fieldConfidencesobject nullable

Confianca por caminho de campo.

processedAtstring date-time nullable
attemptinteger

Changes

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