Pular para o conteúdo
  • Não há sugestões porque o campo de pesquisa está em branco.

Listar Anexos Vinculados a um Documento Principal (API)

Este endpoint da API D4Sign permite que você liste todos os documentos anexados a um documento principal. É ideal para verificar os arquivos complementares de um contrato ou processo, por exemplo.

🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Exemplo de URL completa para requisição: https://secure.d4sign.com.br/api/v1/documents/{uuid-main-document}/listslaves?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Header

O cabeçalho da sua requisição deve indicar que você aceita application/json como formato de resposta, além de seus tokens de autenticação.

JSON
{
    "Accept": "application/json",
    "tokenAPI": "{SEU-TOKEN-API}",
    "cryptKey": "{SUA-CRYPT-KEY}"
}

Body

Para este endpoint, o corpo da requisição não é necessário. Todos os parâmetros são enviados via URL ou Header.

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um array de objetos JSON. O primeiro objeto contém informações sobre a paginação, e os subsequentes representam cada anexo encontrado, com seus detalhes.

JSON
[
    {
        "total_documents": 3,
        "total_in_this_page": 3,
        "current_page": 1,
        "total_pages": 1
    },
    {
        "uuidDoc": "7ba92714-c163-4bc7-84f0-e638601f6e19",
        "nameDoc": "Anexo 3 - Planta.pdf",
        "type": "application/pdf",
        "size": "778748",
        "pages": null
    },
    {
        "uuidDoc": "aea20243-475a-43fc-8ba5-c02f6eec76fc",
        "nameDoc": "Anexo 1- IPTU.pdf",
        "type": "application/pdf",
        "size": "60795",
        "pages": "4"
    },
    {
        "uuidDoc": "51a4df32-a637-4c12-adf1-c8e3ecfc5aef",
        "nameDoc": "Anexo 2 - Financiamento.pdf",
        "type": "application/pdf",
        "size": "434198",
        "pages": "3"
    }
]

Detalhes dos Campos da Resposta:

Campo Tipo Descrição
total_documents Número O número total de anexos vinculados ao documento principal.
total_in_this_page Número O número de anexos retornados na página atual da requisição.
current_page Número O número da página atual dos resultados.
total_pages Número O número total de páginas de resultados disponíveis.
uuidDoc String O UUID (identificador único) do documento anexo.
nameDoc String O nome do documento anexo.
type String O tipo MIME do arquivo do anexo (ex: application/pdf).
size String O tamanho do arquivo do anexo em bytes.
pages String / Nulo O número de páginas do documento anexo, se aplicável. Retorna null para outros tipos de arquivo.