module:api/EnvelopesApi

Adds templates to an envelope.
Adds templates to the specified envelope.

Adds templates to a document in an envelope.
Adds templates to a document in the specified envelope.

Initiate a new ChunkedUpload.
This method initiates a new chunked upload with the first part of the content.

Returns a URL to the authentication view UI.
Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.

Returns a URL to the envelope correction UI.
Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications.

Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Updates envelope custom fields for an envelope.
Updates the envelope custom fields for draft and in-process envelopes.

Each custom field used in an envelope must have a unique name.

Creates custom document fields in an existing envelope document.
Creates custom document fields in an existing envelope document.

Get Responsive HTML Preview for a document in an envelope.
Creates a preview of the
responsive
HTML version of a specific document.
This method enables you to preview a PDF document
conversion to responsive HTML across device types prior to sending.

The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

Adds the tabs to an envelope document
Adds tabs to the document specified by documentId in the
envelope specified by envelopeId.

In the request body, you only need to specify the tabs that your
are adding. For example, to add a text
prefill tab,
your request body might look like this:

{
  "prefillTabs": {
    "textTabs": [
      {
        "value": "a prefill text tab",
        "pageNumber": "1",
        "documentId": "1",
        "xPosition": 316,
        "yPosition": 97
      }
    ]
  }
}

Returns a URL to the edit view UI.
Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view.

Upon sending completion, the user is returned to the return URL provided by the API application.

Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Adds email setting overrides to an envelope.
Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.

Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.

Creates an envelope.
Creates an envelope.

Using this function you can:
Create an envelope and send it.
Create an envelope from an existing template and send it.

In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's status property to created instead of sent.

Sending Envelopes

Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the documentBase64 field of the document object

Recipient Types

An envelopeDefinition object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The envelopeDefinition object's recipients field is an EnvelopeRecipients resource object. It includes arrays of the seven types of recipients defined by DocuSign:

Additional information about the different types of recipients is available from the EnvelopeRecipients resource page and from the Developer Center

Tabs

Tabs (also referred to as tags and as fields in the web sending user interface), can be defined in the envelopeDefinition, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below).

Defining tabs: the inPersonSigner, and signer recipient objects include a tabs field. It is an EnvelopeTabs resource object. It includes arrays of the 24 different tab types available. See the EnvelopeTabs resource for more information.

Using Templates

Envelopes use specific people or groups as recipients. Templates can specify a role, eg account_manager. When a template is used in an envelope, the roles must be replaced with specific people or groups.

When you create an envelope using a templateId, the different recipient type objects within the EnvelopeRecipients object are used to assign recipients to the template's roles via the roleName property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template.

Message Lock

When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field messageLock is used to lock the email subject and message.

If an email subject or message is entered before adding or applying a template with messageLock true, the email subject and message is overwritten with the locked email subject and message from the template.

Envelope Status

The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently.

When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message.

See the Webhook recipe for examples and live demos of using webhooks.

Webhook Options

The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client.

eventNotification Webhooks

The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access.

Connect Webhooks

Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc.

Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs.

Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information.

Composite Templates

The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more.

Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents.
The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the compositeTemplateId to which the document should be added. If compositeTemplateId is not specified in the content-disposition, the document is applied based on the documentId only. If no document object is specified, the composite template inherits the first document.
Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value.
Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value.
Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value.

PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set transformPdfFields to "true" for the document. See the Transform PDF Fields section for more information about process.
PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value.

Compositing the definitions

Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied:
Templates are overlaid in the order of their Sequence value.
If Document is not passed into the Composite Template's document field, the first template's document (based on the template's Sequence value) is used.
Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing.

For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified.
Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order.
If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput.
Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents.

For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations.
roleName and tabLabel matching is case sensitive.
The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients.
You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "*" and then the system matches tabs that start with the label.
If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.)

Including the Document Content for Composite Templates

Document content can be supplied inline, using the documentBase64 or can be included in a multi-part HTTP message.
If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the compositeTemplateId to which the document should be added. Using the compositeTemplateId sets which documents are associated with particular composite templates. An example of this usage is:

   --5cd3320a-5aac-4453-b3a4-cbb52a4cba5d
   Content-Type: application/pdf
   Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1"
   Content-Transfer-Encoding: base64

