Skip to main content
GET
cURL

Quando usar

O envio respondeu 202 e você precisa acompanhar. Devolve o mesmo corpo do resultado completo.

Prefira webhook a polling

Status terminais: VALIDATED, FAILED, OUT_OF_SCOPE, MANUAL_REVIEW, REJECTED_QUALITY. Enquanto não for um deles, o documento ainda está no pipeline. Assinar registry.document.assessed evita o laço de polling por completo.
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

docId
string
required

Id do documento, devolvido pelo validate_document ou pelo confirm_registry_document.

Response

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

Resultado completo de um documento, da classificacao ao parecer.

documentId
string
registryId
string
type
enum<string>

O tipo LIDO pela classificacao.

Available options:
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
expectedType
enum<string> | null

O tipo PEDIDO no envio. Sustenta a verificacao EXPECTED_TYPE_MATCH.

Available options:
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
expectedTypes
enum<string>[]

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

Available options:
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
status
enum<string>
Available options:
RECEIVED,
CLASSIFYING,
CLASSIFIED,
EXTRACTING,
EXTRACTED,
VALIDATING,
VALIDATED,
FAILED,
MANUAL_REVIEW,
OUT_OF_SCOPE,
REJECTED_QUALITY
version
integer
isCurrent
boolean
classification
object | null

O que a classificacao concluiu, com as alternativas consideradas.

ambiguous
boolean

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

statusReason
string | null

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

stages
object | null

O que rodou nesta tentativa e o que veio reaproveitado.

extraction
object | null

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.

fieldConfidences
object | null

Confianca por caminho de campo.

validation
object | null
assessment
object | null
processedAt
string<date-time> | null
attempt
integer