Skip to main content
GET
Consultar Documento

Path Params

id
string
required
Identificador do documento, retornado no envio.Exemplo: 123e4567-e89b-12d3-a456-426614174000

Response

id
string
Identificador do documento.Exemplo: 123e4567-e89b-12d3-a456-426614174000
organizationId
string
Identificador da organização à qual o documento pertence.Exemplo: 123e4567-e89b-12d3-a456-426614174001
projectId
string
Identificador do projeto à qual o documento pertence.Exemplo: 123e4567-e89b-12d3-a456-426614174002
productId
string
Identificador do produto associado ao documento.Exemplo: 123e4567-e89b-12d3-a456-426614174003
cpf
string
CPF do titular do documento.Exemplo: 12345678909
status
string
Status atual do documento. Valores possíveis: PENDING, MERGING, UPLOADING, SENDING, SENT, PROCESSING, COMPLETED, ERROR, FAILED e TIMEOUT.Exemplo: COMPLETED
type
string
Tipo de processamento aplicado ao documento: docs, checklist ou ocr.Exemplo: docs
createdAt
datetime
Data e hora em que o documento foi registrado.Exemplo: 2026-06-01T12:00:00.000Z
updatedAt
datetime
Data e hora da última atualização do documento.Exemplo: 2026-06-01T12:05:00.000Z
sentAt
datetime
Data e hora do envio para análise.Exemplo: 2026-06-01T12:00:01.000Z
sentToBackofficeAt
datetime
Data e hora em que o documento chegou ao processamento.Exemplo: 2026-06-01T12:00:02.000Z
finishedAt
datetime
Data e hora da conclusão da análise.Exemplo: 2026-06-01T12:05:00.000Z
errorMessage
string
Mensagem do erro registrado, quando houver.Exemplo: null
errorCode
string
Código do erro registrado, quando houver.Exemplo: null
backofficeBatchId
string
Identificador do lote gerado no processamento. Enquanto estiver nulo, arquivos e face não estão disponíveis.Exemplo: 229462
requestId
string
Identificador da requisição que originou o documento.Exemplo: 7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c
name
string
Nome do titular extraído do documento durante a análise.Exemplo: JOAO DA SILVA
workflowPresetAlias
string
Alias do preset de workflow aplicado no envio.Exemplo: documentoscopia_auto_base_face_15min
result
object
Resultado da análise. Permanece nulo enquanto a análise não é concluída.
result.status
string
Parecer da análise. Valores possíveis: APPROVED, REJECTED, MANUAL_REVIEW e ERROR.Exemplo: APPROVED
result.confidenceScore
number
Índice de confiança da análise.Exemplo: 98.5
result.raw_response
object
Retorno completo da análise, como recebido do processamento.
result.processedBy
string
Origem do processamento do resultado.Exemplo: backoffice