PDF Form Field Transformation

Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text

Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data.

When transforming a PDF Form Digital Signature Field, the following rules are used:

Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab

When transforming PDF Form Text Fields, the following rules are used:

Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab.

PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed.

PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned.

Template Email Subject Merge Fields

This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template.

The merge fields, based on the recipient's roleName, are added to the emailSubject when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.

Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient.

If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject.
To add a recipient's name in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template:

[[_UserName]]

Example:

"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",
To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template:

[[_Email]]

Example:

"emailSubject":"[[Signer 1_Email]], Please sign this NDA",

In both cases the is the recipient's roleName in the template.

For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[_UserName]] or [[_Email]] is shown in the email subject.

Branding an envelope

The following rules are used to determine the brandId used in an envelope:
If a brandId is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope.
If more than one template is used in an envelope and more than one brandId is specified, the first brandId specified is used throughout the envelope.
In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used.
For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope.

BCC Email address feature

The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type.

Merge Recipient Roles for Draft Envelopes

When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope.

To prevent this, the query parameter merge_roles_on_draft should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients.

Note: DocuSign recommends that the merge_roles_on_draft query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.

Posts a list of comments for authorized user

Provides a URL to start a recipient view of the Envelope UI
This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.

For more information, see Preview and Send.

Provides a URL to start a shared recipient view of the Envelope UI
Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.

Due to screen space issues,
do not use an <iframe> for embedded operations on mobile devices.
For iOS devices, DocuSign recommends using a WebView.

Revoking the URL

You can revoke this URL by making
a DELETE HTTP request to the URL
with no request body.

Related topics

• Embedded signing and sending
• How to send an envelope via your app
• How to embed the DocuSign UI in your app

Add envelope transfer rules to an account.
This method creates an envelope transfer rule.

When you create an envelope transfer rule, you specify the following properties:

• eventType
• fromGroups
• toUser
• toFolder
• carbonCopyOriginalOwner
• enabled
  Note:* Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

Creates and adds a new workflow step definition for an envelope's workflow

Submits a batch of historical envelopes for republish to an adhoc config.

Lock an envelope.
Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope.

Note: Users must have envelope locking capability enabled to use this function (userSetting canLockEnvelopes must be set to true for the user).

Adds one or more recipients to an envelope.
Adds one or more recipients to an envelope.

For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional resend_envelope query string is set to true.

Provides a link to access the Identity manual review related to a recipient.
This method returns the URL of the page that allows a sender to manually review the ID of a recipient.

Returns a link to access to the identity events stored in the proof service related to this recipient.

Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.

Returns a URL to the recipient view UI.
Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent.

Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the securityDomain and authenticationMethod properties used to verify the user identity.

Get Responsive HTML Preview for all documents in an envelope.
Creates a preview of the
responsive,
HTML versions of all of the documents in an
envelope. This method enables you to preview the
PDF document conversions to responsive HTML across
device types prior to sending.

The request body is a documentHtmlDefinition
object, which holds the responsive signing
parameters that define how to generate the HTML
version of the documents.

Returns a URL to the sender view UI.
Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view.

Upon sending completion, the user is returned to the return URL provided by the API application.

Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.

Adds tabs for a recipient.
Adds one or more tabs for a recipient.

Creates and adds a new workflow step definition for a template's workflow

Delete one or more attachments from a DRAFT envelope.
Deletes one or more attachments from a draft envelope.

Delete an existing ChunkedUpload.
Deletes a chunked upload that has been committed but not yet consumed.

This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:

• Chunked uploads that have been consumed by use in another API call.
• Expired chunked uploads.
  Note:* If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.

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

Deletes custom document fields from an existing envelope document.
Deletes custom document fields from an existing envelope document.

Deletes a page from a document in an envelope.
Deletes a page from a document in an envelope based on the page number.

Deletes documents from a draft envelope.
Deletes one or more documents from an existing draft envelope.

