Skip to content

DocuSign: Esignature schemas (part 19)

24 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Gets a BCC email archive configuration and its history — response body — bcc Email Archive History item

FieldTypePresenceDescription and constraints
$objectRootContains details about the history of the BCC email archive configuration.
accountIdstringOptionalThe ID of the account that owns the BCC email archive configuration.
actionstringOptionalThe action taken on the BCC email archive configuration.

Examples:

- `CREATED`: The BCC email archive configuration has been created.
- `UPDATED`: The BCC email address has been activated by clicking on the activation link in the activation email message.
- `CLOSED`: The BCC email address has been marked as closed is no longer used for archiving.
emailstringOptionalThe BCC email address used to archive the emails that Docusign generates.

Example: customer_bcc@example.com
modifiedstringOptionalThe UTC DateTime when the BCC email address was last modified.
modifiedByModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Details about the user who last modified the BCC email archive configuration.
statusstringOptionalThe status of the BCC email address. Possible values are:

- `activation_sent`: An activation link has been sent to the BCC email address.
- `active`: The BCC email address is actively used for archiving.
- `closed`: The BCC email address is no longer used for archiving.

Referenced models: Gets a specific template associated with a specified account — response body — owner

Gets a Connect log entry — response body

FieldTypePresenceDescription and constraints
$objectRootContains information about a Connect log entry.
accountIdstringOptionalThe account ID associated with the envelope.
configUrlstringOptionalThe web address of the listener or retrieving service endpoint for Connect.
connectDebugLogarrayOptionalA complex element containing information about the Connect configuration, error details, date/time, description and payload.
This information is included in the response only when the `additional_info` query is set to **true.**
This additional information is only available when retrieving general logs with [ConnectEvents:get](/docs/esign-rest-api/reference/connect/connectevents/get/), but not when retrieving failure logs with [ConnectEvents:listFailures](/docs/esign-rest-api/reference/connect/connectevents/listfailures/).
connectDebugLog[]ModelEach itemExpand Gets a Connect log entry — response body — connect Debug Log item
connectIdstringOptionalThe ID of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.
createdstringOptionalThe UTC DateTime when the Connect post was created.
emailstringOptionalThe email address of the envelope sender.
envelopeIdstringOptionalThe ID of the envelope that failed to post.
errorstringOptionalThe error that caused the Connect post to fail.
failureIdstringOptionalThe failure log ID for the failure.
failureUristringOptionalThe URI for the Connect post failure.
lastTrystringOptionalThe UTC DateTime of the last attempt to post.
logIdstringOptionalThe Connect log ID for the entry.
logUristringOptionalThe URI for the Connect log entry.
retryCountstringOptionalThe number of times the Connect post has been retried.
retryUristringOptionalA URI that you can use to retry to publish the Connect post.
statusstringOptionalThe envelope status for the Connect post. Possible values are:
- `Any`
- `Voided`
- `Created`
- `Deleted`
- `Sent`
- `Delivered`
- `Signed`
- `Completed`
- `Declined`
- `TimedOut`
- `Template`
- `Processing`

For details about these statuses, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/).
subjectstringOptionalThe subject of the envelope.
userNamestringOptionalThe name of the sender of the envelope.

Referenced models: Gets a Connect log entry — response body — connect Debug Log item

Gets a Connect log entry — response body — connect Debug Log item

FieldTypePresenceDescription and constraints
$objectRoot
connectConfigstringOptionalThe name of the Connect configuration.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
eventDateTimestringOptionalThe UTC date and time of the event.
eventDescriptionstringOptionalA description of the event.
payloadstringOptionalLog output.

Referenced models: Locks a template — response body — error Details

Gets a list of all account tabs — response body

FieldTypePresenceDescription and constraints
$objectRoot
tabsarrayOptionalA list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
tabs[]ModelEach itemExpand Creates a custom tab — response body

Referenced models: Creates a custom tab — response body

Gets a list of available billing plans — response body

