Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Download Envelope Documents Archive

This document contains details for the /api/v1/envelope/{envelopeUuid}/zip endpoint, including query parameters and how ZIP contents vary by document state.

Method

Method
GET

URL

/api/v1/envelope/{envelopeUuid}/zip

Authorization

Bearer {token}

Content-Type

application/json

Mailbox UUID header

{uuid}

Use this endpoint to download the full envelope archive or the archive of one document. The response body is a ZIP file.

How it works

Request the full archive when you need all envelope files. Add query parameters when you need one document only or want to exclude generated files.

Archive contents depend on the document state. Completed documents return more files than incomplete ones.

Path parameters

  • envelopeUuid — envelope UUID

Query parameters

  • documentId — download the archive for one document only

  • excludeFiles — exclude generated files from the ZIP

  • zipStructureName — use a pre-saved ZIP structure from the template

Use these excludeFiles mask values:

  • c — certificates

  • p — printable versions

  • a — audit trail

Combine excludeFiles values in one mask. For example, cp excludes certificates and printable versions.

Request examples

Download the full envelope archive

Download one document archive

Download an archive without certificates and printable versions

ZIP content by document state

  1. If the document is incomplete, the ZIP usually contains only the audit trail.

  2. If the document is complete, the ZIP contains original documents, printable versions, and processing or signing certificates.

  3. If the document is complete and already signed, the ZIP also contains the produced signatures.

ZIP content changes with the processing flow step and document state. The same request can return different files at different stages of envelope processing.

Related topics

PreviousUpload Attachment/External Documents MethodNextAudit Trail Record

Last updated

Was this helpful?