Skip to main content
GET
Listar Documentos

Query Params

cpf
string
CPF do titular, com ou sem máscara.Exemplo: 12345678909
name
string
Nome do titular. A busca é parcial e não diferencia maiúsculas de minúsculas.Exemplo: JOAO
workflowPresetAlias
string
Alias do preset de workflow, em correspondência exata.Exemplo: documentoscopia_auto_base_face_15min
status
string
Status atual do documento. Valores possíveis: PENDING, MERGING, UPLOADING, SENDING, SENT, PROCESSING, COMPLETED, ERROR, FAILED e TIMEOUT.Exemplo: COMPLETED
consolidatedStatus
string
Status consolidado do documento. Valores possíveis: processing, error, approved, rejected e pending.Exemplo: approved
createdFrom
string
Início do intervalo de criação, em ISO 8601.Exemplo: 2026-01-01T00:00:00.000Z
createdTo
string
Fim do intervalo de criação, em ISO 8601.Exemplo: 2026-12-31T23:59:59.999Z
sortBy
string
default:"createdAt"
Campo usado na ordenação. Valores possíveis: createdAt, updatedAt, sentAt, finishedAt, status, cpf, name e workflowPresetAlias.Exemplo: createdAt
sortOrder
string
default:"desc"
Direção da ordenação: asc ou desc.Exemplo: desc
limit
integer
default:"20"
Quantidade máxima de itens por página, de 1 a 100.Exemplo: 20
offset
integer
default:"0"
Número de itens a pular na paginação.Exemplo: 0

Response

items
array
Documentos encontrados. Cada item segue a mesma estrutura de Consultar Documento.
pagination.total
integer
Total de documentos que atendem aos filtros.Exemplo: 1
pagination.limit
integer
Quantidade máxima de itens por página aplicada.Exemplo: 20
pagination.offset
integer
Número de itens ignorados na paginação.Exemplo: 0