Skip to main content
GET
Ler um documento

Authorizations

Authorization
string
header
required

A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.

Path Parameters

id
string
required

O id do documento. O id começa com doc_.

Response

O documento, com os campos.

Um documento, com os campos.

id
string
required

O id do documento.

Pattern: ^doc_[1-9][0-9]*$
Example:

"doc_310"

document_type
object
required
status
enum<string>
required

O andamento do documento. pending: o documento espera o envio. uploaded: o documento chegou e espera a revisão. approved: o operador aprovou o documento. rejected: o operador recusou o documento.

Available options:
pending,
uploaded,
approved,
rejected
reading_status
enum<string>
required

O andamento da leitura do documento. not_started: a leitura não começou. extracting, enriching e validating: a leitura está em curso. complete: a leitura terminou. failed: a leitura falhou. no_reader: o tipo de documento não tem leitura.

Available options:
not_started,
extracting,
enriching,
validating,
complete,
failed,
no_reader
contact
object | null
required

O contato do documento. O valor é null quando o documento não tem contato.

collection_id
string | null
required

O id da coleta do documento. O valor é null enquanto o documento está na Triagem.

Pattern: ^col_[1-9][0-9]*$
Example:

"col_40"

in_triage
boolean
required

Com true, o documento está na Triagem e ainda não tem coleta.

discarded
boolean
required

Com true, o documento está descartado.

discard_reason
enum<string> | null
required

O motivo do descarte. O valor é null no documento que não está descartado. outside_pack: nenhum pacote de operação ativo pede o tipo do documento. identical_copy: o documento repete o arquivo de outro documento. superseded: um documento mais novo substituiu este. operator: o operador descartou o documento.

Available options:
outside_pack,
identical_copy,
superseded,
operator,
null
number
string | null
required

O número impresso que identifica o documento, como o número da fatura. O valor é null antes da leitura.

Example:

"INV-81244/2026"

arrival_channel
enum<string> | null
required

O canal de chegada do arquivo. O valor é null no slot vazio. email: o arquivo chegou por e-mail. portal_upload: o cliente enviou o arquivo no portal. operator_upload: o operador enviou o arquivo na tela. spreadsheet: o arquivo saiu de uma planilha. vault: o cliente reaproveitou no portal um arquivo do Cofre. api: o arquivo chegou pela API.

Available options:
email,
portal_upload,
operator_upload,
spreadsheet,
vault,
api,
null
arrived_at
string<date-time> | null
required

A data e a hora da chegada do arquivo, no fuso horário da organização. O valor é null no slot vazio.

files
object[]
required

Os arquivos do documento. No slot vazio, a lista é vazia.

created_at
string<date-time>
required

A data e a hora da criação, no fuso horário da organização.

Example:

"2026-09-25T10:30:00.000-03:00"

fields
object[]
required

Os campos do tipo de documento, na ordem do catálogo, sem os campos de arquivo. O campo sem resposta vem com value igual a null.