FieldTypePresenceDescription and constraints
$objectRootDefines a billing plans response object.
billingPlansarrayOptionalReserved for Docusign.
billingPlans[]ModelEach itemExpand Gets billing plan details — response body — billing Plan

Referenced models: Gets billing plan details — response body — billing Plan

Gets a list of brands — response body

FieldTypePresenceDescription and constraints
$objectRootThe AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.
brandsarrayOptionalA list of brands.
brands[]ModelEach itemExpand Updates an existing brand — response body
recipientBrandIdDefaultstringOptionalThe brand that envelope recipients see when a brand is not explicitly set.
senderBrandIdDefaultstringOptionalThe brand that envelope senders see when a brand is not explicitly set.

Referenced models: Updates an existing brand — response body

Gets a list of custom fields — response body

FieldTypePresenceDescription and constraints
$objectRootAn `accountCustomField` is an envelope custom field that you set at the account level.
Applying custom fields enables account administrators to group and manage envelopes.
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — text Custom Fields item

Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item

Gets a list of custom fields — response body — list Custom Fields item

FieldTypePresenceDescription and constraints
$objectRootThis object represents a list custom field from which envelope creators and senders can select custom data.
configurationTypestringOptionalIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
fieldIdstringOptionalThe ID of the custom field.
listItemsarrayOptionalAn array of strings that represents the options in a list.

Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters.
listItems[]stringEach item
namestringOptionalThe name of the custom field.
requiredstringOptionalWhen **true,** senders are required to select an option from the list before they can send the envelope.
showstringOptionalWhen **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.
valuestringOptionalThe value of the custom field. This is the value that the user who creates or sends the envelope selects from the list.

Referenced models: Locks a template — response body — error Details

Gets a list of custom fields — response body — text Custom Fields item

FieldTypePresenceDescription and constraints
$objectRootThis object represents a free text custom field where envelope creators and senders can enter custom data.
configurationTypestringOptionalIf you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
fieldIdstringOptionalThe ID of the custom field.
namestringOptionalThe name of the custom field.
requiredstringOptionalWhen **true,** senders are required to enter or select information for the field before they can send the envelope.
showstringOptionalWhen **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.
valuestringOptionalThe value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters.

Referenced models: Locks a template — response body — error Details

Gets a list of items from a cloud storage provider — response body

FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
errorDetailsModelOptionalExpand Gets a list of items from a cloud storage provider — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
idstringOptionalA unique ID for the Salesforce object.
itemsarrayOptionalIf the tab is a list, this represents the values that are possible for the tab.
items[]ModelEach itemExpand Gets a list of items from a cloud storage provider — response body — items item
namestringOptional
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
skyDriveSkipTokenstringOptional
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Gets a list of items from a cloud storage provider — response body — error Details, Gets a list of items from a cloud storage provider — response body — items item

Gets a list of items from a cloud storage provider — response body — error Details

FieldTypePresenceDescription and constraints
$objectRoot
authenticationUrlstringOptionalReserved for Docusign.
errorCodestringOptionalA code associated with the error condition.
messagestringOptional

Gets a list of items from a cloud storage provider — response body — items item

FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a file or folder in cloud storage.
datestringOptionalThe UTC date and time that the file or folder was last modified.
hasCompositeTemplatestringOptional
idstringOptionalThe storage provider's ID for the file or folder.
imgstringOptionalThe file extension for a file.

**Note:** If the item is a folder, this value is null.
namestringOptionalThe full name of a file.
ownerNamestringOptional
sizestringOptionalThe size of the file. The file size limit varies based on the cloud storage provider.
supportedstringOptionalWhen **true,** Docusign supports the file type for upload.
typestringOptionalThe type of cloud storage item. Valid values are:

- `file`
- `folder`
uristringOptionalThe URI for the file or folder.

Gets a list of permission profiles — response body

FieldTypePresenceDescription and constraints
$objectRootContains details about the permission profiles associated with an account.
permissionProfilesarrayOptionalA complex type containing a collection of permission profiles.
permissionProfiles[]ModelEach itemExpand Returns a permission profile for an account — response body

Referenced models: Returns a permission profile for an account — response body

