Download document

This endpoint allows API users to download a document as a PDF file or a ZIP archive.

The type query parameter sets the format:

Not set: the original PDF, as uploaded.
collapsed: a PDF with the filled fields.
zip: a ZIP archive with the PDF and any attachments on the document.
email: a ZIP archive with the PDF that has the document ID on each page, attachments, and the history file if history is requested.

Notes

The file is returned in the response body with a Content-Disposition: attachment header that carries the file name.
with_history=1 takes effect only together with type. Without type, the original PDF is returned.

get/document/{document_id}/download

Request

Base URL
https://api.signnow.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/signnow/apis/signnow-api/docs/document/:document_id/download/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ID of the document.

Query parameters

Format of the download. Allowed values: collapsed, zip, email. If not set, the original PDF is returned.

Set to 1 to include the document history in the download. Takes effect only together with type.

Response

The document file. The content type depends on type: application/pdf when type is not set or is collapsed, application/zip when type is zip or email.

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.