API
Listar Documentos
Liste os documentos enviados para análise, com filtros e paginação
GET
Listar Documentos
Query Params
CPF do titular, com ou sem máscara.Exemplo:
12345678909Nome do titular. A busca é parcial e não diferencia maiúsculas de minúsculas.Exemplo:
JOAOAlias do preset de workflow, em correspondência exata.Exemplo:
documentoscopia_auto_base_face_15minStatus atual do documento. Valores possíveis:
PENDING, MERGING, UPLOADING, SENDING, SENT, PROCESSING, COMPLETED, ERROR, FAILED e TIMEOUT.Exemplo: COMPLETEDStatus consolidado do documento. Valores possíveis:
processing, error, approved, rejected e pending.Exemplo: approvedInício do intervalo de criação, em ISO 8601.Exemplo:
2026-01-01T00:00:00.000ZFim do intervalo de criação, em ISO 8601.Exemplo:
2026-12-31T23:59:59.999ZCampo usado na ordenação. Valores possíveis:
createdAt, updatedAt, sentAt, finishedAt, status, cpf, name e workflowPresetAlias.Exemplo: createdAtDireção da ordenação:
asc ou desc.Exemplo: descQuantidade máxima de itens por página, de 1 a 100.Exemplo:
20Número de itens a pular na paginação.Exemplo:
0Response
Documentos encontrados. Cada item segue a mesma estrutura de Consultar Documento.
Total de documentos que atendem aos filtros.Exemplo:
1Quantidade máxima de itens por página aplicada.Exemplo:
20Número de itens ignorados na paginação.Exemplo:
0Listar Documentos