Gets a list of unsupported file types — response body

FieldTypePresenceDescription and constraints
$objectRoot
fileTypesarrayOptionalA collection of file types.
fileTypes[]ModelEach itemExpand Gets a list of unsupported file types — response body — file Types item

Referenced models: Gets a list of unsupported file types — response body — file Types item

Gets a list of unsupported file types — response body — file Types item

FieldTypePresenceDescription and constraints
$objectRoot
fileExtensionstringOptional
mimeTypestringOptionalThe mime-type of a file type listed in a fileTypes collection.

Gets a list of users in a group — response body

FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
usersarrayOptionalUser management information.
users[]ModelEach itemExpand Gets a list of users in a group — response body — users item

Referenced models: Gets a list of users in a group — response body — users item

Gets a list of users in a group — response body — users item

FieldTypePresenceDescription and constraints
$objectRoot
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
emailstringOptional
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
loginStatusstringOptionalBoolean value that indicates whether the user is currently logged in or not.
sendActivationEmailstringOptionalThis field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
uristringOptionalA URI containing the user ID.
userIdstringOptionalThe ID of the user to access.

**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
userNamestringOptionalThe name of the user.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.

Referenced models: Locks a template — response body — error Details

Gets a specific template associated with a specified account — response body

FieldTypePresenceDescription and constraints
$objectRoot
accessControlListBase64stringOptionalReserved for Docusign.
allowCommentsstringOptionalWhen **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document.
allowMarkupstringOptionalWhen **true,** the Document Markup feature is enabled.

**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.
allowReassignstringOptionalWhen **true,** the recipient can redirect an envelope to a more appropriate recipient.
allowViewHistorystringOptionalWhen **true,** recipients can view the history of the envelope.
anySignerstringOptionalDeprecated. This feature has been replaced by signing groups.
asynchronousstringOptionalWhen **true,** the envelope is queued for
processing and the value of the `status` property
is set to `Processing`. Additionally, GET status
calls return `Processing` until completed.


