registry

Status e resultado de um documento em analise

Consulta um documento pelo id, sem precisar do id do cadastro. E o caminho de polling depois de um 202 do validate_document.

Status terminais: VALIDATED, FAILED, OUT_OF_SCOPE, MANUAL_REVIEW, REJECTED_QUALITY. Enquanto nao for terminal, o documento ainda esta no pipeline.

Devolve o mesmo corpo do resultado completo, incluindo statusReason (por que parou num terminal que nao e falha tecnica) e stages (o que rodou e o que veio reaproveitado).

PREFIRA WEBHOOK: assine registry.document.assessed em vez de fazer polling em laco.

get/v1/registry/documents/{docId}/status

Request

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

Path parameters

docIdstring required

Id do documento, devolvido pelo validate_document ou pelo confirm_registry_document.

Response

Documento com status, classification, extraction, validation e assessment.

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.