Deletes tabs from an envelope document
Deletes tabs from the document specified by documentId in the
envelope specified by envelopeId.

Deletes the email setting overrides for an envelope.
Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.

Revokes the correction view URL to the Envelope UI
Revokes the correction view URL to the Envelope UI.

Deletes the delayed routing rules for the specified envelope workflow step.

Deletes the scheduled sending rules for the envelope's workflow.

Delete envelope transfer rules for an account.
This method deletes an envelope transfer rule.
Note:* Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

Delete the workflow definition for an envelope.
Deletes the specified envelope's workflow definition if it has one.

Deletes the envelope workflow step definition for an envelope's workflow by step id.

Deletes an envelope lock.
Deletes the lock from the specified envelope. The X-DocuSign-Edit header must be included in the request.

Deletes a recipient from an envelope.
Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.

Deletes recipients from an envelope.
Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.

If the envelope is In Process, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.

Deletes the tabs associated with a recipient.
Deletes one or more tabs associated with a recipient in a draft envelope.

Deletes the delayed routing rules for the specified template workflow step.

Deletes the scheduled sending rules for the template's workflow.

Deletes a template from a document in an existing envelope.
Deletes the specified template from a document in an existing envelope.

Delete the workflow definition for a template.
Deletes the specified template's workflow definition if it has one.

Deletes the workflow step definition for an template's workflow by step id.

Retrieves an attachment from the envelope.
Retrieves an attachment from an envelope.

Returns a list of attachments associated with the specified envelope
Returns a list of attachments associated with a specified envelope

Retrieves the current metadata of a ChunkedUpload.
Returns the details (but not the content) about a chunked upload.
Note:* You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.

Gets comment transcript for envelope and user
Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.

The response body of this method is the PDF file as a byte
stream.
Note:* Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.

Gets the Electronic Record and Signature Disclosure associated with the account.
Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Gets a document from an envelope.
Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.

You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.

To retrieve the combined content replace the {documentId} parameter in the endpoint with combined.
/accounts/{accountId}/envelopes/{envelopeId}/documents/combined

Gets a page image from an envelope for display.
Retrieves a page image for display from the specified envelope.

Returns tabs on the document.
Returns the tabs on the document specified by documentId in the
envelope specified by envelopeId.

Gets the email setting overrides for an envelope.
Retrieves the email override settings for the specified envelope.

Gets the status of a envelope.
Retrieves the overall status for the specified envelope.

Returns the delayed routing rules for an envelope's workflow step definition.

Returns formfields for an envelope

Get the Original HTML Definition used to generate the Responsive HTML for a given document.

Get the Original HTML Definition used to generate the Responsive HTML for the envelope.

Returns the scheduled sending rules for an envelope's workflow definition.

Returns a list of envelope transfer rules in the specified account.
This method retrieves a list of envelope transfer rules associated with an account.
Note:* Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

Returns the workflow definition for an envelope.
Returns an envelope's workflow definition if the envelope specified by envelopeId has one.

Returns the workflow step definition for an envelope by step id.

Returns envelope form data for an existing envelope.
This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.
Note:* To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account.

Related topics

• How to get envelope tab values

Gets envelope lock information.
Retrieves general information about the envelope lock.

If the call is made by the locked by user and the request has the same integrator key as original, then the X-DocuSign-Edit header and additional lock information is included in the response. This allows users to recover a lost editing session token and the X-DocuSign-Edit header.

Gets envelope notification information.
Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

Returns document page image(s) based on input.
Returns images of the pages in a document for display based on the parameters that you specify.

Returns tabs on the specified page.
Returns the tabs from the page specified by pageNumber of the document specified by documentId in the
envelope specified by envelopeId.

Returns document visibility for the recipients
This method returns information about document visibility for a recipient.

Gets the initials image for a user.
Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account.

The signatureIdOrName paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint.

For example: "Bob Smith" to "Bob%20Smith"

Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.

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

Retrieve signature image information for a signer/sign-in-person recipient.
Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

The signatureIdOrName parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint.

For example: "Bob Smith" to "Bob%20Smith"

Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Get encrypted tabs for envelope.