**Note:** A `transactionId` is required for this
call to work correctly. When the envelope is
created, the status is `Processing` and an
`envelopeId` is not returned in the response. To
get the `envelopeId`, use a GET envelope query by
using the
[transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the
Connect notification.
attachmentsUristringOptionalContains a URL for retrieving the attachments that are associated with the envelope.
authoritativeCopystringOptionalWhen **true,** marks all of the documents in the envelope as authoritative copies.

**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**
authoritativeCopyDefaultstringOptionalThe default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.
If this property is not set, each document defaults to the envelope's `authoritativeCopy`.
autoMatchstringOptionalBy default, templates that have been used within
the last 60 days are included in auto-matching.

By explicitly setting `autoMatch`,
you can permanently include or exclude the template
in auto matching.

When **true** the template is included in auto-matching
regardless of when it was last used.

When **false** the template is never included in auto-matching.
autoMatchSpecifiedByUserstringOptionalWhen **true,** the template has been explicitly included in or excluded from auto-matching. The default is false.
This is a read-only property.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
brandIdstringOptionalThe ID of the brand.
brandLockstringOptionalWhen **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.
burnDefaultTabDatastringOptional
certificateUristringOptionalThe URI for retrieving certificate information.
completedDateTimestringOptionalSpecifies the date and time this item was completed.
copyRecipientDatastringOptional
createdstringOptionalThe UTC DateTime when the workspace user authorization was created.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customFieldsModelOptionalExpand Gets a list of custom fields — response body
An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters.
customFieldsUristringOptionalThe URI for retrieving custom fields.
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
deletedDateTimestringOptionalReserved for Docusign.
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
descriptionstringOptionalA sender-defined description of the line item.
disableResponsiveDocumentstringOptionalWhen **true,** responsive documents are disabled for the envelope.
documentBase64stringOptionalThe document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
documentsarrayOptionalA complex element that contains details about the documents associated with the envelope.
documents[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — documents item
documentsCombinedUristringOptionalThe URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsUristringOptionalThe URI for retrieving all of the documents associated with the envelope as separate files.
emailBlurbstringOptionalThis is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients.
emailSettingsModelOptionalExpand Adds email setting overrides to an envelope — response body
A complex type that contains email settings.
emailSubjectstringOptionalThe subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).

**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.
enableWetSignstringOptionalWhen **true,** the signer is allowed to print the document and sign it on paper.
enforceSignerVisibilitystringOptionalWhen **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.

**Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan.

[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/
[sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending
[fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html
[support]: https://support.docusign.com/en/contactSupport#
envelopeAttachmentsarrayOptionalAn array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopeAttachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body
envelopeCustomMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Custom Metadata
envelopeDocumentsarrayOptionalAn array containing information about the documents that are included in the envelope.
envelopeDocuments[]ModelEach itemExpand Updates a template document — response body
envelopeIdstringOptionalThe envelope ID of an envelope that you want to use as
the basis for the template. The state of the envelope
can be `draft`, `sent`, or `completed`.

envelopeIdStampingstringOptionalWhen **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.
After a document or attachment is stamped with an Envelope ID,
the ID is seen by all recipients
and becomes a permanent part of the document
and cannot be removed.
envelopeLocationstringOptionalReserved for Docusign.
envelopeMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Metadata
Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and Docusign eNotary service.
envelopeUristringOptionalThe URI for retrieving the envelope or envelopes.
expireAfterstringOptionalNot used. Use the
[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)
property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead.
expireDateTimestringOptionalNot used. Use the
[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)
property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead.
expireEnabledstringOptionalNot used. Use the
[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)
property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead.
externalEnvelopeIdstringOptionalMay contain an external identifier for the envelope.
favoritedByMestringOptional
folderIdstringOptionalThe ID of the folder.
folderIdsarrayOptional
folderIds[]stringEach item
folderNamestringOptional
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
hasCommentsstringOptionalWhen **true,** indicates that users have added comments to the envelope.
hasFormDataChangedstringOptionalWhen **true,** indicates that the data collected through form fields on a document has changed.
hasWavFilestringOptionalWhen **true,** indicates that a .wav file used for voice authentication is included in the envelope.
holderstringOptionalReserved for Docusign.
initialSentDateTimestringOptionalThe date and time the envelope was initially sent.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isAceGenTemplatestringOptional
isDocGenTemplatestringOptional
isDynamicEnvelopestringOptionalWhen **true,** indicates that the envelope is a dynamic envelope.
isSignatureProviderEnvelopestringOptionalWhen **true,** indicates that the envelope is a signature-provided envelope.
isTicketRelatedEnvelopestringOptional
lastModifiedstringOptionalThe UTC date and time that the comment was last updated.

**Note:** This can only be done by the creator.
lastModifiedByModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
lastUsedstringOptional
locationstringOptionalReserved for Docusign.
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
messageLockstringOptionalWhen **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.

Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.

However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
namestringOptional
newPasswordstringOptionalThe user's new password.
notificationModelOptionalExpand Gets envelope notification information — response body
notificationUristringOptionalThe URI for retrieving notifications.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the template.
pageCountstringOptionalAn integer value specifying the number of document pages in the template.
passwordstringOptionalThe user's password.

This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).

This property is not returned by `GET` requests and cannot be updated via `PUT` requests.
passwordProtectedstringOptional
powerFormModelOptionalExpand Creates a new Power Form — response body
Information about any PowerForms that are included in the envelope.
powerFormsarrayOptionalAn array of PowerForm objects.
powerForms[]ModelEach itemExpand Creates a new Power Form — response body
purgeCompletedDatestringOptionalThe date that a purge was completed.
purgeRequestDatestringOptionalThe date that a purge was requested.
purgeStatestringOptionalShows the current purge state for the envelope. Valid values:

- `unpurged`: There has been no successful request to purge documents.
- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.
- `documents_dequeued`: The envelope documents have been taken out of the purge queue.
- `documents_purged`: The envelope documents have been successfully purged.
- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.
- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.
- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.
- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.

**Related topics**

- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)
- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)

recipientsModelOptionalExpand Deletes recipients from an envelope — response body
An array of recipient objects that provides details about the recipients of the envelope.
recipientsLockstringOptionalWhen **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the sender of the envelope.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
sharedstringOptionalWhen **true,** indicates the template is shared with the **Everyone** group,
which includes all users on the account.

When **false,** the template is shared only with the groups you specify.
signerCanSignOnMobilestringOptionalWhen **true,** recipients can sign on a mobile device.

**Note:** Only Admin users can change this setting.
signingLocationstringOptionalSpecifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.
statusstringOptionalIndicates the envelope status. Valid values are:

* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.
* `created`: The envelope is created as a draft. It can be modified and sent later.
* `declined`: The envelope has been declined by the recipients.
* `delivered`: The envelope has been delivered to the recipients.
* `sent`: The envelope will be sent to the recipients after the envelope is created.
* `signed`: The envelope has been signed by the recipients.
* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.
statusChangedDateTimestringOptionalThe data and time that the status changed.
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templatesUristringOptionalThe URI for retrieving the templates.
transactionIdstringOptionalUsed to identify an envelope.

The ID is a sender-generated value and is valid in the Docusign system for 7 days.
It is recommended that a transaction ID is used for offline
signing to ensure that an envelope is not sent multiple times.
The `transactionId` property can be used determine an envelope's
status (i.e. was it created or not) in cases where the internet c
onnection was lost before the envelope status was returned.
uSigStatestringOptional
uristringOptionalA URI containing the user ID.
useDisclosurestringOptionalWhen **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients.

If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
voidedDateTimestringOptionalThe date and time the envelope or template was voided.
voidedReasonstringOptionalThe reason the envelope or template was voided.

**Note:** The string is truncated to the first 200 characters.
workflowModelOptionalExpand Returns the workflow definition for a template — response body

Referenced models: Gets a list of custom fields — response body, Locks an envelope — response body, Deletes recipients from an envelope — response body, Updates an envelope attachment in a draft or in-process envelope — request body — body, Gets a specific template associated with a specified account — response body — documents item, Adds email setting overrides to an envelope — response body, Gets the status of a single envelope — response body — envelope Custom Metadata, Updates a template document — response body, Gets the status of a single envelope — response body — envelope Metadata, Gets the list of templates — response body — folders item, Gets envelope notification information — response body, Creates a new Power Form — response body, Gets a specific template associated with a specified account — response body — owner, Returns the workflow definition for a template — response body

Gets a specific template associated with a specified account — response body — documents item

FieldTypePresenceDescription and constraints
$objectRootA document object.
applyAnchorTabsstringOptionalReserved for Docusign.
assignTabsToRecipientIdstringOptional
authoritativeCopybooleanOptionalWhen **true,** this document is considered an authoritative copy.

If this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property.

When **false,** this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property.
displaystringOptionalThis string sets the display and behavior properties of
the document during signing. Valid values:

* `modal`<br>
The document is shown as a supplement action strip
and can be viewed, downloaded, or printed in a modal window.
This is the recommended value for supplemental documents.

* `inline`<br>
The document is shown in the normal signing window.
This value is not used with supplemental documents,
but is the default value for all other documents.
docGenDocumentStatusstringOptional
docGenFormFieldsarrayOptional
docGenFormFields[]ModelEach itemExpand Updates a template document — response body — doc Gen Form Fields item
documentBase64stringOptionalThe document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
documentFieldsarrayOptionalThe array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements:

* `name`: A string that can be a maximum of 50 characters.
* `value`: A string that can be a maximum of 200 characters.

If you are using XML, the name/value pair is contained in a `nameValue` element.
documentFields[]ModelEach itemExpand Updates an existing brand — response body — colors item
documentIdstringOptionalSpecifies the document ID of this document. This value is used by tabs to determine which document they appear in.
documentTemplateIdstringOptional
encryptedWithKeyManagerstringOptionalWhen **true,** the document has been encrypted by the sender for use with the Docusign Key Manager Security Appliance.
fileExtensionstringOptionalThe file extension type of the document. Non-PDF documents are converted to PDF.

If the document is not a PDF, `fileExtension` is required.

If you try to upload a non-PDF document without a `fileExtension`, you will receive an "unable to load document" error message.
fileFormatHintstringOptional
htmlDefinitionModelOptionalExpand Gets a specific template associated with a specified account — response body — documents item html Definition
Defines how to generate the responsive-formatted HTML for the document.
See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)
in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).
includeInDownloadstringOptionalWhen **true,**
the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/).
The default value is **true.**
isDocGenDocumentstringOptional
matchBoxesarrayOptionalMatchboxes define areas in a document for document matching when you are creating envelopes.
They are only used when you upload and edit a template.

