API
Consultar Documento
Consulte os dados e o resultado da análise de um documento
GET
Consultar Documento
Path Params
Identificador do documento, retornado no envio.Exemplo:
123e4567-e89b-12d3-a456-426614174000Response
Identificador do documento.Exemplo:
123e4567-e89b-12d3-a456-426614174000Identificador da organização à qual o documento pertence.Exemplo:
123e4567-e89b-12d3-a456-426614174001Identificador do projeto à qual o documento pertence.Exemplo:
123e4567-e89b-12d3-a456-426614174002Identificador do produto associado ao documento.Exemplo:
123e4567-e89b-12d3-a456-426614174003CPF do titular do documento.Exemplo:
12345678909Status atual do documento. Valores possíveis:
PENDING, MERGING, UPLOADING, SENDING, SENT, PROCESSING, COMPLETED, ERROR, FAILED e TIMEOUT.Exemplo: COMPLETEDTipo de processamento aplicado ao documento:
docs, checklist ou ocr.Exemplo: docsData e hora em que o documento foi registrado.Exemplo:
2026-06-01T12:00:00.000ZData e hora da última atualização do documento.Exemplo:
2026-06-01T12:05:00.000ZData e hora do envio para análise.Exemplo:
2026-06-01T12:00:01.000ZData e hora em que o documento chegou ao processamento.Exemplo:
2026-06-01T12:00:02.000ZData e hora da conclusão da análise.Exemplo:
2026-06-01T12:05:00.000ZMensagem do erro registrado, quando houver.Exemplo:
nullCódigo do erro registrado, quando houver.Exemplo:
nullIdentificador do lote gerado no processamento. Enquanto estiver nulo, arquivos e face não estão disponíveis.Exemplo:
229462Identificador da requisição que originou o documento.Exemplo:
7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0cNome do titular extraído do documento durante a análise.Exemplo:
JOAO DA SILVAAlias do preset de workflow aplicado no envio.Exemplo:
documentoscopia_auto_base_face_15minResultado da análise. Permanece nulo enquanto a análise não é concluída.
Parecer da análise. Valores possíveis:
APPROVED, REJECTED, MANUAL_REVIEW e ERROR.Exemplo: APPROVEDÍndice de confiança da análise.Exemplo:
98.5Retorno completo da análise, como recebido do processamento.
Origem do processamento do resultado.Exemplo:
backofficeConsultar Documento