Skip to navigation
Docusign eSignature REST APIEnvelopes

ChunkedUploads Resource

View as Markdown

A chunked upload is a temporary file that you upload in parts and stage at Docusign, then refer to as the content for other API calls. For example, you might use it for document content when assembling an envelope or template.

A chunked upload is linked to the Docusign account member who initiated the API call. This user is the only user who is able to reference the chunked upload.

A ChunkedUpload is intended to be an area for briefly staging data for use with other Docusign API calls. The ChunkedUpload API endpoints do not provide an action to download the ChunkedUpload’s content.

The typical flow for using a chunked upload involves the following steps:

  1. Initiate the chunked upload with content representing part 0.

  2. Add more parts to the chunked upload until you have transmitted the entirety of the content.

  3. Commit the chunked upload, preparing it for use with other API calls.

  4. Assemble a Docusign envelope with a document that includes a reference to the chunked upload as the content.

  5. Continue with envelope-related processes.

Note: You must fully upload and use a chunked upload within 20 minutes of initializing it.

After the chunked upload has been correctly referenced within another API call, it becomes unavailable for any further use and is promptly removed from the system.

Chunked uploads have the following limits, which are configured per Docusign environment, account, or integrator:

  • The maximum number of all of a member’s unexpired, unconsumed ChunkedUploads. The default value is 64.
  • The maximum total size of all of a member’s unexpired, unconsumed ChunkedUploads. The default value is 1 GB.
  • The amount of time that a chunked upload is active after you initialize it. The default value is 20 minutes.

Methods supported

MethodDescription
commitPUT /restapi/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
Commit a chunked upload.
createPOST /restapi/v2.1/accounts/{accountId}/chunked_uploads
Initiate a new chunked upload.
deleteDEL /restapi/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
Deletes a chunked upload.
getGET /restapi/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}
Retrieves metadata about a chunked upload.
updatePUT /restapi/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}
Add a chunk to an existing chunked upload.

ChunkedUploads properties

PropertyTypeDescription
checksumstringA 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.
chunkedUploadIdstringThe ID of the chunked upload.
chunkedUploadPartsarrayA list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.
chunkedUploadUristringThe URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests.
committedstringWhen true, the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests.
expirationDateTimestringThe UTC time at which the chunked upload expires and is no longer addressable.

Note: The length of time before expiration is configurable, and begins when you initiate the chunked upload. You must fully upload and use a chunked upload within this time. The default value for this duration is 20 minutes.
maxChunkedUploadPartsstringThe maximum number of parts allowed for a chunked upload. This value is configurable per Docusign environment, account, or integrator. The default value is 128. The maximum possible value is 256.
maxTotalSizestringThe maximum total size allowed for a chunked upload. This value is configured per Docusign environment, account, or integrator. The default value is 50 MB.
totalSizestringThe total size of the parts of the chunked upload.

Note: When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.