matchBoxes[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — documents item match Boxes item
namestringOptionalThe name of the document.
orderstringOptionalThe order in which to sort the results.

Valid values are:


* `asc`: Ascending order.
* `desc`: Descending order.
pagesstringOptionalThe number of pages in the document. This property is read-only.
passwordstringOptionalThe user's password.

This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).

This property is not returned by `GET` requests and cannot be updated via `PUT` requests.
pdfFormFieldOptionstringOptional
remoteUrlstringOptionalThe file ID from the cloud storage service where
the document is located. This information is
returned using
[CloudStorage: listFolders](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders/) or
[CloudStorage: list](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/list/).
signerMustAcknowledgestringOptionalSets how the signer interacts with the supplemental document.
Valid values:

* `no_interaction`<br>
No recipient action is required.

* `view`<br>
The recipient is required to view the document.

* `accept`<br>
The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.

* `view_accept`<br>
The recipient is required to view and accept the document.

signerMustAcknowledgeUseAccountDefaultbooleanOptionalWhen **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa).
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
transformPdfFieldsstringOptionalWhen **true,** PDF form field data is transformed into document tab values when the PDF form field name matches the Docusign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF.
uristringOptionalA URI containing the user ID.

Referenced models: Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, Updates a template document — response body — doc Gen Form Fields item, Gets a specific template associated with a specified account — response body — documents item html Definition, Gets a specific template associated with a specified account — response body — documents item match Boxes item, Updates an existing brand — response body — colors item