Returns the delayed routing rules for a template's workflow step definition.

Returns document visibility for the recipients
This method returns information about document visibility for a template recipient.

Returns the scheduled sending rules for a template's workflow definition.

Returns the workflow definition for a template.
Returns template's workflow definition if the template specified by templateId has one.

Returns the workflow step definition for a template by step id.

Gets the envelope audit events for an envelope.
Gets the envelope audit events for the specified envelope.

Gets the custom field information for the specified envelope.
Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.

There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.

Gets the custom document fields from an existing envelope document.
Retrieves the custom document field information from an existing envelope document.

Gets a list of envelope documents.
Retrieves a list of documents associated with the specified envelope.

Gets the status of recipients for an envelope.
Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list.

The currentRoutingOrder property of the response contains the routingOrder value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.

Gets the envelope status for the specified envelopes.
Retrieves the envelope status for the specified envelopes.

Gets status changes for one or more envelopes.
Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response.

Important: Unless you are requesting the status for specific envelopes (using the envelopeIds or transactionIds properties), you must add a set the from_date property in the request.

Getting envelope status using transactionIds is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned.

Request Envelope Status Notes

The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (from_to_status) set to Delivered — the response set might contain envelopes that were created during that time period, but not delivered during the time period.

To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned.

For example, a request with a status qualifier (from_to_status) of Delivered and a status of "Created,Sent", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of Created or Sent, and since an envelope that has been delivered can never have a status of Created or Sent, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list.

Client applications should check that the statuses they are requesting make sense for a given status qualifier.

Gets the tabs information for a signer or sign-in-person recipient in an envelope.
Retrieves information about the tabs associated with a recipient in a draft envelope.

Get List of Templates used in an Envelope
This returns a list of the server-side templates, their name and ID, used in an envelope.

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

Add an attachment to a DRAFT or IN-PROCESS envelope.
Adds an attachment to a draft or in-process envelope.

Add one or more attachments to a DRAFT or IN-PROCESS envelope.
Adds one or more attachments to a draft or in-process envelope.

Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them.

For a list of supported file formats, see Supported File Formats.

Rotates page image from an envelope for display.
Rotates page image from an envelope for display. The page image can be rotated to the left or right.

Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
The Put Envelopes endpoint provides the following functionality:
Sends the specified single draft envelope.
Add {"status":"sent"} to the request body to send the envelope.
Voids the specified in-process envelope.
Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope.
Replaces the current email subject and message for a draft envelope.
Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message.
Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.
Add {"purgeState":"purge type"} to the request body.
Additional information on purging documents*

The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of).

Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period.

Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents.

Note: Setting a Document Retention policy is the same as setting a schedule for purging documents.

When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system.

If purgeState="documents_queued" is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If purgeState= "documents_and_metadata_queued" is used in the request, then the documents, attachments, and tabs are deleted.

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.

If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.
Note:* After you commit a chunked upload, it no longer accepts additional parts.

Add a chunk, a chunk 'part', to an existing ChunkedUpload.
Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part,
use this method to upload subsequent parts.

For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the sequence value 0. As a result, DocuSign recommends that you start with a sequence value of 1 when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.

Example:

PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3

Note:* You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.

Updates envelope custom fields in an envelope.
Updates the envelope custom fields in draft and in-process envelopes.

Each custom field used in an envelope must have a unique name.

Adds a document to an existing draft envelope.
Adds a document to an existing draft envelope.

Updates existing custom document fields in an existing envelope document.
Updates existing custom document fields in an existing envelope document.

Adds one or more documents to an existing envelope document.
Adds one or more documents to an existing envelope document.

Updates the tabs for an envelope document
Updates tabs in the document specified by documentId in the
envelope specified by envelopeId.

Updates the email setting overrides for an envelope.
Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.

This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.

Updates the delayed routing rules for an envelope's workflow step definition.

Updates formfields for an envelope

Updates the scheduled sending rules for an envelope's workflow definition.

Update an envelope transfer rule for an account.
This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.

You must include the envelopeTransferRuleId both as a query parameter, and in the request body.
Note:* You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.