Listar Documentos por Fase (API)

🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição. Exemplo: https://secure.d4sign.com.br/api/v1/documents/{ID-FASE}/status?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Listar todos os documentos de uma fase (API)

Este endpoint retornará todos os documentos que estiverem na fase informada.

GET /documents/{ID-FASE}/status

Parâmetros de Requisição (URL)

Parâmetro	Descrição
`ID-FASE`	(obrigatório) O ID da fase que você quer listar. Veja as opções abaixo: `1` - Processando <br> `2` - Aguardando Signatários <br> `3` - Aguardando Assinaturas <br> `4` - Finalizado <br> `5` - Arquivado <br> `6` - Cancelado <br> `7` - Editando
`pg`	Parâmetro de paginação. Use-o para navegar entre as páginas de resultados.

📘 Paginação: O resultado virá com até 500 documentos por página. Pra paginar, é só usar o parâmetro pg na URL. Exemplo:

https://secure.d4sign.com.br/api/v1/documents/{ID-FASE}/status?tokenAPI={SEU-TOKEN}&cryptKey={CRYPT-KEY}&pg=2 O primeiro bloco da resposta exibirá o total de páginas disponíveis.

Header

JSON

{
    "Content-Type": "application/json"
}

Resposta

A resposta será um array de objetos, onde cada objeto representa um documento e contém suas principais informações:

JSON

[
    {
        "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
        "nameDoc": "teste.pdf",
        "type": "application/pdf",
        "size": "118990",
        "pages": "6",
        "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
        "safeName": "Atendimento",
        "statusId": "3",
        "statusName": "Aguardando Assinaturas",
        "statusComment": "Comentário sobre cancelamento",
        "whoCanceled": "E-mail de quem cancelou o documento"
    },
    {
        // ... Outros documentos na mesma fase
    }
]

Listar Documentos por Fase (API)

Esta seção da API D4Sign permite que você filtre e visualize todos os documentos que estão em uma fase específica do fluxo de trabalho (como "Aguardando Assinaturas" ou "Finalizado"). Isso é super útil para acompanhar o progresso dos seus documentos.

Listar todos os documentos de uma fase (API)