Gets a specific template associated with a specified account — response body — documents item html Definition

FieldTypePresenceDescription and constraints
$objectRootHolds the properties that define how to generate the responsive-formatted HTML for the document.
See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)
in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).
displayAnchorPrefixstringOptionalContains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
displayAnchorsarrayOptionalAn object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view.

A start anchor, end anchor, or both are required.
If the anchors are not found, the display anchor will be ignored.

For a list of the available types, see the
[`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display)
of the
[`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)
displayAnchors[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — documents item html Definition display Anchors item
displayOrderstringOptionalThe position on the page where the display section appears.
displayPageNumberstringOptionalThe number of the page on which the display section appears.
documentGuidstringOptionalThe GUID of the document.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
headerLabelstringOptionalHeader text or an HTML tag to place above the responsive HTML block.
maxScreenWidthstringOptionalIf set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead.

This setting can also be configured at the account level.
removeEmptyTagsstringOptionalHolds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
showMobileOptimizedTogglestringOptionalWhen **true** (the default), the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. When **false,** the toggle will not be displayed.

the **Mobile-Friendly** toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.
sourcestringOptionalSpecifies the type of responsive signing that will be used with the document.

If the value of this property is valid HTML,
and the [smart sections feature][] is enabled,
the HTML code is used to display the signing page:

```
source: "<html> ... <body><p>hello world</p></body></html>"
```

If the value of this property is the string `document`,
the HTML signing page is generated from the provided document.

```
source: "document"
```

**Related topics**

- [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/)
- [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)
- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)


[smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html

Referenced models: Gets a specific template associated with a specified account — response body — documents item html Definition display Anchors item

Gets a specific template associated with a specified account — response body — documents item html Definition display Anchors item

FieldTypePresenceDescription and constraints
$objectRoot
caseSensitivebooleanOptionalWhen **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content.
displaySettingsModelOptionalExpand Gets a specific template associated with a specified account — response body — documents item html Definition display Anchors item display Settings
This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays.
endAnchorstringOptionalSpecifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.

**Note:** A start anchor, an end anchor, or both are required.
removeEndAnchorbooleanOptionalWhen **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.
removeStartAnchorbooleanOptionalWhen **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.
startAnchorstringOptionalSpecifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.

**Note:** A start anchor, an end anchor, or both are required.

Referenced models: Gets a specific template associated with a specified account — response body — documents item html Definition display Anchors item display Settings

Gets a specific template associated with a specified account — response body — documents item html Definition display Anchors item display Settings

FieldTypePresenceDescription and constraints
$objectRootThis object defines how to display the HTML
between the `startAnchor` and `endAnchor`.
cellStylestringOptionalSpecifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.
collapsibleSettingsModelOptionalExpand Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings collapsible Settings
This object defines the appearance and function of a collapsible section or item.
displaystringOptionalSets the display and behavior properties. Possible values are:

- `inline`:
Leaves the HTML where it is in the document.
This property lets you add a label or present on a separate page.

- `collapsible`:
The HTML in this section may be expanded or collapsed.
Initially this section is expanded.

- `collapsed`:
The HTML in this section may be expanded or collapsed.
Initially this section is collapsed.

- `continue_button`:
Creates a stop point in the document to draw the reader's
attention before proceeding to the next section.

- `responsive_table`:
Turns this section into a responsive table.
Note that this is only used on HTML tables that fall within the anchor start and end positions.

- `responsive_table_single_column`:
Turns this section into a responsive single-column table.
Note this is only used on HTML tables that fall within the anchor start and end positions.
The table will be converted to one single column where each current column will become a row, then stacked.

- `print_only`:
Do not show this portion of the HTML in the responsive signing view.


displayLabelstringOptionalThe label to add to this display section in the signing page.
displayOrderJSONOptional
displayOrder (anyOf 1)integerAlternativeThe position on the page where the display section appears.
Format: int32
displayOrder (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
displayPageNumberJSONOptional
displayPageNumber (anyOf 1)integerAlternativeThe number of the page on which the display section appears.
Format: int32
displayPageNumber (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hideLabelWhenOpenedbooleanOptionalWhen **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.
inlineOuterStylestringOptionalSpecifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.
labelWhenOpenedstringOptionalThe label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.
preLabelstringOptionalEnables you to add descriptive text that appears before a collapsed section or continue button.
scrollToTopWhenOpenedbooleanOptionalWhen **true** and the section is expanded,
the position of the section-close control
scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.
tableStylestringOptionalSpecifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.

Referenced models: Creates a preview of the responsive version of a document — request body — body display Anchors item display Settings collapsible Settings

Gets a specific template associated with a specified account — response body — documents item match Boxes item

FieldTypePresenceDescription and constraints
$objectRoot
heightstringOptionalThe height of the tab in pixels.
Must be an integer.
pageNumberstringOptionalSpecifies the page number on which the tab is located.
Must be 1 for supplemental documents.
widthstringOptionalThe width of the tab in pixels.
Must be an integer.
xPositionstringOptionalThis property indicates the horizontal offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.
yPositionstringOptionalThis property indicates the vertical offset of the object on the page.
Docusign uses 72 DPI when determining position.
Required. Must be an integer. May be zero.

Gets a specific template associated with a specified account — response body — owner

FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe account ID associated with the envelope.
accountNamestringOptionalThe name on the account.
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
emailstringOptionalThe user's email address.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
ipAddressstringOptional
loginStatusstringOptionalWhen **true,** indicates that the user is logged in. This is a read-only property.
membershipIdstringOptionalThe user's membership ID.
sendActivationEmailstringOptionalThis field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
uristringOptionalA URI containing the user ID.
userIdstringOptionalThe ID of the user to access.
userNamestringOptionalThe name of the user.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.

Referenced models: Locks a template — response body — error Details

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.