{"api":"esign_rest","category":"reference"}

ChunkedUploads Resource

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 10.
  • 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.
MethodDescription
create
POST /v2.1/accounts/{accountId}/chunked_uploads

Initiate a new chunked upload.

get
GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Retrieves metadata about a chunked upload.

commit
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Commit a chunked upload.

delete
DELETE /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Deletes a chunked upload.

update
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}

Add a chunk to an existing chunked upload.

}} />