Listar Documentos de um Cofre ou Pasta (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?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Listar todos os documentos de um cofre ou pasta (API)

Este endpoint retornará todos os documentos que estiverem associados ao cofre e, se informado, à pasta especificada.

GET /documents/{UUID-SAFE}/safe

Para filtrar os documentos por uma pasta específica, utilize o endpoint:

GET /documents/{UUID-SAFE}/safe/{UUID-FOLDER}

Parâmetros de Requisição

Parâmetro	Descrição
`UUID-SAFE`	(obrigatório) UUID do COFRE que deverá ser listado.
`UUID-FOLDER`	UUID da PASTA (opcional).
`pg`	Parâmetro de paginação. Utilize para navegar entre as páginas de resultados.

📘 Paginação:

O resultado será de 500 documentos por página. Utilize o parâmetro pg na URL para paginar o resultado.

Exemplo: https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2

O primeiro bloco do resultado exibirá o total de páginas disponíveis.

Requisição - Envio 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
    }
]

Listar Documentos de um Cofre ou Pasta (API)

Esta seção da API D4Sign permite que você liste todos os documentos contidos em um cofre específico ou, opcionalmente, em uma pasta dentro desse cofre.

Listar todos os documentos de um cofre ou pasta (API)