Envelopes Category

The DocuSign API Envelope category includes the resources and methods for sending and managing envelopes and envelope data.

Envelopes are the key objects within the DocuSign eSignature system. As a result, they are complex data structures with few required fields. See the API Recipes for use case examples and their solutions.

To create and send envelopes, see the Envelopes resource.

ChunkedUploads

Chunked Uploads resource

Method Description
commit PUT /v2/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.

create POST /v2/accounts/{accountId}/chunked_uploads

Initiate a new ChunkedUpload.

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

Delete an existing ChunkedUpload.

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

Retrieves the current metadata of a ChunkedUpload.

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

Add a chunk, a chunk 'part', to an existing ChunkedUpload.

EnvelopeAttachments

Method Description
create PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments

Add one or more attachments to a DRAFT or IN-PROCESS envelope.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments

Delete one or more attachments from a DRAFT envelope.

get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Retrieves an attachment from the envelope.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments

Returns a list of attachments associated with the specified envelope

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Add an attachment to a DRAFT or IN-PROCESS envelope.

EnvelopeConsumerDisclosures

Envelope consumer disclosures

Method Description
get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.

getDefault GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure

Gets the Electronic Record and Signature Disclosure associated with the account.

EnvelopeCustomFields

Envelope custom fields

Method Description
create POST /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Updates envelope custom fields for an envelope.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Deletes envelope custom fields for draft and in-process envelopes.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Gets the custom field information for the specified envelope.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Updates envelope custom fields in an envelope.

EnvelopeDocumentFields

Envelope document fields

Method Description
create POST /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Creates custom document fields in an existing envelope document.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Deletes custom document fields from an existing envelope document.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Gets the custom document fields from an existing envelope document.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Updates existing custom document fields in an existing envelope document.

EnvelopeDocumentTabs

Envelope Document Tabs resource

Method Description
get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

Returns tabs on the document.

getByPage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs

Returns tabs on the specified page.

EnvelopeDocumentVisibility

Method Description
get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

Returns document visibility for the recipients

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

Updates document visibility for the recipients

updateList PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility

Updates document visibility for the recipients

EnvelopeDocuments

Envelope documents

Method Description
delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents

Deletes documents from a draft envelope.

get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

Gets a document from an envelope.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents

Gets a list of envelope documents.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

Adds a document to an existing draft envelope.

updateList PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents

Adds one or more documents to an existing envelope document.

EnvelopeEmailSettings

Envelope email settings

Method Description
create POST /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Adds email setting overrides to an envelope.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Deletes the email setting overrides for an envelope.

get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Gets the email setting overrides for an envelope.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Updates the email setting overrides for an envelope.

EnvelopeFormData

Method Description
get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/form_data

Returns envelope form data for an existing envelope.

EnvelopeLocks

Envelope locks

Method Description
create POST /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Lock an envelope.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Deletes an envelope lock.

get GET /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Gets envelope lock information.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Updates an envelope lock.

EnvelopeRecipientTabs

All of the tabs associated with a recipient. Each property is a list of a type of tab.

Method Description
create POST /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Adds tabs for a recipient.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Deletes the tabs associated with a recipient.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Gets the tabs information for a signer or sign-in-person recipient in an envelope.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Updates the tabs for a recipient.

EnvelopeRecipients

Envelope recipients

Method Description
create POST /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients

Adds one or more recipients to an envelope.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}

Deletes a recipient from an envelope.

deleteList DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients

Deletes recipients from an envelope.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients

Gets the status of recipients for an envelope.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients

Updates recipients in a draft envelope or corrects recipient information for an in process envelope.

EnvelopeTemplates

Envelope templates

Method Description
apply POST /v2/accounts/{accountId}/envelopes/{envelopeId}/templates

Adds templates to an envelope.

applyToDocument POST /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Adds templates to a document in an envelope.

delete DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}

Deletes a template from a document in an existing envelope.

list GET /v2/accounts/{accountId}/envelopes/{envelopeId}/templates

Get List of Templates used in an Envelope

listByDocument GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Gets the templates associated with a document in an existing envelope.

EnvelopeViews

Embedding Envelope views

Method Description
createConsole POST /v2/accounts/{accountId}/views/console

Returns a URL to the authentication view UI.

createCorrect POST /v2/accounts/{accountId}/envelopes/{envelopeId}/views/correct

Returns a URL to the envelope correction UI.

createEdit POST /v2/accounts/{accountId}/envelopes/{envelopeId}/views/edit

Returns a URL to the edit view UI.

createRecipient POST /v2/accounts/{accountId}/envelopes/{envelopeId}/views/recipient

Returns a URL to the recipient view UI.

createSender POST /v2/accounts/{accountId}/envelopes/{envelopeId}/views/sender

Returns a URL to the sender view UI.

Envelopes

Envelope creation, management

Method Description
create POST /v2/accounts/{accountId}/envelopes

Creates an envelope.

deleteDocumentPage DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}

Deletes a page from a document in an envelope.

get GET /v2/accounts/{accountId}/envelopes/{envelopeId}

Gets the status of a single envelope.

getNotificationSettings GET /v2/accounts/{accountId}/envelopes/{envelopeId}/notification

Gets envelope notification information.

getPageImage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Gets a page image from an envelope for display.

getPageImages GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages

Returns document page image(s) based on input.

getRecipientInitialsImage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

Gets the initials image for a user.

getRecipientSignature GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature

Gets signature information for a signer or sign-in-person recipient.

getRecipientSignatureImage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image

Retrieve signature image information for a signer/sign-in-person recipient.

listAuditEvents GET /v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events

Gets the envelope audit events for an envelope.

listStatus PUT /v2/accounts/{accountId}/envelopes/status

Gets the envelope status for the specified envelopes.

listStatusChanges GET /v2/accounts/{accountId}/envelopes

Gets status changes for one or more envelopes.

rotateDocumentPage PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Rotates page image from an envelope for display.

update PUT /v2/accounts/{accountId}/envelopes/{envelopeId}

Send, void, or modify a draft envelope. Purge documents from a completed envelope.

updateNotificationSettings PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/notification

Sets envelope notification (Reminders/Expirations) structure for an existing envelope.

updateRecipientInitialsImage PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

Sets the initials image for an accountless signer.

updateRecipientSignatureImage PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image

Sets the signature image for an accountless signer.

NotaryJournals

Method Description
list GET /v2/current_user/notary/journals