Deletes one or more documents from an existing envelope that has not yet been completed.

To delete a document, use only the relevant parts of the envelopeDefinition. For example, this request body specifies that you want to delete the document whose documentId is "1".

{
  "documents": [
    {
      "documentId": "1"
    }
  ]
}

The envelope status must be one of:

  • created
  • sent
  • delivered

Request

HTTP request

DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Request Body

envelopeDefinition

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeDocuments
400

Error encountered.

errorDetails

SDK Method

Envelopes::deleteDocuments

Definitions

addressInformation

Contains address information.

citystring

The city associated with the address.

countrystring

Specifies the country associated with the address.

faxstring

A Fax number associated with the address if one is available.

phonestring

A phone number associated with the address.

statestring

The state or province associated with the address.

street1string

The first line of the address.

street2string

The second line of the address (optional).

zipstring

The zip or postal code associated with the address.

addressInformationInput

Contains address input information.

addressInformationaddressInformation

A complex type that contains the following information for the new account (all string content): address1, address2, city, country, fax, phone, postalCode and state.

Note: If country is US (United States) then State codes are validated for US States.

Otherwise, State is treated as a non-validated string and serves the purpose of entering a state/province/region. The maximum characters for the strings are:

  • address1, address2, city, country and state: 100 characters
  • postalCode, phone, and fax: 20 characters

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

When set to true, the information needs to be returned in the response.

agent

Contains information about agent recipients.

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURLstring

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved:

firstNamestring

The user's first name. Maximum Length: 50 characters.

fullNamestring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

lastNamestring

namestring

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

Contains the name/value pair information for the SAML assertion attributes:

  • name - The name of the SAML assertion attribute.
  • value - The value associated with the named SAML assertion attribute.

Your account must be set up to use SSO to use this.

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved: For DocuSign use only.

signingGroupIdstring

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

approve

A tab that allows the recipient to approve documents without placing a signature or initials on the document.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

buttonTextstring

Specifies the approval text displayed in the tab.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

heightinteger

Height of the tab in pixels.

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

attachment

Contains information about an attachment.

accessControlstring

attachmentIdstring

attachmentTypestring

Specifies the type of the attachment for the recipient.

datastring

labelstring

namestring

remoteUrlstring

authenticationStatus

Contains information about the authentication status.

accessCodeResulteventResult

ageVerifyResulteventResult

anySocialIDResulteventResult

facebookResulteventResult

googleResulteventResult

idLookupResulteventResult

idQuestionsResulteventResult

linkedinResulteventResult

liveIDResulteventResult

ofacResulteventResult

openIDResulteventResult

phoneAuthResulteventResult

salesforceResulteventResult

signatureProviderResulteventResult

smsAuthResulteventResult

sTANPinResulteventResult

twitterResulteventResult

yahooResulteventResult

bccEmailAddress

Contains information about the BCC email address.

bccEmailAddressIdstring

Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email.

Example: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.

emailstring

Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.

Maximum of length: 100 characters.

carbonCopy

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

agentCanEditEmailstring

agentCanEditNamestring

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURLstring

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved:

firstNamestring

The user's first name. Maximum Length: 50 characters.

fullNamestring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

lastNamestring

namestring

legal name of the recipient.

Maximum Length: 100 characters.

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved: For DocuSign use only.

signingGroupIdstring

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

certifiedDelivery

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

agentCanEditEmailstring

agentCanEditNamestring

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURLstring

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved:

firstNamestring

The user's first name. Maximum Length: 50 characters.

fullNamestring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

lastNamestring

namestring

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved: For DocuSign use only.

signingGroupIdstring

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

checkbox

A tab that allows the recipient to select a yes/no (on/off) option.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

lockedstring

When set to true, the signer cannot change the data of the custom tab.

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requiredstring

This property does not apply to checkbox tabs. Check boxes are always optional.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

selectedstring

When set to true, the checkbox is selected.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

company

A tab that displays the recipient's company name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requiredstring

When set to true, the signer is required to fill out this tab

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

compositeTemplate

compositeTemplateIdstring

The identify of this composite template. It is used as a reference when adding document object information. If used, the document's content-disposition must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the documentId property only. If no document object is specified, the composite template inherits the first document.

documentdocument

inlineTemplates[inlineTemplate]

Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.

pdfMetaDataTemplateSequencestring

serverTemplates[serverTemplate]

0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value

date

A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

dateSigned

A tab that displays the date that the recipient signed the document.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

decline

A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

buttonTextstring

Specifies the decline text displayed in the tab.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

declineReasonstring

The reason the recipient declined the document.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

heightinteger

Height of the tab in pixels.

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

dobInformationInput

Complex type containing:

  • dateOfBirth
  • displayLevelCode
  • receiveInResponse

dateOfBirthstring

Specifies the recipient's date, month, and year of birth.

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

When set to true, the information needs to be returned in the response.

document

A document object.

applyAnchorTabsstring

Reserved for DocuSign

authoritativeCopyboolean

If 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.

If false, this document is not an authoritative copy regardless of the envelope's authoritativeCopyDefault or authoritativeCopy property.

displaystring

This string sets the display and behavior properties of the document during signing. The possible values are:

  • modal
    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.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    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.

documentBase64string

The 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.

documentFields[nameValue]

documentGroupstring

documentIdstring

Specifies the document ID of this document. This value is used by tabs to determine which document they appear in.

encryptedWithKeyManagerstring

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

fileExtensionstring

The 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.

fileFormatHintstring

htmlDefinitiondocumentHtmlDefinition

includeInDownloadstring

When set to true, the document is included in the combined document download. The default value is true.

matchBoxes[matchBox]

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template.

A matchbox consists of 5 elements:

  • pageNumber - The document page number on which the matchbox will appear.
  • xPosition - The x position of the matchbox on a page.
  • yPosition - The y position of the matchbox on a page.
  • width - The width of the matchbox.
  • height - The height of the matchbox.

namestring

orderstring

An optional value that sets the direction order used to sort the item list.

Valid values are:

  • asc = ascending sort order
  • desc = descending sort order

pagesstring

passwordstring

remoteUrlstring

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

signerMustAcknowledgestring

Sets how the signer interacts with the supplemental document. The possible values are:

  • no_interaction
    No recipient action is required.

  • view
    The recipient is required to view the document.

  • accept
    The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.

  • view_accept
    The recipient is required to view and accept the document.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

transformPdfFieldsstring

When set to 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. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

uristring

documentHtmlCollapsibleDisplaySettings

arrowClosedstring

arrowColorstring

arrowLocationstring

arrowOpenstring

arrowSizestring

arrowStylestring

containerStylestring

labelStylestring

onlyArrowIsClickableboolean

outerLabelAndArrowStylestring

documentHtmlDefinition

displayAnchorPrefixstring

displayAnchors[documentHtmlDisplayAnchor]

displayOrderstring

displayPageNumberstring

documentGuidstring

documentIdstring

The ID of the document being accessed.

headerLabelstring

maxScreenWidthstring

removeEmptyTagsstring

showMobileOptimizedTogglestring

sourcestring

documentHtmlDisplayAnchor

caseSensitiveboolean

displaySettingsdocumentHtmlDisplaySettings

endAnchorstring

removeEndAnchorboolean

removeStartAnchorboolean

startAnchorstring

documentHtmlDisplaySettings

cellStylestring

collapsibleSettingsdocumentHtmlCollapsibleDisplaySettings

displaystring

This string sets the display and behavior properties of the document during signing. The possible values are:

  • modal
    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.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    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.

displayLabelstring

displayOrderinteger

displayPageNumberinteger

hideLabelWhenOpenedboolean

inlineOuterStylestring

labelWhenOpenedstring

scrollToTopWhenOpenedboolean

tableStylestring

documentVisibility

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

rightsstring

visiblestring

editor

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURLstring

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

faxNumberstring

Reserved:

firstNamestring

The user's first name. Maximum Length: 50 characters.

fullNamestring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

lastNamestring

namestring

legal name of the recipient.

Maximum Length: 100 characters.

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved: For DocuSign use only.

signingGroupIdstring

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

email

A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

emailAddress

A tab that displays the recipient's email as entered in the recipient information.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

envelopeDefinition

accessibilitystring

Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account.

Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.

allowMarkupstring

When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

allowReassignstring

When set to true, the recipient can redirect an envelope to a more appropriate recipient.

allowRecipientRecursionstring

When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.

allowViewHistorystring

asynchronousstring

When set to 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 using the transactionId or by checking the Connect notification.

attachments[attachment]

attachmentsUristring

authoritativeCopystring

Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.

authoritativeCopyDefaultstring

The 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.

autoNavigationstring

Specifies whether auto navigation is set for the recipient.

brandIdstring

This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.

brandLockstring

certificateUristring

Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.

completedDateTimestring

Specifies the date and time this item was completed.

compositeTemplates[compositeTemplate]

A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.

createdDateTimestring

Indicates the date and time the item was created.

customFieldsAccountCustomFields

An optional array of strings that allows 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.

customFieldsUristring

Contains a URI for an endpoint to retrieve the custom fields.

declinedDateTimestring

The date and time the recipient declined the document.

deletedDateTimestring

Specifies the data and time the item was deleted.

deliveredDateTimestring

Reserved: For DocuSign use only.

documents[document]

Complex element contains the details on the documents in the envelope.

documentsCombinedUristring

documentsUristring

Contains a URI for an endpoint that you can use to retrieve the documents.

emailBlurbstring

Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters

emailSettingsEnvelopeEmailSettings

This optional complex element allows sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope.

Important Note: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings.

emailSubjectstring

Specifies the subject of the email that is sent to all recipients.

See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

enableWetSignstring

When set to true, the signer is allowed to print the document and sign it on paper.

enforceSignerVisibilitystring

When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

Note: Your account must have Document Visibility enabled to use this.

envelopeIdstring

The envelope ID of the envelope status that failed to post.

envelopeIdStampingstring

When set to true, Envelope ID Stamping is enabled.

envelopeUristring

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

eventNotificationeventNotification

This optional object is used to register a webhook that will receive status changes for this envelope.

initialSentDateTimestring

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

isSignatureProviderEnvelopestring

lastModifiedDateTimestring

The date and time the item was last modified.

lockInformationEnvelopeLocks

messageLockstring

When set to 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.

notificationnotification

An optional complex element that specifies the notification options for the envelope.

notificationUristring

Contains a URI for an endpoint that you can use to retrieve the notifications.

passwordstring

purgeStatestring

Initiates a purge request. Valid values are:

  • documents_queued - Places envelope documents in the purge queue.
  • documents_and_metadata_queued - Places envelope documents and metadata in the purge queue.

recipientsEnvelopeRecipients

Specifies the envelope recipients.

recipientsLockstring

When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

recipientsUristring

Contains a URI for an endpoint that you can use to retrieve the recipients.

sentDateTimestring

The date and time the envelope was sent.

signerCanSignOnMobilestring

signingLocationstring

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

statusstring

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.

statusChangedDateTimestring

The data and time the status changed.

templateIdstring

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

templateRoles[templateRole]

Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up by the following elements:

  • email - The recipient's email address.
  • name - The recipient's name.
  • roleName - The template roleName associated with the recipient.
  • clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending.
  • defaultRecipient - Optional, When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
  • routingOrder - This specifies the routing order of the recipient in the envelope.
  • accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters.
  • inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters.
  • emailNotification - This is an optional complex element that has a role-specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients.
  • tabs - This allows the tab values to be specified for matching to tabs in the template.

templatesUristring

Contains a URI for an endpoint which you can use to retrieve the templates.

transactionIdstring

Used 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 connection was lost before the envelope status was returned.

useDisclosurestring

When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to 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.

voidedDateTimestring

The date and time the envelope or template was voided.

voidedReasonstring

The reason the envelope or template was voided.

envelopeDocument

attachmentTabIdstring

authoritativeCopystring

Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.

availableDocumentTypes[signatureType]

containsPdfFormFieldsstring

displaystring

This string sets the display and behavior properties of the document during signing. The possible values are:

  • modal
    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.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    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.

documentFields[nameValue]

documentGroupstring

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

includeInDownloadstring

When set to true, the document is included in the combined document download. The default value is true.

namestring

orderstring

An optional value that sets the direction order used to sort the item list.

Valid values are:

  • asc = ascending sort order
  • desc = descending sort order

pagesstring

signerMustAcknowledgestring

Sets how the signer interacts with the supplemental document. The possible values are:

  • no_interaction
    No recipient action is required.

  • view
    The recipient is required to view the document.

  • accept
    The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.

  • view_accept
    The recipient is required to view and accept the document.

typestring

Type of the user. Valid values: type_owner, type_participant.

uristring

envelopeEvent

For which envelope events should your webhook be called?

envelopeEventStatusCodestring

An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided.

includeDocumentsstring

reserved

envelopeId

A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

eventNotification

Register a Connect webhook for a specific envelope

envelopeEvents[envelopeEvent]

A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property.

To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

includeCertificateOfCompletionstring

When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.

includeCertificateWithSoapstring

When set to true, the Connect service will digitally sign the XML data. The signature will be included in the XML message.

includeDocumentFieldsstring

When set to true, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.

includeDocumentsstring

When set to true, the XML webhook messages will include the envelope's PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger.

includeEnvelopeVoidReasonstring

When set to true, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.

includeSenderAccountAsCustomFieldstring

When set to true, Connect will include the sender account as Custom Field in the data.

includeTimeZonestring

When set to true, the envelope's time zone information is included in the webhook messages.

loggingEnabledstring

When set to true, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the ConnectEvents resource.

recipientEvents[recipientEvent]

An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the url property.

To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

requireAcknowledgmentstring

When set to true, the DocuSign Connect service checks that the message was received and retries on failures.

signMessageWithX509Certstring

When set to true, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol.

soapNameSpacestring

The namespace of the SOAP interface.

The namespace value must be set if useSoapInterface is set to true.

urlstring

The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used.

useSoapInterfacestring

When set to true, the notifications are sent to your endpoint as SOAP requests.

eventResult

eventTimestampstring

failureDescriptionstring

statusstring

Event status.

vendorFailureStatusCodestring

expirations

A complex element that specifies the expiration settings for the envelope.

expireAfterstring

An integer that sets the number of days the envelope is active.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

firstName

A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

formulaTab

The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result.

The formula property of the tab contains the references to the underlying tabs. See Calculated Fields in the DocuSign Support Center to learn more about formulas.

If a formula tab contains a paymentDetails property, the tab is considered a payment item. See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

formulastring

Contains the formula for calculating the value of this tab.

Use a tab's tabLabel, enclosed in brackets, to refer to it.

For example, you want to present the total cost of two items, tax included.

The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate.

The formula string for this property would be: ([Item1] + [Item2]) * (1 + [TaxRate])

See Calculated Fields in the DocuSign Support Center to learn more about formulas.

Maximum Length: 2000 characters

hiddenstring

If this is a regular formula (no paymentDetails property is present):

  • true: The tab is hidden.
  • false: The tab is shown.

If the formula is payment item (a paymentDetails property is present):

  • true: The tab is displayed as a payment.
  • false: The tab is displayed as a regular formula.

isPaymentAmountstring

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

paymentDetailspaymentDetails

This property indicates that this formula tab is a payment item.
See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

roundDecimalPlacesstring

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

fullName

A tab that displays the recipient's full name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

idCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

addressInformationInputaddressInformationInput

dobInformationInputdobInformationInput

Complex type containing:

  • dateOfBirth
  • displayLevelCode
  • receiveInResponse

ssn4InformationInputssn4InformationInput

ssn9InformationInputssn9InformationInput

initialHere

A tab that allows the recipient to initial the document. May be optional.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

optionalstring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

scaleValuenumber

Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

inlineTemplate

customFieldsAccountCustomFields

An optional array of strings that allows 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.

documents[document]

Complex element contains the details on the documents in the envelope.

envelopeEnvelopes

A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.

recipientsEnvelopeRecipients

sequencestring

Specifies the order in which templates are overlaid.

inPersonSigner

An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about fields used for eNotary feature, see the EnvelopeRecipients resource.

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

autoNavigationstring

Specifies whether auto navigation is set for the recipient.

canSignOfflinestring

When set to true, specifies that the signer can perform the signing ceremony offline.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

creationReasonstring

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

defaultRecipientstring

When set to true, this is the default recipient for the envelope. This option is used when creating an envelope from a template.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

The signer's email address in an eNotary flow.

Use only when inPersonSigningType is notary. For regular in-person-signer flow, use signerEmail instead.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved:

hostEmailstring

The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session.

Required when inPersonSigningType is inPersonSigner. For eNotary flow, use email instead.

Maximum Length: 100 characters.

hostNamestring

The name of the signing host. This is the DocuSign user that is hosting the in-person signing session.

Required when inPersonSigningType is inPersonSigner. For eNotary flow, use name instead.

Maximum Length: 100 characters.

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

inPersonSigningTypestring

Specifies whether the envelope uses the eNotary feature. Valid values:

  • inPersonSigner The envelope uses the normal in-person signing flow.
  • notary: The envelope uses the eNotary in-person signing flow.

namestring

The signer's full legal name in an eNotary flow.

Required when inPersonSigningType is notary. For regular in-person-signer flow, use signerName instead.

Maximum Length: 100 characters.

notaryHostnotaryHost

Information about the notary host. The following information is required when using the eNotary in-person signing flow:

  • name: Specifies the name of the notary.
  • email: Specifies the email address of the notary.
  • recipientId: A unique ID number for the notary signing host.

notestring

A note sent to the in-person signer in the signing email. This note is visible only to this recipient.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

recipientSignatureProviders[recipientSignatureProvider]

The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. More information.

recipientSuppliesTabsstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

requireSignerCertificatestring

By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.

This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the recipientSignatureProviders parameter for other types of digital certificates.

Set this parameter to safe to use a SAFE-BioPharma certificate.

The signer must be enrolled in the SAFE program to sign with a SAFE certificate.

requireSignOnPaperstring

When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signatureInforecipientSignatureInformation

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.

Used only with recipient types In Person Signers and Signers.

signedDateTimestring

Reserved: For DocuSign use only.

signerEmailstring

The in-person signer's email address.

Required when inPersonSigningType is inPersonSigner. For eNotary flow, use email instead.

Maximum Length: 100 characters.

signerNamestring

The in-person signer's full legal name.

Required when inPersonSigningType is inPersonSigner. For eNotary flow, use name instead.

Maximum Length: 100 characters.

signInEachLocationstring

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).

signingGroupIdstring

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

tabsEnvelopeRecipientTabs

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

intermediary

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURLstring

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved:

firstNamestring

The user's first name. Maximum Length: 50 characters.

fullNamestring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

lastNamestring

namestring

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved: For DocuSign use only.

signingGroupIdstring

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

lastName

A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

list

This tab offers a list of options to choose from. The listItems property contains a list of listItem objects to specify the selectable options.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

listItems[listItem]

The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]

Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

mergeFieldmergeField

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

The value to use when the item is selected.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

listCustomField

configurationTypestring

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

errorDetailserrorDetails

fieldIdstring

An ID used to specify a custom field.

listItems[array]

namestring

The name of the custom field.

requiredstring

When set to true, the signer is required to fill out this tab

showstring

A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion.

valuestring

The value of the custom field.

Maximum Length: 100 characters.

listItem

One of the selectable items in the listItems property of a list tab.

selectedstring

When set to true, indicates that this item is the default selection shown to a signer.

Only one selection can be set as the default.

textstring

Specifies the text that is shown in the dropdown list.

valuestring

Specifies the value that is used when the list item is selected.

matchBox

heightinteger

Height of the tab in pixels.

pageNumberinteger

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

widthinteger

Width of the tab in pixels.

xPositioninteger

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositioninteger

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

mergeField

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

allowSenderToEditstring

When set to true, the sender can modify the value of the custom tab during the sending process.

configurationTypestring

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

pathstring

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

rowstring

Specifies the row number in a Salesforce table that the merge field value corresponds to.

writeBackstring

When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.

money

Describes information about the total of a payment.

amountInBaseUnitstring

The total payment amount in the currency's base unit. For example, for USD the base currency is one cent.

currencystring

The three-letter ISO 4217 currency code for the payment.

For example:

  • AUD Australian dollar
  • CAD Canadian dollar
  • EUR Euro
  • GBP Great Britain pound
  • USD United States dollar

This is a read-only property.

displayAmountstring

The payment amount as displayed in the currency.

For example, if the payment amount is USD 12.59, the amountInBaseUnit is 1259 (cents), and the displayed amount is $12.59 USD.

This is a read-only property.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

notarize

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

documentIdstring

The ID of the document being accessed.

errorDetailserrorDetails

lockedstring

When set to true, the signer cannot change the data of the custom tab.

mergeFieldmergeField

pageNumberstring

The page number being accessed.

recipientIdstring

The recipientId used when the envelope or template was created.

requiredstring

When set to true, the signer is required to fill out this tab

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

notaryHost

This object is used only when inPersonSigningType in the inPersonSigner object is notary.

It describes information about the notary host. The following information is required when using the eNotary in-person signing flow:

  • name: Specifies the notary's full legal name.
  • email: Specifies the notary's email address.
  • recipientId: A unique ID number for the notary signing host.

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

The notary's email address.

Maximum Length: 100 characters.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

faxNumberstring

Reserved:

hostRecipientIdstring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

namestring

The notary's full legal name.

Maximum Length: 100 characters.

notestring

A note sent to the notary in the signing email. This note is visible only to this notary.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved: For DocuSign use only.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.

tabsEnvelopeRecipientTabs

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

note

A tab that displays additional information, in the form of a note, for the recipient.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

heightinteger

Height of the tab in pixels.

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

notification

A complex element that specifies the notification options for the envelope. It consists of:

  • useAccountDefaults - When set to true, the account default notification settings are used for the envelope.
  • reminders - A complex element that specifies reminder settings for the envelope. It consists of:

    • reminderEnabled - When set to true, a reminder message is sent to the recipient.
    • reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.
    • reminderFrequency - An interger that sets the interval, in days, between reminder emails.
  • expirations - A complex element that specifies the expiration settings for the envelope. It consists of:

    • expireEnabled - When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.
    • expireAfter - An integer that sets the number of days the envelope is active.
    • expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

expirationsexpirations

A complex element that specifies the expiration settings for the envelope.

remindersreminders

A complex element that specifies reminder settings for the envelope

useAccountDefaultsstring

When set to true, the account default notification settings are used for the envelope.

number

A tab that allows the recipient to enter numbers and decimal (.) points.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

formulastring

Contains the formula for calculating the value of this tab.

Use a tab's tabLabel, enclosed in brackets, to refer to it.

For example, you want to present the total cost of two items, tax included.

The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate.

The formula string for this property would be: ([Item1] + [Item2]) * (1 + [TaxRate])

See Calculated Fields in the DocuSign Support Center to learn more about formulas.

Maximum Length: 2000 characters

isPaymentAmountstring

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

paymentDetails

When a formula tab has a paymentDetails property, the formula tab is a payment item. See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

allowedPaymentMethods[array]

An array of accepted payment methods:

  • CreditCard
  • ApplePay
  • AndroidPay
  • BankAccount

For example, if you only accept credit cards and ACH transfers, you would set this property to:

'["BankAccount", "CreditCard"]'

Do not specify BankAccount (ACH) if you are also using in-person signing.

chargeIdstring

The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The chargeId is created when authorizing a payment and must be referenced when completing a payment.

currencyCodestring

Specifies the three-letter ISO 4217 currency code for the payment.

Supported currencies are:

  • AUD Australian dollar
  • CAD Canadian dollar
  • EUR Euro
  • GBP Great Britain pound
  • USD United States dollar

Specifying any other ISO 4217 code for payments is an error.

gatewayAccountIdstring

A GUID that identifies the payment gateway connected to the sender's DocuSign account.

There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the DocuSign Admin console and through your chosen payment gateway.

You can get the gateway account ID in the Payments section of the DocuSign Admin console.

gatewayDisplayNamestring

Display name of the gateway connected to sender's Docusign account.

Possible values are: Stripe, Braintree, Authorize.Net.

gatewayNamestring

Name of the gateway connected to sender's DocuSign account.

Possible values are:

  • Stripe
  • Braintree
  • AuthorizeDotNet

lineItems[paymentLineItem]

A payment formula can have one or more line items that provide detail about individual items in a payment request.

The list of line items are returned as metadata to the payment gateway.

paymentOptionstring

statusstring

This read-only property describes the status of a payment.

  • new
    This is a new payment request. The envelope has been created, but no payment authorizations have been made.

  • auth_complete
    A recipient has entered their credit card information, but the envelope has not been completed. The card has not been charged.

  • payment_complete
    The recipient's card has been charged.

  • payment_capture_failed
    Final charge failed. This can happen when too much time passes between authorizing the payment and completing the document.

totalmoney

This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields.

paymentLineItem

A line item describes details about an individual line item in a payment request.

amountReferencestring

This is a the tabLabel that specifies the amount paid for the line items.

descriptionstring

A sender-defined description of the line item.

itemCodestring

This is the sender-defined SKU, inventory number, or other item code for the line item.

namestring

This is a sender-defined product name, service name, or other designation for the line item.

propertyMetadata

options[array]

rightsstring

radio

One of the selectable radio buttons in the radios property of a radioGroup tab.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

errorDetailserrorDetails

lockedstring

When set to true, the signer cannot change the data of the custom tab.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

requiredstring

When set to true, the signer is required to fill out this tab

selectedstring

When set to true, the radio button is selected.

tabIdstring

The unique identifier for the tab.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

valuestring

Specifies the value of the tab.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

radioGroup

This group tab is used to place radio buttons on a document. The radios property contains a list of radio objects associated with the group. Only one radio button can be selected in a group.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

groupNamestring

The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.

radios[radio]

Specifies the locations and status for radio buttons that are grouped together.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

sharedstring

When set to true, this custom tab is shared.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

recipientAttachment

attachmentIdstring

attachmentTypestring

datastring

labelstring

namestring

remoteUrlstring

recipientEmailNotification

emailBodystring

Not applicable

emailSubjectstring

Not applicable

supportedLanguagestring

Specifies the language used to localize Electronic Seals UI texts such as "Sealed by", etc.

The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).

This parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing.

recipientEvent

includeDocumentsstring

reserved

recipientEventStatusCodestring

Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.

recipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipMayProvideNumberstring

Boolean. When set to true, the recipient can supply a phone number their choice.

recordVoicePrintstring

Reserved.

senderProvidedNumbers[array]

An Array containing a list of phone numbers the recipient may use for SMS text authentication.

validateRecipProvidedNumberstring

Reserved.

recipientSAMLAuthentication

Contains the name/value pair information for the SAML assertion attributes:

  • name - The name of the SAML assertion attribute.
  • value - The value associated with the named SAML assertion attribute.

Your account must be set up to use SSO to use this.

samlAssertionAttributes[samlAssertionAttribute]

recipientSignatureInformation

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.

Used only with recipient types In Person Signers and Signers.

fontStylestring

signatureInitialsstring

signatureNamestring

Specifies the user signature name.

recipientSignatureProvider

An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.

sealDocumentsWithTabsOnlystring

By default, electronic seals apply on all documents in an envelope. If any of the documents has a signHere tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.

To apply electronic seals on specific documents only, you must enable the sealDocumentsWithTabsOnly parameter. In this case, Electronic Seal applies only on documents that have signHere tabs set for the Electronic Seal recipient. Other documents won't be sealed.

sealNamestring

Indicates the name of the electronic seal to apply on documents.

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.

signatureProviderOptionsrecipientSignatureProviderOptions

Not applicable.

recipientSignatureProviderOptions

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.

cpfNumberstring

Reserved for DocuSign

oneTimePasswordstring

A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.

signerRolestring

The role or capacity of the signing recipient. Examples: Manager, Approver, etc.

smsstring

The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.

recipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

senderProvidedNumbers[array]

An Array containing a list of phone numbers the recipient may use for SMS text authentication.

reminders

A complex element that specifies reminder settings for the envelope

reminderDelaystring

An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

reminderEnabledstring

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

reminderFrequencystring

An interger that sets the interval, in days, between reminder emails.

samlAssertionAttribute

errorDetailserrorDetails

namestring

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value associated with the named SAML assertion attribute

sealSign

Specifies one or more electronic seals to apply on documents.

"recipients": {
      "seals": [
        {
          "recipientId": "1",
          "routingOrder" : 1,
          "recipientSignatureProviders": [
            {
              "sealName": "52e9d968-13be-42ca-a6fe-4682bc45c106"
            }
          ]
        }
      ]
    },

For more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals

accessCodestring

Not applicable

addAccessCodeToEmailstring

Not applicable

clientUserIdstring

Not applicable

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

Not applicable

declinedReasonstring

Not applicable

deliveredDateTimestring

Not applicable

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

Not applicable

emailNotificationrecipientEmailNotification

Sets the language for electronic seals.

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

faxNumberstring

Reserved:

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

Not applicable

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

namestring

notestring

Not applicable

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Not applicable

recipientAuthenticationStatusauthenticationStatus

Not applicable

recipientIdstring

(Required) The recipientId used when the envelope or template was created.

recipientIdGuidstring

recipientSignatureProviders[recipientSignatureProvider]

(Required) Indicates which electronic seal to apply on documents when creating an envelope.

requireIdLookupstring

Not applicable

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

(Optional, default: 1) Specifies the routing order of the electronic seal in the envelope. The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals.

samlAuthenticationrecipientSAMLAuthentication

Not applicable

sentDateTimestring

Not applicable

signedDateTimestring

Not applicable

smsAuthenticationrecipientSMSAuthentication

Not applicable

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Item status.

tabsEnvelopeRecipientTabs

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

Not applicable

userIdstring

Not applicable

serverTemplate

sequencestring

templateIdstring

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

signatureType

isDefaultstring

typestring

Type of the user. Valid values: type_owner, type_participant.

signer

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmailstring

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

agentCanEditEmailstring

agentCanEditNamestring

autoNavigationstring

Specifies whether auto navigation is set for the recipient.

bulkRecipientsUristring

Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.

canSignOfflinestring

When set to true, specifies that the signer can perform the signing ceremony offline.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

creationReasonstring

customFields[array]

An optional array of strings that allows 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.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

defaultRecipientstring

When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.

deliveredDateTimestring

Reserved: For DocuSign use only.

deliveryMethodstring

Reserved: For DocuSign use only.

documentVisibility[documentVisibility]

emailstring

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURLstring

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetailserrorDetails

excludedDocuments[array]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumberstring

Reserved:

firstNamestring

The user's first name. Maximum Length: 50 characters.

fullNamestring

idCheckConfigurationNamestring

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the idCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add phone number information to the smsAuthentication node.

idCheckInformationInputidCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

isBulkRecipientstring

When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.

Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient.

lastNamestring

namestring

notestring

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.

recipientAttachments[recipientAttachment]

Reserved:

recipientAuthenticationStatusauthenticationStatus

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

recipientSignatureProviders[recipientSignatureProvider]

The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. More information.

recipientSuppliesTabsstring

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

requireSignerCertificatestring

By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.

This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the recipientSignatureProviders parameter for other types of digital certificates.

Set this parameter to safe to use a SAFE-BioPharma certificate.

The signer must be enrolled in the SAFE program to sign with a SAFE certificate.

requireSignOnPaperstring

When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

samlAuthenticationrecipientSAMLAuthentication

sentDateTimestring

The date and time the envelope was sent.

signatureInforecipientSignatureInformation

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.

Used only with recipient types In Person Signers and Signers.

signedDateTimestring

Reserved: For DocuSign use only.

signInEachLocationstring

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).

signingGroupIdstring

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

A complex type that contains information about users in the signing group.

smsAuthenticationrecipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

statusstring

Recipient status.

tabsEnvelopeRecipientTabs

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

signerAttachment

A tab that allows the recipient to attach supporting documents to an envelope.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

mergeFieldmergeField

namestring

optionalstring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

scaleValuenumber

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

signHere

A tab that allows the recipient to sign a document. May be optional.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

optionalstring

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

scaleValuenumber

stampTypestring

stampTypeMetadatapropertyMetadata

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

The signHere tab appears 21 points lower than the value you provide here. To align the tab as expected, subtract 21 from the expected y-value.

See Sign Here Tab Alignment

socialAuthentication

authenticationstring

Reserved: TBD

ssn

A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

ssn4InformationInput

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

When set to true, the information needs to be returned in the response.

ssn4string

The last four digits of the recipient's Social Security Number (SSN).

ssn9InformationInput

displayLevelCodestring

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay

ssn9string

The recipient's Social Security Number(SSN).

tabGroup

childTabLabels[array]

childTabLabelsMetadatapropertyMetadata

errorDetailserrorDetails

groupLabelstring

groupLabelMetadatapropertyMetadata

groupRulestring

groupRuleMetadatapropertyMetadata

maximumAllowedstring

maximumAllowedMetadatapropertyMetadata

minimumRequiredstring

minimumRequiredMetadatapropertyMetadata

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdMetadatapropertyMetadata

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationMessageMetadatapropertyMetadata

templateRole

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

defaultRecipientstring

When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.

emailstring

Specifies the email associated with a role name.

emailNotificationrecipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

embeddedRecipientStartURLstring

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

inPersonSignerNamestring

Specifies the full legal name of the signer in person signer template roles.

Maximum Length: 100 characters.

namestring

Specifies the recipient's name.

recipientSignatureProviders[recipientSignatureProvider]

The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. More information.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

signingGroupIdstring

tabsEnvelopeRecipientTabs

text

A tab that allows the recipient to enter any type of text.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

formulastring

Contains the formula for calculating the value of this tab.

Use a tab's tabLabel, enclosed in brackets, to refer to it.

For example, you want to present the total cost of two items, tax included.

The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate.

The formula string for this property would be: ([Item1] + [Item2]) * (1 + [TaxRate])

See Calculated Fields in the DocuSign Support Center to learn more about formulas.

Maximum Length: 2000 characters

heightinteger

Height of the tab in pixels.

isPaymentAmountstring

When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

Specifies the tool tip text for the tab.

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

textCustomField

configurationTypestring

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

errorDetailserrorDetails

fieldIdstring

An ID used to specify a custom field.

namestring

The name of the custom field.

requiredstring

When set to true, the signer is required to fill out this tab

showstring

A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion.

valuestring

The value of the custom field.

title

A tab that displays the recipient's title.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requiredstring

When set to true, the signer is required to fill out this tab

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

userInfo

activationAccessCodestring

emailstring

errorDetailserrorDetails

loginStatusstring

sendActivationEmailstring

uristring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

userNamestring

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

view

This tab is used with the Approve tab to handle supplemental documents.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

buttonTextstring

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

heightinteger

Height of the tab in pixels.

italicstring

When set to true, the information in the tab is italic.

mergeFieldmergeField

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requiredstring

When set to true, the signer is required to fill out this tab

requiredReadstring

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

zip

A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

boldstring

When set to true, the information in the tab is bold.

concealValueOnDocumentstring

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabIdstring

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSizestring

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

italicstring

When set to true, the information in the tab is italic.

lockedstring

When set to true, the signer cannot change the data of the custom tab.

maxLengthinteger

An optional value that describes the maximum length of the property when the property is a string.

mergeFieldmergeField

namestring

originalValuestring

The initial value of the tab when it was sent to the recipient.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAllstring

When set to true and shared is true, information must be entered in this field to complete the envelope.

requiredstring

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChangestring

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequiredstring

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

sharedstring

When set to true, this custom tab is shared.

statusstring

Tab status

tabIdstring

The unique identifier for the tab.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underlinestring

When set to true, the information in the tab is underlined.

useDash4string

validationMessagestring

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPatternstring

A regular expressionn used to validate input for the tab.

valuestring

Specifies the value of the tab.

widthinteger

Width of the tab in pixels.

xPositionstring

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

AccountCustomFields

Custom Fields

listCustomFields[listCustomField]

An array of list custom fields.

textCustomFields[textCustomField]

An array of text custom fields.

EnvelopeLocks

Envelope locks

errorDetailserrorDetails

lockDurationInSecondsstring

Sets the time, in seconds, until the lock expires when there is no activity on the envelope.

If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.

The lock duration can be extended.

lockedByAppstring

Specifies the friendly name of the application that is locking the envelope.

lockedByUseruserInfo

A complex type containing information about the user that has the Envelope or Template locked.

lockedUntilDateTimestring

The datetime until the envelope lock expires.

lockTokenstring

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.

lockTypestring

The type of envelope lock. Currently "edit" is the only supported type.

useScratchPadstring

Reserved for future use.

Indicates whether a scratchpad is used for editing information.

EnvelopeRecipients

Envelope recipients

agents[agent]

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.

carbonCopies[carbonCopy]

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.

certifiedDeliveries[certifiedDelivery]

A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.

currentRoutingOrderstring

editors[editor]

A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.

errorDetailserrorDetails

inPersonSigners[inPersonSigner]

Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.

intermediaries[intermediary]

Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).

recipientCountstring

The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:

  • recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
  • includeDocuments - When set to true, the envelope time zone information is included in the message.

seals[sealSign]

signers[signer]

A complex type containing information about the Signer recipient.

EnvelopeRecipientTabs

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

approveTabs[approve]

A list of Approve tabs.

This tab allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history.

checkboxTabs[checkbox]

A list of Checkbox tabs.

This tab allows the recipient to select a yes/no (on/off) option.

companyTabs[company]

A list of Company tabs.

This tab displays the recipient's company name.

dateSignedTabs[dateSigned]

A list of Date Signed tabs

This tab displays the date that the recipient signed the document.

dateTabs[date]

A list of Date tabs.

This tab allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

declineTabs[decline]

A list of Decline tabs.

This tab allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.

emailAddressTabs[emailAddress]

A list of Email Address tabs.

This tab displays the recipient's email as entered in the recipient information.

emailTabs[email]

A list of Email tabs.

This tab allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

envelopeIdTabs[envelopeId]

A list of Envelope ID tabs.

This tab displays the envelope ID. Recipients cannot enter or change the information in this tab.

firstNameTabs[firstName]

A list of First Name tabs.

This tab displays the recipient's first name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

formulaTabs[formulaTab]

A list of Formula tabs.

The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result.

The formula property of the tab contains the references to the underlying tabs. See Calculated Fields in the DocuSign Support Center to learn more about formulas.

If a formula tab contains a paymentDetails property, the tab is considered a payment item. See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

fullNameTabs[fullName]

A list of Full Name tabs.

This tab displays the recipient's full name.

initialHereTabs[initialHere]

A list of Initial Here tabs.

This tab allows the recipient to initial the document. May be optional.

lastNameTabs[lastName]

A list of Last Name tabs.

This tab displays the recipient's last name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

listTabs[list]

A list of list tabs.

This tab offers a list of options to choose from. The listItems property is used to specify the selectable options.

notarizeTabs[notarize]

A list of Notarize tabs.

A notarize tab is a tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

noteTabs[note]

A list of Note tabs.

This tab displays additional information, in the form of a note, for the recipient.

numberTabs[number]

A list of Number tabs.

This tab allows the recipient to enter numbers and decimal (.) points.

radioGroupTabs[radioGroup]

A list of Radio Group tabs.

This tab This group tab is used to place radio buttons on a document. The radios property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group.

signerAttachmentTabs[signerAttachment]

A list of Signer Attachment tabs.

This tab allows the recipient to attach supporting documents to an envelope.

signHereTabs[signHere]

A list of Sign Here tabs.

This tab allows the recipient to sign a document. May be optional.

ssnTabs[ssn]

A list of SSN tabs.

This tab is a one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.

tabGroups[tabGroup]

textTabs[text]

A list of Text tabs.

This tab A tab that allows the recipient to enter any type of text.

titleTabs[title]

A list of Title tabs.

This tab displays the recipient's title.

viewTabs[view]

A list of View tabs.

This tab This tab is used with the Approve tab to handle supplemental documents.

zipTabs[zip]

A list of Zip tabs.

This tab allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

EnvelopeDocuments

Envelope documents

envelopeDocuments[envelopeDocument]

envelopeIdstring

The envelope ID of the envelope status that failed to post.

EnvelopeEmailSettings

Envelope email settings

bccEmailAddresses[bccEmailAddress]

A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes.

replyEmailAddressOverridestring

replyEmailNameOverridestring

Envelopes

Envelope creation, management

allowMarkupstring

When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

allowReassignstring

When set to true, the recipient can redirect an envelope to a more appropriate recipient.

allowViewHistorystring

asynchronousstring

When set to 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 using the transactionId or by checking the Connect notification.

attachmentsUristring

authoritativeCopystring

Specifies whether all documents in this envelope are authoritative copies. A document can set its own authoritativeCopy property to override this value. For example you can set the authoritativeCopy on an envelope level to true but can turn it off for a specific document.

authoritativeCopyDefaultstring

The 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.

autoNavigationstring

Specifies whether auto navigation is set for the recipient.

brandIdstring

The unique identifier of a brand.

brandLockstring

certificateUristring

Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.

completedDateTimestring

Specifies the date and time this item was completed.

createdDateTimestring

Indicates the date and time the item was created.

customFieldsAccountCustomFields

An optional array of strings that allows 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.

customFieldsUristring

Contains a URI for an endpoint to retrieve the custom fields.

declinedDateTimestring

The date and time the recipient declined the document.

deletedDateTimestring

Specifies the data and time the item was deleted.

deliveredDateTimestring

Reserved: For DocuSign use only.

documentsCombinedUristring

documentsUristring

Contains a URI for an endpoint that you can use to retrieve the documents.

emailBlurbstring

This is the same as the email body. If specified it is included in email body for all envelope recipients.

emailSettingsEnvelopeEmailSettings

A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent.

When the emailSettings information is used for an envelope, it only applies to that envelope.

IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings.

EmailSettings consists of:

  • replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.
  • replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.
  • bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.

emailSubjectstring

Specifies the subject of the email that is sent to all recipients.

See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

enableWetSignstring

When set to true, the signer is allowed to print the document and sign it on paper.

enforceSignerVisibilitystring

When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

Note: Your account must have Document Visibility enabled to use this.

envelopeIdstring

The envelope ID of the envelope status that failed to post.

envelopeIdStampingstring

When set to true, Envelope ID Stamping is enabled.

envelopeUristring

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

initialSentDateTimestring

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

isSignatureProviderEnvelopestring

lastModifiedDateTimestring

The date and time the item was last modified.

lockInformationEnvelopeLocks

messageLockstring

When set to 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.

notificationnotification

A complex element that specifies the notification options for the envelope. It consists of:

  • useAccountDefaults - When set to true, the account default notification settings are used for the envelope.
  • reminders - A complex element that specifies reminder settings for the envelope. It consists of:

    • reminderEnabled - When set to true, a reminder message is sent to the recipient.
    • reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.
    • reminderFrequency - An interger that sets the interval, in days, between reminder emails.
  • expirations - A complex element that specifies the expiration settings for the envelope. It consists of:

    • expireEnabled - When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.
    • expireAfter - An integer that sets the number of days the envelope is active.
    • expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

notificationUristring

Contains a URI for an endpoint that you can use to retrieve the notifications.

purgeStatestring

Shows the current purge state for the envelope. The possible values are:

  • 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_and_metadata_queued: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.
  • documents_purged: The envelope documents have been successfully purged.
  • documents_and_metadata_purged: The envelope documents and metadata have been successfully purged.

recipientsEnvelopeRecipients

recipientsLockstring

When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

recipientsUristring

Contains a URI for an endpoint that you can use to retrieve the recipients.

sentDateTimestring

The date and time the envelope was sent.

signerCanSignOnMobilestring

signingLocationstring

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

statusstring

Indicates the envelope status. Valid values are:

  • completed - The envelope has been completed and all tags have been signed.
  • 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 is sent to the recipients.
  • signed - The envelope has been signed by the recipients.
  • voided - The envelope is no longer valid and recipients cannot access or sign the envelope.

statusChangedDateTimestring

The data and time the status changed.

templatesUristring

Contains a URI for an endpoint which you can use to retrieve the templates.

transactionIdstring

Used 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 connection was lost before the envelope status was returned.

useDisclosurestring

When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to 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.

voidedDateTimestring

The date and time the envelope or template was voided.

voidedReasonstring

The reason the envelope or template was voided.

Examples

Generic JSON Request/Response

Request
{
  "documents": [
    {
      "documentId": "sample string 1",
      "uri": "sample string 2",
      "remoteUrl": "sample string 3",
      "name": "sample string 4",
      "password": "sample string 5",
      "transformPdfFields": "sample string 6",
      "fileExtension": "sample string 7",
      "matchBoxes": [
        {
          "pageNumber": 1,
          "xPosition": 2,
          "yPosition": 3,
          "width": 4,
          "height": 5
        }
      ],
      "order": "sample string 8",
      "pages": "sample string 9",
      "documentFields": [
        {}
      ],
      "encryptedWithKeyManager": "sample string 10",
      "documentBase64": "sample string 11",
      "applyAnchorTabs": "sample string 12",
      "display": "sample string 13",
      "includeInDownload": "sample string 14",
      "signerMustAcknowledge": "sample string 15",
      "templateLocked": "sample string 16",
      "templateRequired": "sample string 17",
      "documentGroup": "sample string 18",
      "fileFormatHint": "sample string 19",
      "authoritativeCopy": true
    }
  ],
  "attachments": [
    {
      "attachmentId": "sample string 1",
      "label": "sample string 2",
      "attachmentType": "sample string 3",
      "name": "sample string 4",
      "accessControl": "sample string 5",
      "data": "sample string 6",
      "remoteUrl": "sample string 7"
    }
  ],
  "eventNotification": {
    "url": "sample string 1",
    "loggingEnabled": "sample string 2",
    "requireAcknowledgment": "sample string 3",
    "envelopeEvents": [
      {
        "envelopeEventStatusCode": "sample string 1",
        "includeDocuments": "sample string 2"
      }
    ],
    "recipientEvents": [
      {
        "recipientEventStatusCode": "sample string 1",
        "includeDocuments": "sample string 2"
      }
    ],
    "useSoapInterface": "sample string 4",
    "soapNameSpace": "sample string 5",
    "includeCertificateWithSoap": "sample string 6",
    "signMessageWithX509Cert": "sample string 7",
    "includeDocuments": "sample string 8",
    "includeEnvelopeVoidReason": "sample string 9",
    "includeTimeZone": "sample string 10",
    "includeSenderAccountAsCustomField": "sample string 11",
    "includeDocumentFields": "sample string 12",
    "includeCertificateOfCompletion": "sample string 13"
  },
  "allowRecipientRecursion": "sample string 1",
  "templateId": "sample string 2",
  "password": "sample string 3",
  "templateRoles": [
    {
      "email": "sample string 1",
      "roleName": "sample string 2",
      "name": "sample string 3",
      "signingGroupId": "sample string 4",
      "inPersonSignerName": "sample string 5",
      "clientUserId": "sample string 6",
      "embeddedRecipientStartURL": "sample string 7",
      "defaultRecipient": "sample string 8",
      "accessCode": "sample string 9",
      "routingOrder": "sample string 10",
      "emailNotification": {
        "emailSubject": "sample string 1",
        "emailBody": "sample string 2",
        "supportedLanguage": "sample string 3"
      },
      "tabs": {
        "signHereTabs": [
          {
            "stampType": "sample string 1",
            "name": "sample string 2",
            "tabLabel": "sample string 3",
            "scaleValue": 1.1,
            "optional": "sample string 4",
            "documentId": "sample string 5",
            "recipientId": "sample string 6",
            "pageNumber": "sample string 7",
            "xPosition": "sample string 8",
            "yPosition": "sample string 9",
            "anchorString": "sample string 10",
            "anchorXOffset": "sample string 11",
            "anchorYOffset": "sample string 12",
            "anchorUnits": "sample string 13",
            "anchorIgnoreIfNotPresent": "sample string 14",
            "anchorCaseSensitive": "sample string 15",
            "anchorMatchWholeWord": "sample string 16",
            "anchorHorizontalAlignment": "sample string 17",
            "tabId": "sample string 18",
            "templateLocked": "sample string 19",
            "templateRequired": "sample string 20",
            "conditionalParentLabel": "sample string 21",
            "conditionalParentValue": "sample string 22",
            "customTabId": "sample string 23",
            "mergeField": {
              "configurationType": "sample string 1",
              "path": "sample string 2",
              "writeBack": "sample string 3",
              "allowSenderToEdit": "sample string 4",
              "row": "sample string 5"
            },
            "tabOrder": "sample string 24"
          }
        ],
        "initialHereTabs": [
          {
            "name": "sample string 1",
            "tabLabel": "sample string 2",
            "scaleValue": 1.1,
            "optional": "sample string 3",
            "documentId": "sample string 4",
            "recipientId": "sample string 5",
            "pageNumber": "sample string 6",
            "xPosition": "sample string 7",
            "yPosition": "sample string 8",
            "anchorString": "sample string 9",
            "anchorXOffset": "sample string 10",
            "anchorYOffset": "sample string 11",
            "anchorUnits": "sample string 12",
            "anchorIgnoreIfNotPresent": "sample string 13",
            "anchorCaseSensitive": "sample string 14",
            "anchorMatchWholeWord": "sample string 15",
            "anchorHorizontalAlignment": "sample string 16",
            "tabId": "sample string 17",
            "templateLocked": "sample string 18",
            "templateRequired": "sample string 19",
            "conditionalParentLabel": "sample string 20",
            "conditionalParentValue": "sample string 21",
            "customTabId": "sample string 22",
            "mergeField": {},
            "tabOrder": "sample string 23"
          }
        ],
        "signerAttachmentTabs": [
          {
            "name": "sample string 1",
            "tabLabel": "sample string 2",
            "scaleValue": 1.1,
            "optional": "sample string 3",
            "documentId": "sample string 4",
            "recipientId": "sample string 5",
            "pageNumber": "sample string 6",
            "xPosition": "sample string 7",
            "yPosition": "sample string 8",
            "anchorString": "sample string 9",
            "anchorXOffset": "sample string 10",
            "anchorYOffset": "sample string 11",
            "anchorUnits": "sample string 12",
            "anchorIgnoreIfNotPresent": "sample string 13",
            "anchorCaseSensitive": "sample string 14",
            "anchorMatchWholeWord": "sample string 15",
            "anchorHorizontalAlignment": "sample string 16",
            "tabId": "sample string 17",
            "templateLocked": "sample string 18",
            "templateRequired": "sample string 19",
            "conditionalParentLabel": "sample string 20",
            "conditionalParentValue": "sample string 21",
            "customTabId": "sample string 22",
            "mergeField": {},
            "tabOrder": "sample string 23"
          }
        ],
        "approveTabs": [
          {
            "buttonText": "sample string 1",
            "width": 2,
            "height": 3,
            "tabLabel": "sample string 4",
            "font": "sample string 5",
            "bold": "sample string 6",
            "italic": "sample string 7",
            "underline": "sample string 8",
            "fontColor": "sample string 9",
            "fontSize": "sample string 10",
            "documentId": "sample string 11",
            "recipientId": "sample string 12",
            "pageNumber": "sample string 13",
            "xPosition": "sample string 14",
            "yPosition": "sample string 15",
            "anchorString": "sample string 16",
            "anchorXOffset": "sample string 17",
            "anchorYOffset": "sample string 18",
            "anchorUnits": "sample string 19",
            "anchorIgnoreIfNotPresent": "sample string 20",
            "anchorCaseSensitive": "sample string 21",
            "anchorMatchWholeWord": "sample string 22",
            "anchorHorizontalAlignment": "sample string 23",
            "tabId": "sample string 24",
            "templateLocked": "sample string 25",
            "templateRequired": "sample string 26",
            "conditionalParentLabel": "sample string 27",
            "conditionalParentValue": "sample string 28",
            "customTabId": "sample string 29",
            "mergeField": {},
            "tabOrder": "sample string 30"
          }
        ],
        "declineTabs": [
          {
            "buttonText": "sample string 1",
            "width": 2,
            "height": 3,
            "declineReason": "sample string 4",
            "tabLabel": "sample string 5",
            "font": "sample string 6",
            "bold": "sample string 7",
            "italic": "sample string 8",
            "underline": "sample string 9",
            "fontColor": "sample string 10",
            "fontSize": "sample string 11",
            "documentId": "sample string 12",
            "recipientId": "sample string 13",
            "pageNumber": "sample string 14",
            "xPosition": "sample string 15",
            "yPosition": "sample string 16",
            "anchorString": "sample string 17",
            "anchorXOffset": "sample string 18",
            "anchorYOffset": "sample string 19",
            "anchorUnits": "sample string 20",
            "anchorIgnoreIfNotPresent": "sample string 21",
            "anchorCaseSensitive": "sample string 22",
            "anchorMatchWholeWord": "sample string 23",
            "anchorHorizontalAlignment": "sample string 24",
            "tabId": "sample string 25",
            "templateLocked": "sample string 26",
            "templateRequired": "sample string 27",
            "conditionalParentLabel": "sample string 28",
            "conditionalParentValue": "sample string 29",
            "customTabId": "sample string 30",
            "mergeField": {},
            "tabOrder": "sample string 31"
          }
        ],
        "viewTabs": [
          {
            "buttonText": "sample string 1",
            "width": 2,
            "height": 3,
            "required": "sample string 4",
            "requiredRead": "sample string 5",
            "tabLabel": "sample string 6",
            "font": "sample string 7",
            "bold": "sample string 8",
            "italic": "sample string 9",
            "underline": "sample string 10",
            "fontColor": "sample string 11",
            "fontSize": "sample string 12",
            "documentId": "sample string 13",
            "recipientId": "sample string 14",
            "pageNumber": "sample string 15",
            "xPosition": "sample string 16",
            "yPosition": "sample string 17",
            "anchorString": "sample string 18",
            "anchorXOffset": "sample string 19",
            "anchorYOffset": "sample string 20",
            "anchorUnits": "sample string 21",
            "anchorIgnoreIfNotPresent": "sample string 22",
            "anchorCaseSensitive": "sample string 23",
            "anchorMatchWholeWord": "sample string 24",
            "anchorHorizontalAlignment": "sample string 25",
            "tabId": "sample string 26",
            "templateLocked": "sample string 27",
            "templateRequired": "sample string 28",
            "conditionalParentLabel": "sample string 29",
            "conditionalParentValue": "sample string 30",
            "customTabId": "sample string 31",
            "mergeField": {},
            "tabOrder": "sample string 32"
          }
        ],
        "fullNameTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "tabLabel": "sample string 3",
            "font": "sample string 4",
            "bold": "sample string 5",
            "italic": "sample string 6",
            "underline": "sample string 7",
            "fontColor": "sample string 8",
            "fontSize": "sample string 9",
            "documentId": "sample string 10",
            "recipientId": "sample string 11",
            "pageNumber": "sample string 12",
            "xPosition": "sample string 13",
            "yPosition": "sample string 14",
            "anchorString": "sample string 15",
            "anchorXOffset": "sample string 16",
            "anchorYOffset": "sample string 17",
            "anchorUnits": "sample string 18",
            "anchorIgnoreIfNotPresent": "sample string 19",
            "anchorCaseSensitive": "sample string 20",
            "anchorMatchWholeWord": "sample string 21",
            "anchorHorizontalAlignment": "sample string 22",
            "tabId": "sample string 23",
            "templateLocked": "sample string 24",
            "templateRequired": "sample string 25",
            "conditionalParentLabel": "sample string 26",
            "conditionalParentValue": "sample string 27",
            "customTabId": "sample string 28",
            "mergeField": {},
            "tabOrder": "sample string 29"
          }
        ],
        "dateSignedTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "tabLabel": "sample string 3",
            "font": "sample string 4",
            "bold": "sample string 5",
            "italic": "sample string 6",
            "underline": "sample string 7",
            "fontColor": "sample string 8",
            "fontSize": "sample string 9",
            "documentId": "sample string 10",
            "recipientId": "sample string 11",
            "pageNumber": "sample string 12",
            "xPosition": "sample string 13",
            "yPosition": "sample string 14",
            "anchorString": "sample string 15",
            "anchorXOffset": "sample string 16",
            "anchorYOffset": "sample string 17",
            "anchorUnits": "sample string 18",
            "anchorIgnoreIfNotPresent": "sample string 19",
            "anchorCaseSensitive": "sample string 20",
            "anchorMatchWholeWord": "sample string 21",
            "anchorHorizontalAlignment": "sample string 22",
            "tabId": "sample string 23",
            "templateLocked": "sample string 24",
            "templateRequired": "sample string 25",
            "conditionalParentLabel": "sample string 26",
            "conditionalParentValue": "sample string 27",
            "customTabId": "sample string 28",
            "mergeField": {},
            "tabOrder": "sample string 29"
          }
        ],
        "envelopeIdTabs": [
          {
            "name": "sample string 1",
            "tabLabel": "sample string 2",
            "font": "sample string 3",
            "bold": "sample string 4",
            "italic": "sample string 5",
            "underline": "sample string 6",
            "fontColor": "sample string 7",
            "fontSize": "sample string 8",
            "documentId": "sample string 9",
            "recipientId": "sample string 10",
            "pageNumber": "sample string 11",
            "xPosition": "sample string 12",
            "yPosition": "sample string 13",
            "anchorString": "sample string 14",
            "anchorXOffset": "sample string 15",
            "anchorYOffset": "sample string 16",
            "anchorUnits": "sample string 17",
            "anchorIgnoreIfNotPresent": "sample string 18",
            "anchorCaseSensitive": "sample string 19",
            "anchorMatchWholeWord": "sample string 20",
            "anchorHorizontalAlignment": "sample string 21",
            "tabId": "sample string 22",
            "templateLocked": "sample string 23",
            "templateRequired": "sample string 24",
            "conditionalParentLabel": "sample string 25",
            "conditionalParentValue": "sample string 26",
            "customTabId": "sample string 27",
            "mergeField": {},
            "tabOrder": "sample string 28"
          }
        ],
        "companyTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "originalValue": "sample string 3",
            "width": 4,
            "required": "sample string 5",
            "locked": "sample string 6",
            "concealValueOnDocument": "sample string 7",
            "disableAutoSize": "sample string 8",
            "maxLength": 9,
            "tabLabel": "sample string 10",
            "font": "sample string 11",
            "bold": "sample string 12",
            "italic": "sample string 13",
            "underline": "sample string 14",
            "fontColor": "sample string 15",
            "fontSize": "sample string 16",
            "documentId": "sample string 17",
            "recipientId": "sample string 18",
            "pageNumber": "sample string 19",
            "xPosition": "sample string 20",
            "yPosition": "sample string 21",
            "anchorString": "sample string 22",
            "anchorXOffset": "sample string 23",
            "anchorYOffset": "sample string 24",
            "anchorUnits": "sample string 25",
            "anchorIgnoreIfNotPresent": "sample string 26",
            "anchorCaseSensitive": "sample string 27",
            "anchorMatchWholeWord": "sample string 28",
            "anchorHorizontalAlignment": "sample string 29",
            "tabId": "sample string 30",
            "templateLocked": "sample string 31",
            "templateRequired": "sample string 32",
            "conditionalParentLabel": "sample string 33",
            "conditionalParentValue": "sample string 34",
            "customTabId": "sample string 35",
            "mergeField": {},
            "tabOrder": "sample string 36"
          }
        ],
        "titleTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "originalValue": "sample string 3",
            "width": 4,
            "required": "sample string 5",
            "locked": "sample string 6",
            "concealValueOnDocument": "sample string 7",
            "disableAutoSize": "sample string 8",
            "maxLength": 9,
            "tabLabel": "sample string 10",
            "font": "sample string 11",
            "bold": "sample string 12",
            "italic": "sample string 13",
            "underline": "sample string 14",
            "fontColor": "sample string 15",
            "fontSize": "sample string 16",
            "documentId": "sample string 17",
            "recipientId": "sample string 18",
            "pageNumber": "sample string 19",
            "xPosition": "sample string 20",
            "yPosition": "sample string 21",
            "anchorString": "sample string 22",
            "anchorXOffset": "sample string 23",
            "anchorYOffset": "sample string 24",
            "anchorUnits": "sample string 25",
            "anchorIgnoreIfNotPresent": "sample string 26",
            "anchorCaseSensitive": "sample string 27",
            "anchorMatchWholeWord": "sample string 28",
            "anchorHorizontalAlignment": "sample string 29",
            "tabId": "sample string 30",
            "templateLocked": "sample string 31",
            "templateRequired": "sample string 32",
            "conditionalParentLabel": "sample string 33",
            "conditionalParentValue": "sample string 34",
            "customTabId": "sample string 35",
            "mergeField": {},
            "tabOrder": "sample string 36"
          }
        ],
        "textTabs": [
          {
            "height": 1,
            "isPaymentAmount": "sample string 2",
            "formula": "sample string 3",
            "validationPattern": "sample string 4",
            "validationMessage": "sample string 5",
            "shared": "sample string 6",
            "requireInitialOnSharedChange": "sample string 7",
            "senderRequired": "sample string 8",
            "requireAll": "sample string 9",
            "name": "sample string 10",
            "value": "sample string 11",
            "originalValue": "sample string 12",
            "width": 13,
            "required": "sample string 14",
            "locked": "sample string 15",
            "concealValueOnDocument": "sample string 16",
            "disableAutoSize": "sample string 17",
            "maxLength": 18,
            "tabLabel": "sample string 19",
            "font": "sample string 20",
            "bold": "sample string 21",
            "italic": "sample string 22",
            "underline": "sample string 23",
            "fontColor": "sample string 24",
            "fontSize": "sample string 25",
            "documentId": "sample string 26",
            "recipientId": "sample string 27",
            "pageNumber": "sample string 28",
            "xPosition": "sample string 29",
            "yPosition": "sample string 30",
            "anchorString": "sample string 31",
            "anchorXOffset": "sample string 32",
            "anchorYOffset": "sample string 33",
            "anchorUnits": "sample string 34",
            "anchorIgnoreIfNotPresent": "sample string 35",
            "anchorCaseSensitive": "sample string 36",
            "anchorMatchWholeWord": "sample string 37",
            "anchorHorizontalAlignment": "sample string 38",
            "tabId": "sample string 39",
            "templateLocked": "sample string 40",
            "templateRequired": "sample string 41",
            "conditionalParentLabel": "sample string 42",
            "conditionalParentValue": "sample string 43",
            "customTabId": "sample string 44",
            "mergeField": {},
            "tabOrder": "sample string 45"
          }
        ],
        "numberTabs": [
          {
            "isPaymentAmount": "sample string 1",
            "formula": "sample string 2",
            "validationPattern": "sample string 3",
            "validationMessage": "sample string 4",
            "shared": "sample string 5",
            "requireInitialOnSharedChange": "sample string 6",
            "senderRequired": "sample string 7",
            "requireAll": "sample string 8",
            "name": "sample string 9",
            "value": "sample string 10",
            "originalValue": "sample string 11",
            "width": 12,
            "required": "sample string 13",
            "locked": "sample string 14",
            "concealValueOnDocument": "sample string 15",
            "disableAutoSize": "sample string 16",
            "maxLength": 17,
            "tabLabel": "sample string 18",
            "font": "sample string 19",
            "bold": "sample string 20",
            "italic": "sample string 21",
            "underline": "sample string 22",
            "fontColor": "sample string 23",
            "fontSize": "sample string 24",
            "documentId": "sample string 25",
            "recipientId": "sample string 26",
            "pageNumber": "sample string 27",
            "xPosition": "sample string 28",
            "yPosition": "sample string 29",
            "anchorString": "sample string 30",
            "anchorXOffset": "sample string 31",
            "anchorYOffset": "sample string 32",
            "anchorUnits": "sample string 33",
            "anchorIgnoreIfNotPresent": "sample string 34",
            "anchorCaseSensitive": "sample string 35",
            "anchorMatchWholeWord": "sample string 36",
            "anchorHorizontalAlignment": "sample string 37",
            "tabId": "sample string 38",
            "templateLocked": "sample string 39",
            "templateRequired": "sample string 40",
            "conditionalParentLabel": "sample string 41",
            "conditionalParentValue": "sample string 42",
            "customTabId": "sample string 43",
            "mergeField": {},
            "tabOrder": "sample string 44"
          }
        ],
        "ssnTabs": [
          {
            "validationPattern": "sample string 1",
            "validationMessage": "sample string 2",
            "shared": "sample string 3",
            "requireInitialOnSharedChange": "sample string 4",
            "senderRequired": "sample string 5",
            "requireAll": "sample string 6",
            "name": "sample string 7",
            "value": "sample string 8",
            "originalValue": "sample string 9",
            "width": 10,
            "required": "sample string 11",
            "locked": "sample string 12",
            "concealValueOnDocument": "sample string 13",
            "disableAutoSize": "sample string 14",
            "maxLength": 15,
            "tabLabel": "sample string 16",
            "font": "sample string 17",
            "bold": "sample string 18",
            "italic": "sample string 19",
            "underline": "sample string 20",
            "fontColor": "sample string 21",
            "fontSize": "sample string 22",
            "documentId": "sample string 23",
            "recipientId": "sample string 24",
            "pageNumber": "sample string 25",
            "xPosition": "sample string 26",
            "yPosition": "sample string 27",
            "anchorString": "sample string 28",
            "anchorXOffset": "sample string 29",
            "anchorYOffset": "sample string 30",
            "anchorUnits": "sample string 31",
            "anchorIgnoreIfNotPresent": "sample string 32",
            "anchorCaseSensitive": "sample string 33",
            "anchorMatchWholeWord": "sample string 34",
            "anchorHorizontalAlignment": "sample string 35",
            "tabId": "sample string 36",
            "templateLocked": "sample string 37",
            "templateRequired": "sample string 38",
            "conditionalParentLabel": "sample string 39",
            "conditionalParentValue": "sample string 40",
            "customTabId": "sample string 41",
            "mergeField": {},
            "tabOrder": "sample string 42"
          }
        ],
        "dateTabs": [
          {
            "validationPattern": "sample string 1",
            "validationMessage": "sample string 2",
            "shared": "sample string 3",
            "requireInitialOnSharedChange": "sample string 4",
            "senderRequired": "sample string 5",
            "requireAll": "sample string 6",
            "name": "sample string 7",
            "value": "sample string 8",
            "originalValue": "sample string 9",
            "width": 10,
            "required": "sample string 11",
            "locked": "sample string 12",
            "concealValueOnDocument": "sample string 13",
            "disableAutoSize": "sample string 14",
            "maxLength": 15,
            "tabLabel": "sample string 16",
            "font": "sample string 17",
            "bold": "sample string 18",
            "italic": "sample string 19",
            "underline": "sample string 20",
            "fontColor": "sample string 21",
            "fontSize": "sample string 22",
            "documentId": "sample string 23",
            "recipientId": "sample string 24",
            "pageNumber": "sample string 25",
            "xPosition": "sample string 26",
            "yPosition": "sample string 27",
            "anchorString": "sample string 28",
            "anchorXOffset": "sample string 29",
            "anchorYOffset": "sample string 30",
            "anchorUnits": "sample string 31",
            "anchorIgnoreIfNotPresent": "sample string 32",
            "anchorCaseSensitive": "sample string 33",
            "anchorMatchWholeWord": "sample string 34",
            "anchorHorizontalAlignment": "sample string 35",
            "tabId": "sample string 36",
            "templateLocked": "sample string 37",
            "templateRequired": "sample string 38",
            "conditionalParentLabel": "sample string 39",
            "conditionalParentValue": "sample string 40",
            "customTabId": "sample string 41",
            "mergeField": {},
            "tabOrder": "sample string 42"
          }
        ],
        "zipTabs": [
          {
            "useDash4": "sample string 1",
            "validationPattern": "sample string 2",
            "validationMessage": "sample string 3",
            "shared": "sample string 4",
            "requireInitialOnSharedChange": "sample string 5",
            "senderRequired": "sample string 6",
            "requireAll": "sample string 7",
            "name": "sample string 8",
            "value": "sample string 9",
            "originalValue": "sample string 10",
            "width": 11,
            "required": "sample string 12",
            "locked": "sample string 13",
            "concealValueOnDocument": "sample string 14",
            "disableAutoSize": "sample string 15",
            "maxLength": 16,
            "tabLabel": "sample string 17",
            "font": "sample string 18",
            "bold": "sample string 19",
            "italic": "sample string 20",
            "underline": "sample string 21",
            "fontColor": "sample string 22",
            "fontSize": "sample string 23",
            "documentId": "sample string 24",
            "recipientId": "sample string 25",
            "pageNumber": "sample string 26",
            "xPosition": "sample string 27",
            "yPosition": "sample string 28",
            "anchorString": "sample string 29",
            "anchorXOffset": "sample string 30",
            "anchorYOffset": "sample string 31",
            "anchorUnits": "sample string 32",
            "anchorIgnoreIfNotPresent": "sample string 33",
            "anchorCaseSensitive": "sample string 34",
            "anchorMatchWholeWord": "sample string 35",
            "anchorHorizontalAlignment": "sample string 36",
            "tabId": "sample string 37",
            "templateLocked": "sample string 38",
            "templateRequired": "sample string 39",
            "conditionalParentLabel": "sample string 40",
            "conditionalParentValue": "sample string 41",
            "customTabId": "sample string 42",
            "mergeField": {},
            "tabOrder": "sample string 43"
          }
        ],
        "emailTabs": [
          {
            "validationPattern": "sample string 1",
            "validationMessage": "sample string 2",
            "shared": "sample string 3",
            "requireInitialOnSharedChange": "sample string 4",
            "senderRequired": "sample string 5",
            "requireAll": "sample string 6",
            "name": "sample string 7",
            "value": "sample string 8",
            "originalValue": "sample string 9",
            "width": 10,
            "required": "sample string 11",
            "locked": "sample string 12",
            "concealValueOnDocument": "sample string 13",
            "disableAutoSize": "sample string 14",
            "maxLength": 15,
            "tabLabel": "sample string 16",
            "font": "sample string 17",
            "bold": "sample string 18",
            "italic": "sample string 19",
            "underline": "sample string 20",
            "fontColor": "sample string 21",
            "fontSize": "sample string 22",
            "documentId": "sample string 23",
            "recipientId": "sample string 24",
            "pageNumber": "sample string 25",
            "xPosition": "sample string 26",
            "yPosition": "sample string 27",
            "anchorString": "sample string 28",
            "anchorXOffset": "sample string 29",
            "anchorYOffset": "sample string 30",
            "anchorUnits": "sample string 31",
            "anchorIgnoreIfNotPresent": "sample string 32",
            "anchorCaseSensitive": "sample string 33",
            "anchorMatchWholeWord": "sample string 34",
            "anchorHorizontalAlignment": "sample string 35",
            "tabId": "sample string 36",
            "templateLocked": "sample string 37",
            "templateRequired": "sample string 38",
            "conditionalParentLabel": "sample string 39",
            "conditionalParentValue": "sample string 40",
            "customTabId": "sample string 41",
            "mergeField": {},
            "tabOrder": "sample string 42"
          }
        ],
        "noteTabs": [
          {
            "width": 1,
            "height": 2,
            "shared": "sample string 3",
            "value": "sample string 4",
            "name": "sample string 5",
            "tabLabel": "sample string 6",
            "font": "sample string 7",
            "bold": "sample string 8",
            "italic": "sample string 9",
            "underline": "sample string 10",
            "fontColor": "sample string 11",
            "fontSize": "sample string 12",
            "documentId": "sample string 13",
            "recipientId": "sample string 14",
            "pageNumber": "sample string 15",
            "xPosition": "sample string 16",
            "yPosition": "sample string 17",
            "anchorString": "sample string 18",
            "anchorXOffset": "sample string 19",
            "anchorYOffset": "sample string 20",
            "anchorUnits": "sample string 21",
            "anchorIgnoreIfNotPresent": "sample string 22",
            "anchorCaseSensitive": "sample string 23",
            "anchorMatchWholeWord": "sample string 24",
            "anchorHorizontalAlignment": "sample string 25",
            "tabId": "sample string 26",
            "templateLocked": "sample string 27",
            "templateRequired": "sample string 28",
            "conditionalParentLabel": "sample string 29",
            "conditionalParentValue": "sample string 30",
            "customTabId": "sample string 31",
            "mergeField": {},
            "tabOrder": "sample string 32"
          }
        ],
        "checkboxTabs": [
          {
            "name": "sample string 1",
            "tabLabel": "sample string 2",
            "selected": "sample string 3",
            "shared": "sample string 4",
            "requireInitialOnSharedChange": "sample string 5",
            "required": "sample string 6",
            "locked": "sample string 7",
            "documentId": "sample string 8",
            "recipientId": "sample string 9",
            "pageNumber": "sample string 10",
            "xPosition": "sample string 11",
            "yPosition": "sample string 12",
            "anchorString": "sample string 13",
            "anchorXOffset": "sample string 14",
            "anchorYOffset": "sample string 15",
            "anchorUnits": "sample string 16",
            "anchorIgnoreIfNotPresent": "sample string 17",
            "anchorCaseSensitive": "sample string 18",
            "anchorMatchWholeWord": "sample string 19",
            "anchorHorizontalAlignment": "sample string 20",
            "tabId": "sample string 21",
            "templateLocked": "sample string 22",
            "templateRequired": "sample string 23",
            "conditionalParentLabel": "sample string 24",
            "conditionalParentValue": "sample string 25",
            "customTabId": "sample string 26",
            "mergeField": {},
            "tabOrder": "sample string 27"
          }
        ],
        "radioGroupTabs": [
          {
            "documentId": "sample string 1",
            "recipientId": "sample string 2",
            "templateLocked": "sample string 3",
            "templateRequired": "sample string 4",
            "conditionalParentLabel": "sample string 5",
            "conditionalParentValue": "sample string 6",
            "groupName": "sample string 7",
            "radios": [
              {
                "pageNumber": "sample string 1",
                "xPosition": "sample string 2",
                "yPosition": "sample string 3",
                "anchorString": "sample string 4",
                "anchorXOffset": "sample string 5",
                "anchorYOffset": "sample string 6",
                "anchorUnits": "sample string 7",
                "anchorIgnoreIfNotPresent": "sample string 8",
                "anchorCaseSensitive": "sample string 9",
                "anchorMatchWholeWord": "sample string 10",
                "anchorHorizontalAlignment": "sample string 11",
                "value": "sample string 12",
                "selected": "sample string 13",
                "tabId": "sample string 14",
                "required": "sample string 15",
                "locked": "sample string 16",
                "tabOrder": "sample string 17"
              }
            ],
            "shared": "sample string 8",
            "requireInitialOnSharedChange": "sample string 9",
            "requireAll": "sample string 10"
          }
        ],
        "listTabs": [
          {
            "listItems": [
              {
                "text": "sample string 1",
                "value": "sample string 2",
                "selected": "sample string 3"
              }
            ],
            "value": "sample string 1",
            "width": 2,
            "shared": "sample string 3",
            "requireInitialOnSharedChange": "sample string 4",
            "required": "sample string 5",
            "locked": "sample string 6",
            "senderRequired": "sample string 7",
            "requireAll": "sample string 8",
            "tabLabel": "sample string 9",
            "font": "sample string 10",
            "bold": "sample string 11",
            "italic": "sample string 12",
            "underline": "sample string 13",
            "fontColor": "sample string 14",
            "fontSize": "sample string 15",
            "documentId": "sample string 16",
            "recipientId": "sample string 17",
            "pageNumber": "sample string 18",
            "xPosition": "sample string 19",
            "yPosition": "sample string 20",
            "anchorString": "sample string 21",
            "anchorXOffset": "sample string 22",
            "anchorYOffset": "sample string 23",
            "anchorUnits": "sample string 24",
            "anchorIgnoreIfNotPresent": "sample string 25",
            "anchorCaseSensitive": "sample string 26",
            "anchorMatchWholeWord": "sample string 27",
            "anchorHorizontalAlignment": "sample string 28",
            "tabId": "sample string 29",
            "templateLocked": "sample string 30",
            "templateRequired": "sample string 31",
            "conditionalParentLabel": "sample string 32",
            "conditionalParentValue": "sample string 33",
            "customTabId": "sample string 34",
            "mergeField": {},
            "tabOrder": "sample string 35"
          }
        ],
        "firstNameTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "tabLabel": "sample string 3",
            "font": "sample string 4",
            "bold": "sample string 5",
            "italic": "sample string 6",
            "underline": "sample string 7",
            "fontColor": "sample string 8",
            "fontSize": "sample string 9",
            "documentId": "sample string 10",
            "recipientId": "sample string 11",
            "pageNumber": "sample string 12",
            "xPosition": "sample string 13",
            "yPosition": "sample string 14",
            "anchorString": "sample string 15",
            "anchorXOffset": "sample string 16",
            "anchorYOffset": "sample string 17",
            "anchorUnits": "sample string 18",
            "anchorIgnoreIfNotPresent": "sample string 19",
            "anchorCaseSensitive": "sample string 20",
            "anchorMatchWholeWord": "sample string 21",
            "anchorHorizontalAlignment": "sample string 22",
            "tabId": "sample string 23",
            "templateLocked": "sample string 24",
            "templateRequired": "sample string 25",
            "conditionalParentLabel": "sample string 26",
            "conditionalParentValue": "sample string 27",
            "customTabId": "sample string 28",
            "mergeField": {},
            "tabOrder": "sample string 29"
          }
        ],
        "lastNameTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "tabLabel": "sample string 3",
            "font": "sample string 4",
            "bold": "sample string 5",
            "italic": "sample string 6",
            "underline": "sample string 7",
            "fontColor": "sample string 8",
            "fontSize": "sample string 9",
            "documentId": "sample string 10",
            "recipientId": "sample string 11",
            "pageNumber": "sample string 12",
            "xPosition": "sample string 13",
            "yPosition": "sample string 14",
            "anchorString": "sample string 15",
            "anchorXOffset": "sample string 16",
            "anchorYOffset": "sample string 17",
            "anchorUnits": "sample string 18",
            "anchorIgnoreIfNotPresent": "sample string 19",
            "anchorCaseSensitive": "sample string 20",
            "anchorMatchWholeWord": "sample string 21",
            "anchorHorizontalAlignment": "sample string 22",
            "tabId": "sample string 23",
            "templateLocked": "sample string 24",
            "templateRequired": "sample string 25",
            "conditionalParentLabel": "sample string 26",
            "conditionalParentValue": "sample string 27",
            "customTabId": "sample string 28",
            "mergeField": {},
            "tabOrder": "sample string 29"
          }
        ],
        "emailAddressTabs": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "tabLabel": "sample string 3",
            "font": "sample string 4",
            "bold": "sample string 5",
            "italic": "sample string 6",
            "underline": "sample string 7",
            "fontColor": "sample string 8",
            "fontSize": "sample string 9",
            "documentId": "sample string 10",
            "recipientId": "sample string 11",
            "pageNumber": "sample string 12",
            "xPosition": "sample string 13",
            "yPosition": "sample string 14",
            "anchorString": "sample string 15",
            "anchorXOffset": "sample string 16",
            "anchorYOffset": "sample string 17",
            "anchorUnits": "sample string 18",
            "anchorIgnoreIfNotPresent": "sample string 19",
            "anchorCaseSensitive": "sample string 20",
            "anchorMatchWholeWord": "sample string 21",
            "anchorHorizontalAlignment": "sample string 22",
            "tabId": "sample string 23",
            "templateLocked": "sample string 24",
            "templateRequired": "sample string 25",
            "conditionalParentLabel": "sample string 26",
            "conditionalParentValue": "sample string 27",
            "customTabId": "sample string 28",
            "mergeField": {},
            "tabOrder": "sample string 29"
          }
        ],
        "formulaTabs": [
          {
            "isPaymentAmount": "sample string 1",
            "formula": "sample string 2",
            "roundDecimalPlaces": "sample string 3",
            "paymentDetails": {
              "total": {
                "amountInBaseUnit": "sample string 1",
                "currency": "sample string 2",
                "displayAmount": "sample string 3"
              },
              "status": "sample string 1",
              "currencyCode": "sample string 2",
              "lineItems": [
                {
                  "name": "sample string 1",
                  "description": "sample string 2",
                  "itemCode": "sample string 3",
                  "amountReference": "sample string 4"
                }
              ],
              "allowedPaymentMethods": [
                "sample string 1"
              ],
              "gatewayAccountId": "sample string 3",
              "gatewayName": "sample string 4",
              "gatewayDisplayName": "sample string 5",
              "chargeId": "sample string 6"
            },
            "hidden": "sample string 4",
            "validationPattern": "sample string 5",
            "validationMessage": "sample string 6",
            "shared": "sample string 7",
            "requireInitialOnSharedChange": "sample string 8",
            "senderRequired": "sample string 9",
            "requireAll": "sample string 10",
            "name": "sample string 11",
            "value": "sample string 12",
            "originalValue": "sample string 13",
            "width": 14,
            "required": "sample string 15",
            "locked": "sample string 16",
            "concealValueOnDocument": "sample string 17",
            "disableAutoSize": "sample string 18",
            "maxLength": 19,
            "tabLabel": "sample string 20",
            "font": "sample string 21",
            "bold": "sample string 22",
            "italic": "sample string 23",
            "underline": "sample string 24",
            "fontColor": "sample string 25",
            "fontSize": "sample string 26",
            "documentId": "sample string 27",
            "recipientId": "sample string 28",
            "pageNumber": "sample string 29",
            "xPosition": "sample string 30",
            "yPosition": "sample string 31",
            "anchorString": "sample string 32",
            "anchorXOffset": "sample string 33",
            "anchorYOffset": "sample string 34",
            "anchorUnits": "sample string 35",
            "anchorIgnoreIfNotPresent": "sample string 36",
            "anchorCaseSensitive": "sample string 37",
            "anchorMatchWholeWord": "sample string 38",
            "anchorHorizontalAlignment": "sample string 39",
            "tabId": "sample string 40",
            "templateLocked": "sample string 41",
            "templateRequired": "sample string 42",
            "conditionalParentLabel": "sample string 43",
            "conditionalParentValue": "sample string 44",
            "customTabId": "sample string 45",
            "mergeField": {},
            "tabOrder": "sample string 46"
          }
        ],
        "notarizeTabs": [
          {
            "required": "sample string 1",
            "locked": "sample string 2",
            "documentId": "sample string 3",
            "recipientId": "sample string 4",
            "pageNumber": "sample string 5",
            "xPosition": "sample string 6",
            "yPosition": "sample string 7",
            "anchorString": "sample string 8",
            "anchorXOffset": "sample string 9",
            "anchorYOffset": "sample string 10",
            "anchorUnits": "sample string 11",
            "anchorIgnoreIfNotPresent": "sample string 12",
            "anchorCaseSensitive": "sample string 13",
            "anchorMatchWholeWord": "sample string 14",
            "anchorHorizontalAlignment": "sample string 15",
            "tabId": "sample string 16",
            "templateLocked": "sample string 17",
            "templateRequired": "sample string 18",
            "conditionalParentLabel": "sample string 19",
            "conditionalParentValue": "sample string 20",
            "customTabId": "sample string 21",
            "mergeField": {},
            "tabOrder": "sample string 22"
          }
        ]
      },
      "recipientSignatureProviders": [
        {
          "sealName": "sample string 1",
          "sealDocumentsWithTabsOnly": "sample string 2",
          "signatureProviderName": "sample string 3",
          "signatureProviderOptions": {
            "sms": "sample string 1",
            "oneTimePassword": "sample string 2",
            "cpfNumber": "sample string 3",
            "signerRole": "sample string 4"
          }
        }
      ]
    }
  ],
  "compositeTemplates": [
    {
      "compositeTemplateId": "sample string 1",
      "serverTemplates": [
        {
          "sequence": "sample string 1",
          "templateId": "sample string 2"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "sample string 1",
          "envelope": {
            "transactionId": "sample string 1",
            "status": "sample string 2",
            "documentsUri": "sample string 3",
            "recipientsUri": "sample string 4",
            "attachmentsUri": "sample string 5",
            "asynchronous": "sample string 6",
            "envelopeUri": "sample string 7",
            "emailSubject": "sample string 8",
            "emailBlurb": "sample string 9",
            "envelopeId": "sample string 10",
            "signingLocation": "sample string 11",
            "customFieldsUri": "sample string 12",
            "customFields": {
              "textCustomFields": [
                {
                  "fieldId": "sample string 1",
                  "name": "sample string 2",
                  "show": "sample string 3",
                  "required": "sample string 4",
                  "value": "sample string 5",
                  "configurationType": "sample string 6"
                }
              ],
              "listCustomFields": [
                {
                  "listItems": [
                    "sample string 1"
                  ],
                  "fieldId": "sample string 1",
                  "name": "sample string 2",
                  "show": "sample string 3",
                  "required": "sample string 4",
                  "value": "sample string 5",
                  "configurationType": "sample string 6"
                }
              ]
            },
            "autoNavigation": "sample string 13",
            "envelopeIdStamping": "sample string 14",
            "authoritativeCopy": "sample string 15",
            "authoritativeCopyDefault": "sample string 16",
            "notification": {
              "useAccountDefaults": "sample string 1",
              "reminders": {
                "reminderEnabled": "sample string 1",
                "reminderDelay": "sample string 2",
                "reminderFrequency": "sample string 3"
              },
              "expirations": {
                "expireEnabled": "sample string 1",
                "expireAfter": "sample string 2",
                "expireWarn": "sample string 3"
              }
            },
            "notificationUri": "sample string 17",
            "enforceSignerVisibility": "sample string 18",
            "enableWetSign": "sample string 19",
            "allowMarkup": "sample string 20",
            "allowReassign": "sample string 21",
            "createdDateTime": "sample string 22",
            "lastModifiedDateTime": "sample string 23",
            "deliveredDateTime": "sample string 24",
            "initialSentDateTime": "sample string 25",
            "sentDateTime": "sample string 26",
            "completedDateTime": "sample string 27",
            "voidedDateTime": "sample string 28",
            "voidedReason": "sample string 29",
            "deletedDateTime": "sample string 30",
            "declinedDateTime": "sample string 31",
            "statusChangedDateTime": "sample string 32",
            "documentsCombinedUri": "sample string 33",
            "certificateUri": "sample string 34",
            "templatesUri": "sample string 35",
            "messageLock": "sample string 36",
            "recipientsLock": "sample string 37",
            "recipients": {
              "signers": [
                {
                  "signatureInfo": {
                    "signatureName": "sample string 1",
                    "signatureInitials": "sample string 2",
                    "fontStyle": "sample string 3"
                  },
                  "autoNavigation": "sample string 1",
                  "defaultRecipient": "sample string 2",
                  "tabs": {},
                  "signInEachLocation": "sample string 3",
                  "offlineAttributes": {
                    "deviceName": "sample string 1",
                    "deviceModel": "sample string 2",
                    "gpsLatitude": "sample string 3",
                    "gpsLongitude": "sample string 4",
                    "accountEsignId": "sample string 5",
                    "offlineSigningHash": "sample string 6"
                  },
                  "requireSignerCertificate": "sample string 4",
                  "requireSignOnPaper": "sample string 5",
                  "canSignOffline": "sample string 6",
                  "isBulkRecipient": "sample string 7",
                  "bulkRecipientsUri": "sample string 8",
                  "recipientSuppliesTabs": "sample string 9",
                  "recipientSignatureProviders": [
                    {}
                  ],
                  "agentCanEditEmail": "sample string 10",
                  "agentCanEditName": "sample string 11",
                  "excludedDocuments": [
                    "sample string 1"
                  ],
                  "name": "sample string 12",
                  "email": "sample string 13",
                  "emailRecipientPostSigningURL": "sample string 14",
                  "signingGroupId": "sample string 15",
                  "signingGroupName": "sample string 16",
                  "signingGroupUsers": [
                    {
                      "userName": "sample string 1",
                      "userId": "sample string 2",
                      "email": "sample string 3",
                      "userType": "sample string 4",
                      "userStatus": "sample string 5",
                      "uri": "sample string 6",
                      "loginStatus": "sample string 7",
                      "sendActivationEmail": "sample string 8",
                      "activationAccessCode": "sample string 9"
                    }
                  ],
                  "recipientId": "sample string 17",
                  "recipientIdGuid": "sample string 18",
                  "accessCode": "sample string 19",
                  "addAccessCodeToEmail": "sample string 20",
                  "requireIdLookup": "sample string 21",
                  "idCheckConfigurationName": "sample string 22",
                  "socialAuthentications": [
                    {
                      "authentication": "sample string 1"
                    }
                  ],
                  "phoneAuthentication": {
                    "recipMayProvideNumber": "sample string 1",
                    "validateRecipProvidedNumber": "sample string 2",
                    "recordVoicePrint": "sample string 3",
                    "senderProvidedNumbers": [
                      "sample string 1"
                    ]
                  },
                  "samlAuthentication": {
                    "samlAssertionAttributes": [
                      {
                        "name": "sample string 1",
                        "value": "sample string 2",
                        "originalValue": "sample string 3"
                      }
                    ]
                  },
                  "smsAuthentication": {
                    "senderProvidedNumbers": [
                      "sample string 1"
                    ]
                  },
                  "userId": "sample string 23",
                  "clientUserId": "sample string 24",
                  "embeddedRecipientStartURL": "sample string 25",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 26",
                  "idCheckInformationInput": {
                    "addressInformationInput": {
                      "addressInformation": {
                        "street1": "sample string 1",
                        "street2": "sample string 2",
                        "city": "sample string 3",
                        "state": "sample string 4",
                        "zip": "sample string 5",
                        "phone": "sample string 6",
                        "fax": "sample string 7",
                        "country": "sample string 8"
                      },
                      "displayLevelCode": "sample string 1",
                      "receiveInResponse": "sample string 2"
                    },
                    "dobInformationInput": {
                      "dateOfBirth": "sample string 1",
                      "displayLevelCode": "sample string 2",
                      "receiveInResponse": "sample string 3"
                    },
                    "ssn4InformationInput": {
                      "ssn4": "sample string 1",
                      "displayLevelCode": "sample string 2",
                      "receiveInResponse": "sample string 3"
                    },
                    "ssn9InformationInput": {
                      "ssn9": "sample string 1",
                      "displayLevelCode": "sample string 2"
                    }
                  },
                  "recipientAttachments": [
                    {
                      "attachmentId": "sample string 1",
                      "label": "sample string 2",
                      "attachmentType": "sample string 3",
                      "name": "sample string 4",
                      "data": "sample string 5",
                      "remoteUrl": "sample string 6"
                    }
                  ],
                  "note": "sample string 27",
                  "roleName": "sample string 28",
                  "status": "sample string 29",
                  "declinedReason": "sample string 30",
                  "deliveryMethod": "sample string 31",
                  "faxNumber": "sample string 32",
                  "templateLocked": "sample string 33",
                  "templateRequired": "sample string 34",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 35",
                  "documentVisibility": [
                    {
                      "recipientId": "sample string 1",
                      "documentId": "sample string 2",
                      "visible": "sample string 3",
                      "rights": "sample string 4"
                    }
                  ]
                }
              ],
              "agents": [
                {
                  "excludedDocuments": [
                    "sample string 1"
                  ],
                  "name": "sample string 1",
                  "email": "sample string 2",
                  "emailRecipientPostSigningURL": "sample string 3",
                  "signingGroupId": "sample string 4",
                  "signingGroupName": "sample string 5",
                  "signingGroupUsers": [
                    {}
                  ],
                  "recipientId": "sample string 6",
                  "recipientIdGuid": "sample string 7",
                  "accessCode": "sample string 8",
                  "addAccessCodeToEmail": "sample string 9",
                  "requireIdLookup": "sample string 10",
                  "idCheckConfigurationName": "sample string 11",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 12",
                  "clientUserId": "sample string 13",
                  "embeddedRecipientStartURL": "sample string 14",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 15",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 16",
                  "roleName": "sample string 17",
                  "status": "sample string 18",
                  "declinedReason": "sample string 19",
                  "deliveryMethod": "sample string 20",
                  "faxNumber": "sample string 21",
                  "templateLocked": "sample string 22",
                  "templateRequired": "sample string 23",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 24",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "editors": [
                {
                  "name": "sample string 1",
                  "email": "sample string 2",
                  "emailRecipientPostSigningURL": "sample string 3",
                  "signingGroupId": "sample string 4",
                  "signingGroupName": "sample string 5",
                  "signingGroupUsers": [
                    {}
                  ],
                  "recipientId": "sample string 6",
                  "recipientIdGuid": "sample string 7",
                  "accessCode": "sample string 8",
                  "addAccessCodeToEmail": "sample string 9",
                  "requireIdLookup": "sample string 10",
                  "idCheckConfigurationName": "sample string 11",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 12",
                  "clientUserId": "sample string 13",
                  "embeddedRecipientStartURL": "sample string 14",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 15",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 16",
                  "roleName": "sample string 17",
                  "status": "sample string 18",
                  "declinedReason": "sample string 19",
                  "deliveryMethod": "sample string 20",
                  "faxNumber": "sample string 21",
                  "templateLocked": "sample string 22",
                  "templateRequired": "sample string 23",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 24",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "intermediaries": [
                {
                  "excludedDocuments": [
                    "sample string 1"
                  ],
                  "name": "sample string 1",
                  "email": "sample string 2",
                  "emailRecipientPostSigningURL": "sample string 3",
                  "signingGroupId": "sample string 4",
                  "signingGroupName": "sample string 5",
                  "signingGroupUsers": [
                    {}
                  ],
                  "recipientId": "sample string 6",
                  "recipientIdGuid": "sample string 7",
                  "accessCode": "sample string 8",
                  "addAccessCodeToEmail": "sample string 9",
                  "requireIdLookup": "sample string 10",
                  "idCheckConfigurationName": "sample string 11",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 12",
                  "clientUserId": "sample string 13",
                  "embeddedRecipientStartURL": "sample string 14",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 15",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 16",
                  "roleName": "sample string 17",
                  "status": "sample string 18",
                  "declinedReason": "sample string 19",
                  "deliveryMethod": "sample string 20",
                  "faxNumber": "sample string 21",
                  "templateLocked": "sample string 22",
                  "templateRequired": "sample string 23",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 24",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "carbonCopies": [
                {
                  "agentCanEditEmail": "sample string 1",
                  "agentCanEditName": "sample string 2",
                  "excludedDocuments": [
                    "sample string 1"
                  ],
                  "name": "sample string 3",
                  "email": "sample string 4",
                  "emailRecipientPostSigningURL": "sample string 5",
                  "signingGroupId": "sample string 6",
                  "signingGroupName": "sample string 7",
                  "signingGroupUsers": [
                    {}
                  ],
                  "recipientId": "sample string 8",
                  "recipientIdGuid": "sample string 9",
                  "accessCode": "sample string 10",
                  "addAccessCodeToEmail": "sample string 11",
                  "requireIdLookup": "sample string 12",
                  "idCheckConfigurationName": "sample string 13",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 14",
                  "clientUserId": "sample string 15",
                  "embeddedRecipientStartURL": "sample string 16",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 17",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 18",
                  "roleName": "sample string 19",
                  "status": "sample string 20",
                  "declinedReason": "sample string 21",
                  "deliveryMethod": "sample string 22",
                  "faxNumber": "sample string 23",
                  "templateLocked": "sample string 24",
                  "templateRequired": "sample string 25",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 26",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "certifiedDeliveries": [
                {
                  "agentCanEditEmail": "sample string 1",
                  "agentCanEditName": "sample string 2",
                  "excludedDocuments": [
                    "sample string 1"
                  ],
                  "name": "sample string 3",
                  "email": "sample string 4",
                  "emailRecipientPostSigningURL": "sample string 5",
                  "signingGroupId": "sample string 6",
                  "signingGroupName": "sample string 7",
                  "signingGroupUsers": [
                    {}
                  ],
                  "recipientId": "sample string 8",
                  "recipientIdGuid": "sample string 9",
                  "accessCode": "sample string 10",
                  "addAccessCodeToEmail": "sample string 11",
                  "requireIdLookup": "sample string 12",
                  "idCheckConfigurationName": "sample string 13",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 14",
                  "clientUserId": "sample string 15",
                  "embeddedRecipientStartURL": "sample string 16",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 17",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 18",
                  "roleName": "sample string 19",
                  "status": "sample string 20",
                  "declinedReason": "sample string 21",
                  "deliveryMethod": "sample string 22",
                  "faxNumber": "sample string 23",
                  "templateLocked": "sample string 24",
                  "templateRequired": "sample string 25",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 26",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "inPersonSigners": [
                {
                  "hostName": "sample string 1",
                  "hostEmail": "sample string 2",
                  "signerName": "sample string 3",
                  "signerEmail": "sample string 4",
                  "signatureInfo": {},
                  "autoNavigation": "sample string 5",
                  "defaultRecipient": "sample string 6",
                  "offlineAttributes": {},
                  "tabs": {},
                  "signInEachLocation": "sample string 7",
                  "requireSignerCertificate": "sample string 8",
                  "requireSignOnPaper": "sample string 9",
                  "canSignOffline": "sample string 10",
                  "recipientSuppliesTabs": "sample string 11",
                  "signingGroupId": "sample string 12",
                  "signingGroupName": "sample string 13",
                  "signingGroupUsers": [
                    {}
                  ],
                  "recipientSignatureProviders": [
                    {}
                  ],
                  "excludedDocuments": [
                    "sample string 1"
                  ],
                  "notaryHost": {
                    "name": "sample string 1",
                    "email": "sample string 2",
                    "hostRecipientId": "sample string 3",
                    "tabs": {},
                    "recipientId": "sample string 4",
                    "recipientIdGuid": "sample string 5",
                    "accessCode": "sample string 6",
                    "addAccessCodeToEmail": "sample string 7",
                    "requireIdLookup": "sample string 8",
                    "idCheckConfigurationName": "sample string 9",
                    "socialAuthentications": [
                      {}
                    ],
                    "phoneAuthentication": {},
                    "samlAuthentication": {},
                    "smsAuthentication": {},
                    "userId": "sample string 10",
                    "clientUserId": "sample string 11",
                    "embeddedRecipientStartURL": "sample string 12",
                    "customFields": [
                      "sample string 1"
                    ],
                    "routingOrder": "sample string 13",
                    "idCheckInformationInput": {},
                    "recipientAttachments": [
                      {}
                    ],
                    "note": "sample string 14",
                    "roleName": "sample string 15",
                    "status": "sample string 16",
                    "declinedReason": "sample string 17",
                    "deliveryMethod": "sample string 18",
                    "faxNumber": "sample string 19",
                    "templateLocked": "sample string 20",
                    "templateRequired": "sample string 21",
                    "emailNotification": {},
                    "inheritEmailNotificationConfiguration": "sample string 22",
                    "documentVisibility": [
                      {}
                    ]
                  },
                  "inPersonSigningType": "sample string 14",
                  "name": "sample string 15",
                  "email": "sample string 16",
                  "recipientId": "sample string 17",
                  "recipientIdGuid": "sample string 18",
                  "accessCode": "sample string 19",
                  "addAccessCodeToEmail": "sample string 20",
                  "requireIdLookup": "sample string 21",
                  "idCheckConfigurationName": "sample string 22",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 23",
                  "clientUserId": "sample string 24",
                  "embeddedRecipientStartURL": "sample string 25",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 26",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 27",
                  "roleName": "sample string 28",
                  "status": "sample string 29",
                  "declinedReason": "sample string 30",
                  "deliveryMethod": "sample string 31",
                  "faxNumber": "sample string 32",
                  "templateLocked": "sample string 33",
                  "templateRequired": "sample string 34",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 35",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "seals": [
                {
                  "name": "sample string 1",
                  "recipientSignatureProviders": [
                    {}
                  ],
                  "tabs": {},
                  "recipientId": "sample string 2",
                  "recipientIdGuid": "sample string 3",
                  "accessCode": "sample string 4",
                  "addAccessCodeToEmail": "sample string 5",
                  "requireIdLookup": "sample string 6",
                  "idCheckConfigurationName": "sample string 7",
                  "socialAuthentications": [
                    {}
                  ],
                  "phoneAuthentication": {},
                  "samlAuthentication": {},
                  "smsAuthentication": {},
                  "userId": "sample string 8",
                  "clientUserId": "sample string 9",
                  "embeddedRecipientStartURL": "sample string 10",
                  "customFields": [
                    "sample string 1"
                  ],
                  "routingOrder": "sample string 11",
                  "idCheckInformationInput": {},
                  "recipientAttachments": [
                    {}
                  ],
                  "note": "sample string 12",
                  "roleName": "sample string 13",
                  "status": "sample string 14",
                  "declinedReason": "sample string 15",
                  "deliveryMethod": "sample string 16",
                  "faxNumber": "sample string 17",
                  "templateLocked": "sample string 18",
                  "templateRequired": "sample string 19",
                  "emailNotification": {},
                  "inheritEmailNotificationConfiguration": "sample string 20",
                  "documentVisibility": [
                    {}
                  ]
                }
              ],
              "recipientCount": "sample string 1",
              "currentRoutingOrder": "sample string 2"
            },
            "brandLock": "sample string 38",
            "brandId": "sample string 39",
            "useDisclosure": "sample string 40",
            "emailSettings": {
              "replyEmailAddressOverride": "sample string 1",
              "replyEmailNameOverride": "sample string 2",
              "bccEmailAddresses": [
                {
                  "bccEmailAddressId": "sample string 1",
                  "email": "sample string 2"
                }
              ]
            },
            "purgeState": "sample string 41",
            "lockInformation": {
              "lockedByUser": {},
              "lockedByApp": "sample string 1",
              "lockedUntilDateTime": "sample string 2",
              "lockDurationInSeconds": "sample string 3",
              "lockType": "sample string 4",
              "useScratchPad": "sample string 5",
              "lockToken": "sample string 6",
              "errorDetails": {
                "errorCode": "sample string 1",
                "message": "sample string 2"
              }
            },
            "is21CFRPart11": "sample string 42"
          },
          "documents": [
            {}
          ],
          "recipients": {},
          "customFields": {}
        }
      ],
      "pdfMetaDataTemplateSequence": "sample string 2",
      "document": {}
    }
  ],
  "accessibility": "sample string 4",
  "transactionId": "sample string 5",
  "status": "sample string 6",
  "documentsUri": "sample string 7",
  "recipientsUri": "sample string 8",
  "attachmentsUri": "sample string 9",
  "asynchronous": "sample string 10",
  "envelopeUri": "sample string 11",
  "emailSubject": "sample string 12",
  "emailBlurb": "sample string 13",
  "envelopeId": "sample string 14",
  "signingLocation": "sample string 15",
  "customFieldsUri": "sample string 16",
  "customFields": {},
  "autoNavigation": "sample string 17",
  "envelopeIdStamping": "sample string 18",
  "authoritativeCopy": "sample string 19",
  "authoritativeCopyDefault": "sample string 20",
  "notification": {},
  "notificationUri": "sample string 21",
  "enforceSignerVisibility": "sample string 22",
  "enableWetSign": "sample string 23",
  "allowMarkup": "sample string 24",
  "allowReassign": "sample string 25",
  "createdDateTime": "sample string 26",
  "lastModifiedDateTime": "sample string 27",
  "deliveredDateTime": "sample string 28",
  "initialSentDateTime": "sample string 29",
  "sentDateTime": "sample string 30",
  "completedDateTime": "sample string 31",
  "voidedDateTime": "sample string 32",
  "voidedReason": "sample string 33",
  "deletedDateTime": "sample string 34",
  "declinedDateTime": "sample string 35",
  "statusChangedDateTime": "sample string 36",
  "documentsCombinedUri": "sample string 37",
  "certificateUri": "sample string 38",
  "templatesUri": "sample string 39",
  "messageLock": "sample string 40",
  "recipientsLock": "sample string 41",
  "recipients": {},
  "brandLock": "sample string 42",
  "brandId": "sample string 43",
  "useDisclosure": "sample string 44",
  "emailSettings": {},
  "purgeState": "sample string 45",
  "lockInformation": {},
  "is21CFRPart11": "sample string 46"
}
Response
{
  "envelopeId": "sample string 1",
  "envelopeDocuments": [
    {
      "documentId": "sample string 1",
      "name": "sample string 2",
      "type": "sample string 3",
      "uri": "sample string 4",
      "order": "sample string 5",
      "pages": "sample string 6",
      "containsPdfFormFields": "sample string 7",
      "documentFields": [
        {}
      ],
      "availableDocumentTypes": [
        {
          "type": "sample string 1",
          "isDefault": "sample string 2"
        }
      ],
      "attachmentTabId": "sample string 8",
      "display": "sample string 9",
      "includeInDownload": "sample string 10",
      "signerMustAcknowledge": "sample string 11",
      "documentGroup": "sample string 12",
      "authoritativeCopy": "sample string 13",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Request/Response

Request
<envelopeDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <allowMarkup>sample string 24</allowMarkup>
  <allowReassign>sample string 25</allowReassign>
  <asynchronous>sample string 10</asynchronous>
  <attachmentsUri>sample string 9</attachmentsUri>
  <authoritativeCopy>sample string 19</authoritativeCopy>
  <authoritativeCopyDefault>sample string 20</authoritativeCopyDefault>
  <autoNavigation>sample string 17</autoNavigation>
  <brandId>sample string 43</brandId>
  <brandLock>sample string 42</brandLock>
  <certificateUri>sample string 38</certificateUri>
  <completedDateTime>sample string 31</completedDateTime>
  <createdDateTime>sample string 26</createdDateTime>
  <customFields />
  <customFieldsUri>sample string 16</customFieldsUri>
  <declinedDateTime>sample string 35</declinedDateTime>
  <deletedDateTime>sample string 34</deletedDateTime>
  <deliveredDateTime>sample string 28</deliveredDateTime>
  <documentsCombinedUri>sample string 37</documentsCombinedUri>
  <documentsUri>sample string 7</documentsUri>
  <emailBlurb>sample string 13</emailBlurb>
  <emailSettings />
  <emailSubject>sample string 12</emailSubject>
  <enableWetSign>sample string 23</enableWetSign>
  <enforceSignerVisibility>sample string 22</enforceSignerVisibility>
  <envelopeId>sample string 14</envelopeId>
  <envelopeIdStamping>sample string 18</envelopeIdStamping>
  <envelopeUri>sample string 11</envelopeUri>
  <initialSentDateTime>sample string 29</initialSentDateTime>
  <is21CFRPart11>sample string 46</is21CFRPart11>
  <lastModifiedDateTime>sample string 27</lastModifiedDateTime>
  <lockInformation />
  <messageLock>sample string 40</messageLock>
  <notification />
  <notificationUri>sample string 21</notificationUri>
  <purgeState>sample string 45</purgeState>
  <recipients />
  <recipientsLock>sample string 41</recipientsLock>
  <recipientsUri>sample string 8</recipientsUri>
  <sentDateTime>sample string 30</sentDateTime>
  <signingLocation>sample string 15</signingLocation>
  <status>sample string 6</status>
  <statusChangedDateTime>sample string 36</statusChangedDateTime>
  <templatesUri>sample string 39</templatesUri>
  <transactionId>sample string 5</transactionId>
  <useDisclosure>sample string 44</useDisclosure>
  <voidedDateTime>sample string 32</voidedDateTime>
  <voidedReason>sample string 33</voidedReason>
  <accessibility>sample string 4</accessibility>
  <allowRecipientRecursion>sample string 1</allowRecipientRecursion>
  <attachments>
    <attachment>
      <accessControl>sample string 5</accessControl>
      <attachmentId>sample string 1</attachmentId>
      <attachmentType>sample string 3</attachmentType>
      <data>sample string 6</data>
      <label>sample string 2</label>
      <name>sample string 4</name>
      <remoteUrl>sample string 7</remoteUrl>
    </attachment>
  </attachments>
  <compositeTemplates>
    <compositeTemplate>
      <compositeTemplateId>sample string 1</compositeTemplateId>
      <document />
      <inlineTemplates>
        <inlineTemplate>
          <customFields />
          <documents>
            <document />
          </documents>
          <envelope>
            <allowMarkup>sample string 20</allowMarkup>
            <allowReassign>sample string 21</allowReassign>
            <asynchronous>sample string 6</asynchronous>
            <attachmentsUri>sample string 5</attachmentsUri>
            <authoritativeCopy>sample string 15</authoritativeCopy>
            <authoritativeCopyDefault>sample string 16</authoritativeCopyDefault>
            <autoNavigation>sample string 13</autoNavigation>
            <brandId>sample string 39</brandId>
            <brandLock>sample string 38</brandLock>
            <certificateUri>sample string 34</certificateUri>
            <completedDateTime>sample string 27</completedDateTime>
            <createdDateTime>sample string 22</createdDateTime>
            <customFields>
              <listCustomFields>
                <listCustomField>
                  <configurationType>sample string 6</configurationType>
                  <fieldId>sample string 1</fieldId>
                  <name>sample string 2</name>
                  <required>sample string 4</required>
                  <show>sample string 3</show>
                  <value>sample string 5</value>
                  <listItems xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </listItems>
                </listCustomField>
              </listCustomFields>
              <textCustomFields>
                <textCustomField>
                  <configurationType>sample string 6</configurationType>
                  <fieldId>sample string 1</fieldId>
                  <name>sample string 2</name>
                  <required>sample string 4</required>
                  <show>sample string 3</show>
                  <value>sample string 5</value>
                </textCustomField>
              </textCustomFields>
            </customFields>
            <customFieldsUri>sample string 12</customFieldsUri>
            <declinedDateTime>sample string 31</declinedDateTime>
            <deletedDateTime>sample string 30</deletedDateTime>
            <deliveredDateTime>sample string 24</deliveredDateTime>
            <documentsCombinedUri>sample string 33</documentsCombinedUri>
            <documentsUri>sample string 3</documentsUri>
            <emailBlurb>sample string 9</emailBlurb>
            <emailSettings>
              <bccEmailAddresses>
                <bccEmailAddress>
                  <bccEmailAddressId>sample string 1</bccEmailAddressId>
                  <email>sample string 2</email>
                </bccEmailAddress>
              </bccEmailAddresses>
              <replyEmailAddressOverride>sample string 1</replyEmailAddressOverride>
              <replyEmailNameOverride>sample string 2</replyEmailNameOverride>
            </emailSettings>
            <emailSubject>sample string 8</emailSubject>
            <enableWetSign>sample string 19</enableWetSign>
            <enforceSignerVisibility>sample string 18</enforceSignerVisibility>
            <envelopeId>sample string 10</envelopeId>
            <envelopeIdStamping>sample string 14</envelopeIdStamping>
            <envelopeUri>sample string 7</envelopeUri>
            <initialSentDateTime>sample string 25</initialSentDateTime>
            <is21CFRPart11>sample string 42</is21CFRPart11>
            <lastModifiedDateTime>sample string 23</lastModifiedDateTime>
            <lockInformation>
              <errorDetails>
                <errorCode>sample string 1</errorCode>
                <message>sample string 2</message>
              </errorDetails>
              <lockDurationInSeconds>sample string 3</lockDurationInSeconds>
              <lockToken>sample string 6</lockToken>
              <lockType>sample string 4</lockType>
              <lockedByApp>sample string 1</lockedByApp>
              <lockedByUser />
              <lockedUntilDateTime>sample string 2</lockedUntilDateTime>
              <useScratchPad>sample string 5</useScratchPad>
            </lockInformation>
            <messageLock>sample string 36</messageLock>
            <notification>
              <expirations>
                <expireAfter>sample string 2</expireAfter>
                <expireEnabled>sample string 1</expireEnabled>
                <expireWarn>sample string 3</expireWarn>
              </expirations>
              <reminders>
                <reminderDelay>sample string 2</reminderDelay>
                <reminderEnabled>sample string 1</reminderEnabled>
                <reminderFrequency>sample string 3</reminderFrequency>
              </reminders>
              <useAccountDefaults>sample string 1</useAccountDefaults>
            </notification>
            <notificationUri>sample string 17</notificationUri>
            <purgeState>sample string 41</purgeState>
            <recipients>
              <agents>
                <agent>
                  <accessCode>sample string 8</accessCode>
                  <addAccessCodeToEmail>sample string 9</addAccessCodeToEmail>
                  <clientUserId>sample string 13</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 19</declinedReason>
                  <deliveryMethod>sample string 20</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 14</embeddedRecipientStartURL>
                  <faxNumber>sample string 21</faxNumber>
                  <idCheckConfigurationName>sample string 11</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 24</inheritEmailNotificationConfiguration>
                  <note>sample string 16</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 6</recipientId>
                  <recipientIdGuid>sample string 7</recipientIdGuid>
                  <requireIdLookup>sample string 10</requireIdLookup>
                  <roleName>sample string 17</roleName>
                  <routingOrder>sample string 15</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 18</status>
                  <templateLocked>sample string 22</templateLocked>
                  <templateRequired>sample string 23</templateRequired>
                  <userId>sample string 12</userId>
                  <email>sample string 2</email>
                  <emailRecipientPostSigningURL>sample string 3</emailRecipientPostSigningURL>
                  <name>sample string 1</name>
                  <signingGroupId>sample string 4</signingGroupId>
                  <signingGroupName>sample string 5</signingGroupName>
                  <signingGroupUsers>
                    <userInfo />
                  </signingGroupUsers>
                  <excludedDocuments xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </excludedDocuments>
                </agent>
              </agents>
              <carbonCopies>
                <carbonCopy>
                  <accessCode>sample string 10</accessCode>
                  <addAccessCodeToEmail>sample string 11</addAccessCodeToEmail>
                  <clientUserId>sample string 15</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 21</declinedReason>
                  <deliveryMethod>sample string 22</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 16</embeddedRecipientStartURL>
                  <faxNumber>sample string 23</faxNumber>
                  <idCheckConfigurationName>sample string 13</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 26</inheritEmailNotificationConfiguration>
                  <note>sample string 18</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 8</recipientId>
                  <recipientIdGuid>sample string 9</recipientIdGuid>
                  <requireIdLookup>sample string 12</requireIdLookup>
                  <roleName>sample string 19</roleName>
                  <routingOrder>sample string 17</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 20</status>
                  <templateLocked>sample string 24</templateLocked>
                  <templateRequired>sample string 25</templateRequired>
                  <userId>sample string 14</userId>
                  <email>sample string 4</email>
                  <emailRecipientPostSigningURL>sample string 5</emailRecipientPostSigningURL>
                  <name>sample string 3</name>
                  <signingGroupId>sample string 6</signingGroupId>
                  <signingGroupName>sample string 7</signingGroupName>
                  <signingGroupUsers>
                    <userInfo />
                  </signingGroupUsers>
                  <excludedDocuments xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </excludedDocuments>
                  <agentCanEditEmail>sample string 1</agentCanEditEmail>
                  <agentCanEditName>sample string 2</agentCanEditName>
                </carbonCopy>
              </carbonCopies>
              <certifiedDeliveries>
                <certifiedDelivery>
                  <accessCode>sample string 10</accessCode>
                  <addAccessCodeToEmail>sample string 11</addAccessCodeToEmail>
                  <clientUserId>sample string 15</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 21</declinedReason>
                  <deliveryMethod>sample string 22</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 16</embeddedRecipientStartURL>
                  <faxNumber>sample string 23</faxNumber>
                  <idCheckConfigurationName>sample string 13</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 26</inheritEmailNotificationConfiguration>
                  <note>sample string 18</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 8</recipientId>
                  <recipientIdGuid>sample string 9</recipientIdGuid>
                  <requireIdLookup>sample string 12</requireIdLookup>
                  <roleName>sample string 19</roleName>
                  <routingOrder>sample string 17</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 20</status>
                  <templateLocked>sample string 24</templateLocked>
                  <templateRequired>sample string 25</templateRequired>
                  <userId>sample string 14</userId>
                  <email>sample string 4</email>
                  <emailRecipientPostSigningURL>sample string 5</emailRecipientPostSigningURL>
                  <name>sample string 3</name>
                  <signingGroupId>sample string 6</signingGroupId>
                  <signingGroupName>sample string 7</signingGroupName>
                  <signingGroupUsers>
                    <userInfo />
                  </signingGroupUsers>
                  <excludedDocuments xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </excludedDocuments>
                  <agentCanEditEmail>sample string 1</agentCanEditEmail>
                  <agentCanEditName>sample string 2</agentCanEditName>
                </certifiedDelivery>
              </certifiedDeliveries>
              <currentRoutingOrder>sample string 2</currentRoutingOrder>
              <editors>
                <editor>
                  <accessCode>sample string 8</accessCode>
                  <addAccessCodeToEmail>sample string 9</addAccessCodeToEmail>
                  <clientUserId>sample string 13</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 19</declinedReason>
                  <deliveryMethod>sample string 20</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 14</embeddedRecipientStartURL>
                  <faxNumber>sample string 21</faxNumber>
                  <idCheckConfigurationName>sample string 11</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 24</inheritEmailNotificationConfiguration>
                  <note>sample string 16</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 6</recipientId>
                  <recipientIdGuid>sample string 7</recipientIdGuid>
                  <requireIdLookup>sample string 10</requireIdLookup>
                  <roleName>sample string 17</roleName>
                  <routingOrder>sample string 15</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 18</status>
                  <templateLocked>sample string 22</templateLocked>
                  <templateRequired>sample string 23</templateRequired>
                  <userId>sample string 12</userId>
                  <email>sample string 2</email>
                  <emailRecipientPostSigningURL>sample string 3</emailRecipientPostSigningURL>
                  <name>sample string 1</name>
                  <signingGroupId>sample string 4</signingGroupId>
                  <signingGroupName>sample string 5</signingGroupName>
                  <signingGroupUsers>
                    <userInfo />
                  </signingGroupUsers>
                </editor>
              </editors>
              <inPersonSigners>
                <inPersonSigner>
                  <accessCode>sample string 19</accessCode>
                  <addAccessCodeToEmail>sample string 20</addAccessCodeToEmail>
                  <clientUserId>sample string 24</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 30</declinedReason>
                  <deliveryMethod>sample string 31</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 25</embeddedRecipientStartURL>
                  <faxNumber>sample string 32</faxNumber>
                  <idCheckConfigurationName>sample string 22</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 35</inheritEmailNotificationConfiguration>
                  <note>sample string 27</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 17</recipientId>
                  <recipientIdGuid>sample string 18</recipientIdGuid>
                  <requireIdLookup>sample string 21</requireIdLookup>
                  <roleName>sample string 28</roleName>
                  <routingOrder>sample string 26</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 29</status>
                  <templateLocked>sample string 33</templateLocked>
                  <templateRequired>sample string 34</templateRequired>
                  <userId>sample string 23</userId>
                  <autoNavigation>sample string 5</autoNavigation>
                  <canSignOffline>sample string 10</canSignOffline>
                  <defaultRecipient>sample string 6</defaultRecipient>
                  <email>sample string 16</email>
                  <excludedDocuments xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </excludedDocuments>
                  <hostEmail>sample string 2</hostEmail>
                  <hostName>sample string 1</hostName>
                  <inPersonSigningType>sample string 14</inPersonSigningType>
                  <name>sample string 15</name>
                  <notaryHost xmlns:d10p1="http://schemas.datacontract.org/2004/07/API_REST.Models.v2">
                    <accessCode>sample string 6</accessCode>
                    <addAccessCodeToEmail>sample string 7</addAccessCodeToEmail>
                    <clientUserId>sample string 11</clientUserId>
                    <customFields xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:string>sample string 1</d11p1:string>
                    </customFields>
                    <declinedReason>sample string 17</declinedReason>
                    <deliveryMethod>sample string 18</deliveryMethod>
                    <documentVisibility>
                      <documentVisibility />
                    </documentVisibility>
                    <emailNotification />
                    <embeddedRecipientStartURL>sample string 12</embeddedRecipientStartURL>
                    <faxNumber>sample string 19</faxNumber>
                    <idCheckConfigurationName>sample string 9</idCheckConfigurationName>
                    <idCheckInformationInput />
                    <inheritEmailNotificationConfiguration>sample string 22</inheritEmailNotificationConfiguration>
                    <note>sample string 14</note>
                    <phoneAuthentication />
                    <recipientAttachments>
                      <attachment />
                    </recipientAttachments>
                    <recipientId>sample string 4</recipientId>
                    <recipientIdGuid>sample string 5</recipientIdGuid>
                    <requireIdLookup>sample string 8</requireIdLookup>
                    <roleName>sample string 15</roleName>
                    <routingOrder>sample string 13</routingOrder>
                    <samlAuthentication />
                    <smsAuthentication />
                    <socialAuthentications>
                      <socialAuthentication />
                    </socialAuthentications>
                    <status>sample string 16</status>
                    <templateLocked>sample string 20</templateLocked>
                    <templateRequired>sample string 21</templateRequired>
                    <userId>sample string 10</userId>
                    <d10p1:email>sample string 2</d10p1:email>
                    <d10p1:hostRecipientId>sample string 3</d10p1:hostRecipientId>
                    <d10p1:name>sample string 1</d10p1:name>
                    <d10p1:tabs />
                  </notaryHost>
                  <offlineAttributes />
                  <recipientSignatureProviders>
                    <recipientSignatureProvider />
                  </recipientSignatureProviders>
                  <recipientSuppliesTabs>sample string 11</recipientSuppliesTabs>
                  <requireSignOnPaper>sample string 9</requireSignOnPaper>
                  <requireSignerCertificate>sample string 8</requireSignerCertificate>
                  <signInEachLocation>sample string 7</signInEachLocation>
                  <signatureInfo />
                  <signerEmail>sample string 4</signerEmail>
                  <signerName>sample string 3</signerName>
                  <signingGroupId>sample string 12</signingGroupId>
                  <signingGroupName>sample string 13</signingGroupName>
                  <signingGroupUsers>
                    <userInfo />
                  </signingGroupUsers>
                  <tabs />
                </inPersonSigner>
              </inPersonSigners>
              <intermediaries>
                <intermediary>
                  <accessCode>sample string 8</accessCode>
                  <addAccessCodeToEmail>sample string 9</addAccessCodeToEmail>
                  <clientUserId>sample string 13</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 19</declinedReason>
                  <deliveryMethod>sample string 20</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 14</embeddedRecipientStartURL>
                  <faxNumber>sample string 21</faxNumber>
                  <idCheckConfigurationName>sample string 11</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 24</inheritEmailNotificationConfiguration>
                  <note>sample string 16</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 6</recipientId>
                  <recipientIdGuid>sample string 7</recipientIdGuid>
                  <requireIdLookup>sample string 10</requireIdLookup>
                  <roleName>sample string 17</roleName>
                  <routingOrder>sample string 15</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 18</status>
                  <templateLocked>sample string 22</templateLocked>
                  <templateRequired>sample string 23</templateRequired>
                  <userId>sample string 12</userId>
                  <email>sample string 2</email>
                  <emailRecipientPostSigningURL>sample string 3</emailRecipientPostSigningURL>
                  <name>sample string 1</name>
                  <signingGroupId>sample string 4</signingGroupId>
                  <signingGroupName>sample string 5</signingGroupName>
                  <signingGroupUsers>
                    <userInfo />
                  </signingGroupUsers>
                  <excludedDocuments xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </excludedDocuments>
                </intermediary>
              </intermediaries>
              <recipientCount>sample string 1</recipientCount>
              <seals>
                <sealSign>
                  <accessCode>sample string 4</accessCode>
                  <addAccessCodeToEmail>sample string 5</addAccessCodeToEmail>
                  <clientUserId>sample string 9</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 15</declinedReason>
                  <deliveryMethod>sample string 16</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility />
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 10</embeddedRecipientStartURL>
                  <faxNumber>sample string 17</faxNumber>
                  <idCheckConfigurationName>sample string 7</idCheckConfigurationName>
                  <idCheckInformationInput />
                  <inheritEmailNotificationConfiguration>sample string 20</inheritEmailNotificationConfiguration>
                  <note>sample string 12</note>
                  <phoneAuthentication />
                  <recipientAttachments>
                    <attachment />
                  </recipientAttachments>
                  <recipientId>sample string 2</recipientId>
                  <recipientIdGuid>sample string 3</recipientIdGuid>
                  <requireIdLookup>sample string 6</requireIdLookup>
                  <roleName>sample string 13</roleName>
                  <routingOrder>sample string 11</routingOrder>
                  <samlAuthentication />
                  <smsAuthentication />
                  <socialAuthentications>
                    <socialAuthentication />
                  </socialAuthentications>
                  <status>sample string 14</status>
                  <templateLocked>sample string 18</templateLocked>
                  <templateRequired>sample string 19</templateRequired>
                  <userId>sample string 8</userId>
                  <name>sample string 1</name>
                  <recipientSignatureProviders>
                    <recipientSignatureProvider />
                  </recipientSignatureProviders>
                  <tabs />
                </sealSign>
              </seals>
              <signers>
                <signer>
                  <accessCode>sample string 19</accessCode>
                  <addAccessCodeToEmail>sample string 20</addAccessCodeToEmail>
                  <clientUserId>sample string 24</clientUserId>
                  <customFields xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </customFields>
                  <declinedReason>sample string 30</declinedReason>
                  <deliveryMethod>sample string 31</deliveryMethod>
                  <documentVisibility>
                    <documentVisibility>
                      <documentId>sample string 2</documentId>
                      <recipientId>sample string 1</recipientId>
                      <rights>sample string 4</rights>
                      <visible>sample string 3</visible>
                    </documentVisibility>
                  </documentVisibility>
                  <emailNotification />
                  <embeddedRecipientStartURL>sample string 25</embeddedRecipientStartURL>
                  <faxNumber>sample string 32</faxNumber>
                  <idCheckConfigurationName>sample string 22</idCheckConfigurationName>
                  <idCheckInformationInput>
                    <addressInformationInput>
                      <addressInformation>
                        <city>sample string 3</city>
                        <country>sample string 8</country>
                        <fax>sample string 7</fax>
                        <phone>sample string 6</phone>
                        <state>sample string 4</state>
                        <street1>sample string 1</street1>
                        <street2>sample string 2</street2>
                        <zip>sample string 5</zip>
                      </addressInformation>
                      <displayLevelCode>sample string 1</displayLevelCode>
                      <receiveInResponse>sample string 2</receiveInResponse>
                    </addressInformationInput>
                    <dobInformationInput>
                      <dateOfBirth>sample string 1</dateOfBirth>
                      <displayLevelCode>sample string 2</displayLevelCode>
                      <receiveInResponse>sample string 3</receiveInResponse>
                    </dobInformationInput>
                    <ssn4InformationInput>
                      <displayLevelCode>sample string 2</displayLevelCode>
                      <receiveInResponse>sample string 3</receiveInResponse>
                      <ssn4>sample string 1</ssn4>
                    </ssn4InformationInput>
                    <ssn9InformationInput>
                      <displayLevelCode>sample string 2</displayLevelCode>
                      <ssn9>sample string 1</ssn9>
                    </ssn9InformationInput>
                  </idCheckInformationInput>
                  <inheritEmailNotificationConfiguration>sample string 35</inheritEmailNotificationConfiguration>
                  <note>sample string 27</note>
                  <phoneAuthentication>
                    <recipMayProvideNumber>sample string 1</recipMayProvideNumber>
                    <recordVoicePrint>sample string 3</recordVoicePrint>
                    <senderProvidedNumbers xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:string>sample string 1</d11p1:string>
                    </senderProvidedNumbers>
                    <validateRecipProvidedNumber>sample string 2</validateRecipProvidedNumber>
                  </phoneAuthentication>
                  <recipientAttachments>
                    <attachment>
                      <attachmentId>sample string 1</attachmentId>
                      <attachmentType>sample string 3</attachmentType>
                      <data>sample string 5</data>
                      <label>sample string 2</label>
                      <name>sample string 4</name>
                      <remoteUrl>sample string 6</remoteUrl>
                    </attachment>
                  </recipientAttachments>
                  <recipientId>sample string 17</recipientId>
                  <recipientIdGuid>sample string 18</recipientIdGuid>
                  <requireIdLookup>sample string 21</requireIdLookup>
                  <roleName>sample string 28</roleName>
                  <routingOrder>sample string 26</routingOrder>
                  <samlAuthentication>
                    <samlAssertionAttributes>
                      <samlAssertionAttribute>
                        <name>sample string 1</name>
                        <originalValue>sample string 3</originalValue>
                        <value>sample string 2</value>
                      </samlAssertionAttribute>
                    </samlAssertionAttributes>
                  </samlAuthentication>
                  <smsAuthentication>
                    <senderProvidedNumbers xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:string>sample string 1</d11p1:string>
                    </senderProvidedNumbers>
                  </smsAuthentication>
                  <socialAuthentications>
                    <socialAuthentication>
                      <authentication>sample string 1</authentication>
                    </socialAuthentication>
                  </socialAuthentications>
                  <status>sample string 29</status>
                  <templateLocked>sample string 33</templateLocked>
                  <templateRequired>sample string 34</templateRequired>
                  <userId>sample string 23</userId>
                  <email>sample string 13</email>
                  <emailRecipientPostSigningURL>sample string 14</emailRecipientPostSigningURL>
                  <name>sample string 12</name>
                  <signingGroupId>sample string 15</signingGroupId>
                  <signingGroupName>sample string 16</signingGroupName>
                  <signingGroupUsers>
                    <userInfo>
                      <activationAccessCode>sample string 9</activationAccessCode>
                      <email>sample string 3</email>
                      <loginStatus>sample string 7</loginStatus>
                      <sendActivationEmail>sample string 8</sendActivationEmail>
                      <uri>sample string 6</uri>
                      <userId>sample string 2</userId>
                      <userName>sample string 1</userName>
                      <userStatus>sample string 5</userStatus>
                      <userType>sample string 4</userType>
                    </userInfo>
                  </signingGroupUsers>
                  <excludedDocuments xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:string>sample string 1</d10p1:string>
                  </excludedDocuments>
                  <agentCanEditEmail>sample string 10</agentCanEditEmail>
                  <agentCanEditName>sample string 11</agentCanEditName>
                  <autoNavigation>sample string 1</autoNavigation>
                  <bulkRecipientsUri>sample string 8</bulkRecipientsUri>
                  <canSignOffline>sample string 6</canSignOffline>
                  <defaultRecipient>sample string 2</defaultRecipient>
                  <isBulkRecipient>sample string 7</isBulkRecipient>
                  <offlineAttributes>
                    <accountEsignId>sample string 5</accountEsignId>
                    <deviceModel>sample string 2</deviceModel>
                    <deviceName>sample string 1</deviceName>
                    <gpsLatitude>sample string 3</gpsLatitude>
                    <gpsLongitude>sample string 4</gpsLongitude>
                    <offlineSigningHash>sample string 6</offlineSigningHash>
                  </offlineAttributes>
                  <recipientSignatureProviders>
                    <recipientSignatureProvider />
                  </recipientSignatureProviders>
                  <recipientSuppliesTabs>sample string 9</recipientSuppliesTabs>
                  <requireSignOnPaper>sample string 5</requireSignOnPaper>
                  <requireSignerCertificate>sample string 4</requireSignerCertificate>
                  <signInEachLocation>sample string 3</signInEachLocation>
                  <signatureInfo>
                    <fontStyle>sample string 3</fontStyle>
                    <signatureInitials>sample string 2</signatureInitials>
                    <signatureName>sample string 1</signatureName>
                  </signatureInfo>
                  <tabs />
                </signer>
              </signers>
            </recipients>
            <recipientsLock>sample string 37</recipientsLock>
            <recipientsUri>sample string 4</recipientsUri>
            <sentDateTime>sample string 26</sentDateTime>
            <signingLocation>sample string 11</signingLocation>
            <status>sample string 2</status>
            <statusChangedDateTime>sample string 32</statusChangedDateTime>
            <templatesUri>sample string 35</templatesUri>
            <transactionId>sample string 1</transactionId>
            <useDisclosure>sample string 40</useDisclosure>
            <voidedDateTime>sample string 28</voidedDateTime>
            <voidedReason>sample string 29</voidedReason>
          </envelope>
          <recipients />
          <sequence>sample string 1</sequence>
        </inlineTemplate>
      </inlineTemplates>
      <pdfMetaDataTemplateSequence>sample string 2</pdfMetaDataTemplateSequence>
      <serverTemplates>
        <serverTemplate>
          <sequence>sample string 1</sequence>
          <templateId>sample string 2</templateId>
        </serverTemplate>
      </serverTemplates>
    </compositeTemplate>
  </compositeTemplates>
  <documents>
    <document>
      <applyAnchorTabs>sample string 12</applyAnchorTabs>
      <authoritativeCopy>true</authoritativeCopy>
      <display>sample string 13</display>
      <documentBase64>sample string 11</documentBase64>
      <documentFields>
        <nameValue />
      </documentFields>
      <documentGroup>sample string 18</documentGroup>
      <documentId>sample string 1</documentId>
      <encryptedWithKeyManager>sample string 10</encryptedWithKeyManager>
      <fileExtension>sample string 7</fileExtension>
      <fileFormatHint>sample string 19</fileFormatHint>
      <includeInDownload>sample string 14</includeInDownload>
      <matchBoxes>
        <matchBox>
          <height>5</height>
          <pageNumber>1</pageNumber>
          <width>4</width>
          <xPosition>2</xPosition>
          <yPosition>3</yPosition>
        </matchBox>
      </matchBoxes>
      <name>sample string 4</name>
      <order>sample string 8</order>
      <pages>sample string 9</pages>
      <password>sample string 5</password>
      <remoteUrl>sample string 3</remoteUrl>
      <signerMustAcknowledge>sample string 15</signerMustAcknowledge>
      <templateLocked>sample string 16</templateLocked>
      <templateRequired>sample string 17</templateRequired>
      <transformPdfFields>sample string 6</transformPdfFields>
      <uri>sample string 2</uri>
    </document>
  </documents>
  <eventNotification>
    <envelopeEvents>
      <envelopeEvent>
        <envelopeEventStatusCode>sample string 1</envelopeEventStatusCode>
        <includeDocuments>sample string 2</includeDocuments>
      </envelopeEvent>
    </envelopeEvents>
    <includeCertificateOfCompletion>sample string 13</includeCertificateOfCompletion>
    <includeCertificateWithSoap>sample string 6</includeCertificateWithSoap>
    <includeDocumentFields>sample string 12</includeDocumentFields>
    <includeDocuments>sample string 8</includeDocuments>
    <includeEnvelopeVoidReason>sample string 9</includeEnvelopeVoidReason>
    <includeSenderAccountAsCustomField>sample string 11</includeSenderAccountAsCustomField>
    <includeTimeZone>sample string 10</includeTimeZone>
    <loggingEnabled>sample string 2</loggingEnabled>
    <recipientEvents>
      <recipientEvent>
        <includeDocuments>sample string 2</includeDocuments>
        <recipientEventStatusCode>sample string 1</recipientEventStatusCode>
      </recipientEvent>
    </recipientEvents>
    <requireAcknowledgment>sample string 3</requireAcknowledgment>
    <signMessageWithX509Cert>sample string 7</signMessageWithX509Cert>
    <soapNameSpace>sample string 5</soapNameSpace>
    <url>sample string 1</url>
    <useSoapInterface>sample string 4</useSoapInterface>
  </eventNotification>
  <password>sample string 3</password>
  <templateId>sample string 2</templateId>
  <templateRoles>
    <templateRole>
      <accessCode>sample string 9</accessCode>
      <clientUserId>sample string 6</clientUserId>
      <defaultRecipient>sample string 8</defaultRecipient>
      <email>sample string 1</email>
      <emailNotification>
        <emailBody>sample string 2</emailBody>
        <emailSubject>sample string 1</emailSubject>
        <supportedLanguage>sample string 3</supportedLanguage>
      </emailNotification>
      <embeddedRecipientStartURL>sample string 7</embeddedRecipientStartURL>
      <inPersonSignerName>sample string 5</inPersonSignerName>
      <name>sample string 3</name>
      <recipientSignatureProviders>
        <recipientSignatureProvider>
          <sealDocumentsWithTabsOnly>sample string 2</sealDocumentsWithTabsOnly>
          <sealName>sample string 1</sealName>
          <signatureProviderName>sample string 3</signatureProviderName>
          <signatureProviderOptions>
            <cpfNumber>sample string 3</cpfNumber>
            <oneTimePassword>sample string 2</oneTimePassword>
            <signerRole>sample string 4</signerRole>
            <sms>sample string 1</sms>
          </signatureProviderOptions>
        </recipientSignatureProvider>
      </recipientSignatureProviders>
      <roleName>sample string 2</roleName>
      <routingOrder>sample string 10</routingOrder>
      <signingGroupId>sample string 4</signingGroupId>
      <tabs>
        <approveTabs>
          <approve>
            <anchorCaseSensitive>sample string 21</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 23</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 20</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 22</anchorMatchWholeWord>
            <anchorString>sample string 16</anchorString>
            <anchorUnits>sample string 19</anchorUnits>
            <anchorXOffset>sample string 17</anchorXOffset>
            <anchorYOffset>sample string 18</anchorYOffset>
            <conditionalParentLabel>sample string 27</conditionalParentLabel>
            <conditionalParentValue>sample string 28</conditionalParentValue>
            <customTabId>sample string 29</customTabId>
            <documentId>sample string 11</documentId>
            <mergeField />
            <pageNumber>sample string 13</pageNumber>
            <recipientId>sample string 12</recipientId>
            <tabId>sample string 24</tabId>
            <tabOrder>sample string 30</tabOrder>
            <templateLocked>sample string 25</templateLocked>
            <templateRequired>sample string 26</templateRequired>
            <xPosition>sample string 14</xPosition>
            <yPosition>sample string 15</yPosition>
            <bold>sample string 6</bold>
            <font>sample string 5</font>
            <fontColor>sample string 9</fontColor>
            <fontSize>sample string 10</fontSize>
            <italic>sample string 7</italic>
            <tabLabel>sample string 4</tabLabel>
            <underline>sample string 8</underline>
            <buttonText>sample string 1</buttonText>
            <height>3</height>
            <width>2</width>
          </approve>
        </approveTabs>
        <checkboxTabs>
          <checkbox>
            <anchorCaseSensitive>sample string 18</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 20</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 17</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 19</anchorMatchWholeWord>
            <anchorString>sample string 13</anchorString>
            <anchorUnits>sample string 16</anchorUnits>
            <anchorXOffset>sample string 14</anchorXOffset>
            <anchorYOffset>sample string 15</anchorYOffset>
            <conditionalParentLabel>sample string 24</conditionalParentLabel>
            <conditionalParentValue>sample string 25</conditionalParentValue>
            <customTabId>sample string 26</customTabId>
            <documentId>sample string 8</documentId>
            <mergeField />
            <pageNumber>sample string 10</pageNumber>
            <recipientId>sample string 9</recipientId>
            <tabId>sample string 21</tabId>
            <tabOrder>sample string 27</tabOrder>
            <templateLocked>sample string 22</templateLocked>
            <templateRequired>sample string 23</templateRequired>
            <xPosition>sample string 11</xPosition>
            <yPosition>sample string 12</yPosition>
            <locked>sample string 7</locked>
            <required>sample string 6</required>
            <name>sample string 1</name>
            <requireInitialOnSharedChange>sample string 5</requireInitialOnSharedChange>
            <selected>sample string 3</selected>
            <shared>sample string 4</shared>
            <tabLabel>sample string 2</tabLabel>
          </checkbox>
        </checkboxTabs>
        <companyTabs>
          <company>
            <anchorCaseSensitive>sample string 27</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 29</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 26</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 28</anchorMatchWholeWord>
            <anchorString>sample string 22</anchorString>
            <anchorUnits>sample string 25</anchorUnits>
            <anchorXOffset>sample string 23</anchorXOffset>
            <anchorYOffset>sample string 24</anchorYOffset>
            <conditionalParentLabel>sample string 33</conditionalParentLabel>
            <conditionalParentValue>sample string 34</conditionalParentValue>
            <customTabId>sample string 35</customTabId>
            <documentId>sample string 17</documentId>
            <mergeField />
            <pageNumber>sample string 19</pageNumber>
            <recipientId>sample string 18</recipientId>
            <tabId>sample string 30</tabId>
            <tabOrder>sample string 36</tabOrder>
            <templateLocked>sample string 31</templateLocked>
            <templateRequired>sample string 32</templateRequired>
            <xPosition>sample string 20</xPosition>
            <yPosition>sample string 21</yPosition>
            <bold>sample string 12</bold>
            <font>sample string 11</font>
            <fontColor>sample string 15</fontColor>
            <fontSize>sample string 16</fontSize>
            <italic>sample string 13</italic>
            <tabLabel>sample string 10</tabLabel>
            <underline>sample string 14</underline>
            <concealValueOnDocument>sample string 7</concealValueOnDocument>
            <disableAutoSize>sample string 8</disableAutoSize>
            <locked>sample string 6</locked>
            <maxLength>9</maxLength>
            <name>sample string 1</name>
            <originalValue>sample string 3</originalValue>
            <required>sample string 5</required>
            <value>sample string 2</value>
            <width>4</width>
          </company>
        </companyTabs>
        <dateSignedTabs>
          <dateSigned>
            <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
            <anchorString>sample string 15</anchorString>
            <anchorUnits>sample string 18</anchorUnits>
            <anchorXOffset>sample string 16</anchorXOffset>
            <anchorYOffset>sample string 17</anchorYOffset>
            <conditionalParentLabel>sample string 26</conditionalParentLabel>
            <conditionalParentValue>sample string 27</conditionalParentValue>
            <customTabId>sample string 28</customTabId>
            <documentId>sample string 10</documentId>
            <mergeField />
            <pageNumber>sample string 12</pageNumber>
            <recipientId>sample string 11</recipientId>
            <tabId>sample string 23</tabId>
            <tabOrder>sample string 29</tabOrder>
            <templateLocked>sample string 24</templateLocked>
            <templateRequired>sample string 25</templateRequired>
            <xPosition>sample string 13</xPosition>
            <yPosition>sample string 14</yPosition>
            <bold>sample string 5</bold>
            <font>sample string 4</font>
            <fontColor>sample string 8</fontColor>
            <fontSize>sample string 9</fontSize>
            <italic>sample string 6</italic>
            <tabLabel>sample string 3</tabLabel>
            <underline>sample string 7</underline>
            <name>sample string 1</name>
            <value>sample string 2</value>
          </dateSigned>
        </dateSignedTabs>
        <dateTabs>
          <date>
            <anchorCaseSensitive>sample string 33</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 35</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 32</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 34</anchorMatchWholeWord>
            <anchorString>sample string 28</anchorString>
            <anchorUnits>sample string 31</anchorUnits>
            <anchorXOffset>sample string 29</anchorXOffset>
            <anchorYOffset>sample string 30</anchorYOffset>
            <conditionalParentLabel>sample string 39</conditionalParentLabel>
            <conditionalParentValue>sample string 40</conditionalParentValue>
            <customTabId>sample string 41</customTabId>
            <documentId>sample string 23</documentId>
            <mergeField />
            <pageNumber>sample string 25</pageNumber>
            <recipientId>sample string 24</recipientId>
            <tabId>sample string 36</tabId>
            <tabOrder>sample string 42</tabOrder>
            <templateLocked>sample string 37</templateLocked>
            <templateRequired>sample string 38</templateRequired>
            <xPosition>sample string 26</xPosition>
            <yPosition>sample string 27</yPosition>
            <bold>sample string 18</bold>
            <font>sample string 17</font>
            <fontColor>sample string 21</fontColor>
            <fontSize>sample string 22</fontSize>
            <italic>sample string 19</italic>
            <tabLabel>sample string 16</tabLabel>
            <underline>sample string 20</underline>
            <concealValueOnDocument>sample string 13</concealValueOnDocument>
            <disableAutoSize>sample string 14</disableAutoSize>
            <locked>sample string 12</locked>
            <maxLength>15</maxLength>
            <name>sample string 7</name>
            <originalValue>sample string 9</originalValue>
            <required>sample string 11</required>
            <value>sample string 8</value>
            <width>10</width>
            <requireAll>sample string 6</requireAll>
            <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
            <senderRequired>sample string 5</senderRequired>
            <shared>sample string 3</shared>
            <validationMessage>sample string 2</validationMessage>
            <validationPattern>sample string 1</validationPattern>
          </date>
        </dateTabs>
        <declineTabs>
          <decline>
            <anchorCaseSensitive>sample string 22</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 24</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 21</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 23</anchorMatchWholeWord>
            <anchorString>sample string 17</anchorString>
            <anchorUnits>sample string 20</anchorUnits>
            <anchorXOffset>sample string 18</anchorXOffset>
            <anchorYOffset>sample string 19</anchorYOffset>
            <conditionalParentLabel>sample string 28</conditionalParentLabel>
            <conditionalParentValue>sample string 29</conditionalParentValue>
            <customTabId>sample string 30</customTabId>
            <documentId>sample string 12</documentId>
            <mergeField />
            <pageNumber>sample string 14</pageNumber>
            <recipientId>sample string 13</recipientId>
            <tabId>sample string 25</tabId>
            <tabOrder>sample string 31</tabOrder>
            <templateLocked>sample string 26</templateLocked>
            <templateRequired>sample string 27</templateRequired>
            <xPosition>sample string 15</xPosition>
            <yPosition>sample string 16</yPosition>
            <bold>sample string 7</bold>
            <font>sample string 6</font>
            <fontColor>sample string 10</fontColor>
            <fontSize>sample string 11</fontSize>
            <italic>sample string 8</italic>
            <tabLabel>sample string 5</tabLabel>
            <underline>sample string 9</underline>
            <buttonText>sample string 1</buttonText>
            <declineReason>sample string 4</declineReason>
            <height>3</height>
            <width>2</width>
          </decline>
        </declineTabs>
        <emailAddressTabs>
          <emailAddress>
            <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
            <anchorString>sample string 15</anchorString>
            <anchorUnits>sample string 18</anchorUnits>
            <anchorXOffset>sample string 16</anchorXOffset>
            <anchorYOffset>sample string 17</anchorYOffset>
            <conditionalParentLabel>sample string 26</conditionalParentLabel>
            <conditionalParentValue>sample string 27</conditionalParentValue>
            <customTabId>sample string 28</customTabId>
            <documentId>sample string 10</documentId>
            <mergeField />
            <pageNumber>sample string 12</pageNumber>
            <recipientId>sample string 11</recipientId>
            <tabId>sample string 23</tabId>
            <tabOrder>sample string 29</tabOrder>
            <templateLocked>sample string 24</templateLocked>
            <templateRequired>sample string 25</templateRequired>
            <xPosition>sample string 13</xPosition>
            <yPosition>sample string 14</yPosition>
            <bold>sample string 5</bold>
            <font>sample string 4</font>
            <fontColor>sample string 8</fontColor>
            <fontSize>sample string 9</fontSize>
            <italic>sample string 6</italic>
            <tabLabel>sample string 3</tabLabel>
            <underline>sample string 7</underline>
            <name>sample string 1</name>
            <value>sample string 2</value>
          </emailAddress>
        </emailAddressTabs>
        <emailTabs>
          <email>
            <anchorCaseSensitive>sample string 33</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 35</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 32</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 34</anchorMatchWholeWord>
            <anchorString>sample string 28</anchorString>
            <anchorUnits>sample string 31</anchorUnits>
            <anchorXOffset>sample string 29</anchorXOffset>
            <anchorYOffset>sample string 30</anchorYOffset>
            <conditionalParentLabel>sample string 39</conditionalParentLabel>
            <conditionalParentValue>sample string 40</conditionalParentValue>
            <customTabId>sample string 41</customTabId>
            <documentId>sample string 23</documentId>
            <mergeField />
            <pageNumber>sample string 25</pageNumber>
            <recipientId>sample string 24</recipientId>
            <tabId>sample string 36</tabId>
            <tabOrder>sample string 42</tabOrder>
            <templateLocked>sample string 37</templateLocked>
            <templateRequired>sample string 38</templateRequired>
            <xPosition>sample string 26</xPosition>
            <yPosition>sample string 27</yPosition>
            <bold>sample string 18</bold>
            <font>sample string 17</font>
            <fontColor>sample string 21</fontColor>
            <fontSize>sample string 22</fontSize>
            <italic>sample string 19</italic>
            <tabLabel>sample string 16</tabLabel>
            <underline>sample string 20</underline>
            <concealValueOnDocument>sample string 13</concealValueOnDocument>
            <disableAutoSize>sample string 14</disableAutoSize>
            <locked>sample string 12</locked>
            <maxLength>15</maxLength>
            <name>sample string 7</name>
            <originalValue>sample string 9</originalValue>
            <required>sample string 11</required>
            <value>sample string 8</value>
            <width>10</width>
            <requireAll>sample string 6</requireAll>
            <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
            <senderRequired>sample string 5</senderRequired>
            <shared>sample string 3</shared>
            <validationMessage>sample string 2</validationMessage>
            <validationPattern>sample string 1</validationPattern>
          </email>
        </emailTabs>
        <envelopeIdTabs>
          <envelopeId>
            <anchorCaseSensitive>sample string 19</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 21</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 18</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 20</anchorMatchWholeWord>
            <anchorString>sample string 14</anchorString>
            <anchorUnits>sample string 17</anchorUnits>
            <anchorXOffset>sample string 15</anchorXOffset>
            <anchorYOffset>sample string 16</anchorYOffset>
            <conditionalParentLabel>sample string 25</conditionalParentLabel>
            <conditionalParentValue>sample string 26</conditionalParentValue>
            <customTabId>sample string 27</customTabId>
            <documentId>sample string 9</documentId>
            <mergeField />
            <pageNumber>sample string 11</pageNumber>
            <recipientId>sample string 10</recipientId>
            <tabId>sample string 22</tabId>
            <tabOrder>sample string 28</tabOrder>
            <templateLocked>sample string 23</templateLocked>
            <templateRequired>sample string 24</templateRequired>
            <xPosition>sample string 12</xPosition>
            <yPosition>sample string 13</yPosition>
            <bold>sample string 4</bold>
            <font>sample string 3</font>
            <fontColor>sample string 7</fontColor>
            <fontSize>sample string 8</fontSize>
            <italic>sample string 5</italic>
            <tabLabel>sample string 2</tabLabel>
            <underline>sample string 6</underline>
            <name>sample string 1</name>
          </envelopeId>
        </envelopeIdTabs>
        <firstNameTabs>
          <firstName>
            <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
            <anchorString>sample string 15</anchorString>
            <anchorUnits>sample string 18</anchorUnits>
            <anchorXOffset>sample string 16</anchorXOffset>
            <anchorYOffset>sample string 17</anchorYOffset>
            <conditionalParentLabel>sample string 26</conditionalParentLabel>
            <conditionalParentValue>sample string 27</conditionalParentValue>
            <customTabId>sample string 28</customTabId>
            <documentId>sample string 10</documentId>
            <mergeField />
            <pageNumber>sample string 12</pageNumber>
            <recipientId>sample string 11</recipientId>
            <tabId>sample string 23</tabId>
            <tabOrder>sample string 29</tabOrder>
            <templateLocked>sample string 24</templateLocked>
            <templateRequired>sample string 25</templateRequired>
            <xPosition>sample string 13</xPosition>
            <yPosition>sample string 14</yPosition>
            <bold>sample string 5</bold>
            <font>sample string 4</font>
            <fontColor>sample string 8</fontColor>
            <fontSize>sample string 9</fontSize>
            <italic>sample string 6</italic>
            <tabLabel>sample string 3</tabLabel>
            <underline>sample string 7</underline>
            <name>sample string 1</name>
            <value>sample string 2</value>
          </firstName>
        </firstNameTabs>
        <formulaTabs xmlns:d5p1="http://schemas.datacontract.org/2004/07/API_REST.Models">
          <d5p1:formulaTab>
            <anchorCaseSensitive>sample string 37</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 39</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 36</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 38</anchorMatchWholeWord>
            <anchorString>sample string 32</anchorString>
            <anchorUnits>sample string 35</anchorUnits>
            <anchorXOffset>sample string 33</anchorXOffset>
            <anchorYOffset>sample string 34</anchorYOffset>
            <conditionalParentLabel>sample string 43</conditionalParentLabel>
            <conditionalParentValue>sample string 44</conditionalParentValue>
            <customTabId>sample string 45</customTabId>
            <documentId>sample string 27</documentId>
            <mergeField />
            <pageNumber>sample string 29</pageNumber>
            <recipientId>sample string 28</recipientId>
            <tabId>sample string 40</tabId>
            <tabOrder>sample string 46</tabOrder>
            <templateLocked>sample string 41</templateLocked>
            <templateRequired>sample string 42</templateRequired>
            <xPosition>sample string 30</xPosition>
            <yPosition>sample string 31</yPosition>
            <bold>sample string 22</bold>
            <font>sample string 21</font>
            <fontColor>sample string 25</fontColor>
            <fontSize>sample string 26</fontSize>
            <italic>sample string 23</italic>
            <tabLabel>sample string 20</tabLabel>
            <underline>sample string 24</underline>
            <concealValueOnDocument>sample string 17</concealValueOnDocument>
            <disableAutoSize>sample string 18</disableAutoSize>
            <locked>sample string 16</locked>
            <maxLength>19</maxLength>
            <name>sample string 11</name>
            <originalValue>sample string 13</originalValue>
            <required>sample string 15</required>
            <value>sample string 12</value>
            <width>14</width>
            <requireAll>sample string 10</requireAll>
            <requireInitialOnSharedChange>sample string 8</requireInitialOnSharedChange>
            <senderRequired>sample string 9</senderRequired>
            <shared>sample string 7</shared>
            <validationMessage>sample string 6</validationMessage>
            <validationPattern>sample string 5</validationPattern>
            <d5p1:formula>sample string 2</d5p1:formula>
            <d5p1:hidden>sample string 4</d5p1:hidden>
            <d5p1:isPaymentAmount>sample string 1</d5p1:isPaymentAmount>
            <d5p1:paymentDetails>
              <allowedPaymentMethods xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>sample string 1</d8p1:string>
              </allowedPaymentMethods>
              <chargeId>sample string 6</chargeId>
              <currencyCode>sample string 2</currencyCode>
              <gatewayAccountId>sample string 3</gatewayAccountId>
              <gatewayDisplayName>sample string 5</gatewayDisplayName>
              <gatewayName>sample string 4</gatewayName>
              <lineItems xmlns:d8p1="http://schemas.datacontract.org/2004/07/API_REST.Models.v2.payments">
                <d8p1:paymentLineItem>
                  <d8p1:amountReference>sample string 4</d8p1:amountReference>
                  <d8p1:description>sample string 2</d8p1:description>
                  <d8p1:itemCode>sample string 3</d8p1:itemCode>
                  <d8p1:name>sample string 1</d8p1:name>
                </d8p1:paymentLineItem>
              </lineItems>
              <status>sample string 1</status>
              <total>
                <amountInBaseUnit>sample string 1</amountInBaseUnit>
                <currency>sample string 2</currency>
                <displayAmount>sample string 3</displayAmount>
              </total>
            </d5p1:paymentDetails>
            <d5p1:roundDecimalPlaces>sample string 3</d5p1:roundDecimalPlaces>
          </d5p1:formulaTab>
        </formulaTabs>
        <fullNameTabs>
          <fullName>
            <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
            <anchorString>sample string 15</anchorString>
            <anchorUnits>sample string 18</anchorUnits>
            <anchorXOffset>sample string 16</anchorXOffset>
            <anchorYOffset>sample string 17</anchorYOffset>
            <conditionalParentLabel>sample string 26</conditionalParentLabel>
            <conditionalParentValue>sample string 27</conditionalParentValue>
            <customTabId>sample string 28</customTabId>
            <documentId>sample string 10</documentId>
            <mergeField />
            <pageNumber>sample string 12</pageNumber>
            <recipientId>sample string 11</recipientId>
            <tabId>sample string 23</tabId>
            <tabOrder>sample string 29</tabOrder>
            <templateLocked>sample string 24</templateLocked>
            <templateRequired>sample string 25</templateRequired>
            <xPosition>sample string 13</xPosition>
            <yPosition>sample string 14</yPosition>
            <bold>sample string 5</bold>
            <font>sample string 4</font>
            <fontColor>sample string 8</fontColor>
            <fontSize>sample string 9</fontSize>
            <italic>sample string 6</italic>
            <tabLabel>sample string 3</tabLabel>
            <underline>sample string 7</underline>
            <name>sample string 1</name>
            <value>sample string 2</value>
          </fullName>
        </fullNameTabs>
        <initialHereTabs>
          <initialHere>
            <anchorCaseSensitive>sample string 14</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 16</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 13</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 15</anchorMatchWholeWord>
            <anchorString>sample string 9</anchorString>
            <anchorUnits>sample string 12</anchorUnits>
            <anchorXOffset>sample string 10</anchorXOffset>
            <anchorYOffset>sample string 11</anchorYOffset>
            <conditionalParentLabel>sample string 20</conditionalParentLabel>
            <conditionalParentValue>sample string 21</conditionalParentValue>
            <customTabId>sample string 22</customTabId>
            <documentId>sample string 4</documentId>
            <mergeField />
            <pageNumber>sample string 6</pageNumber>
            <recipientId>sample string 5</recipientId>
            <tabId>sample string 17</tabId>
            <tabOrder>sample string 23</tabOrder>
            <templateLocked>sample string 18</templateLocked>
            <templateRequired>sample string 19</templateRequired>
            <xPosition>sample string 7</xPosition>
            <yPosition>sample string 8</yPosition>
            <name>sample string 1</name>
            <optional>sample string 3</optional>
            <scaleValue>1.1</scaleValue>
            <tabLabel>sample string 2</tabLabel>
          </initialHere>
        </initialHereTabs>
        <lastNameTabs>
          <lastName>
            <anchorCaseSensitive>sample string 20</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 22</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 19</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 21</anchorMatchWholeWord>
            <anchorString>sample string 15</anchorString>
            <anchorUnits>sample string 18</anchorUnits>
            <anchorXOffset>sample string 16</anchorXOffset>
            <anchorYOffset>sample string 17</anchorYOffset>
            <conditionalParentLabel>sample string 26</conditionalParentLabel>
            <conditionalParentValue>sample string 27</conditionalParentValue>
            <customTabId>sample string 28</customTabId>
            <documentId>sample string 10</documentId>
            <mergeField />
            <pageNumber>sample string 12</pageNumber>
            <recipientId>sample string 11</recipientId>
            <tabId>sample string 23</tabId>
            <tabOrder>sample string 29</tabOrder>
            <templateLocked>sample string 24</templateLocked>
            <templateRequired>sample string 25</templateRequired>
            <xPosition>sample string 13</xPosition>
            <yPosition>sample string 14</yPosition>
            <bold>sample string 5</bold>
            <font>sample string 4</font>
            <fontColor>sample string 8</fontColor>
            <fontSize>sample string 9</fontSize>
            <italic>sample string 6</italic>
            <tabLabel>sample string 3</tabLabel>
            <underline>sample string 7</underline>
            <name>sample string 1</name>
            <value>sample string 2</value>
          </lastName>
        </lastNameTabs>
        <listTabs>
          <list>
            <anchorCaseSensitive>sample string 26</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 28</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 25</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 27</anchorMatchWholeWord>
            <anchorString>sample string 21</anchorString>
            <anchorUnits>sample string 24</anchorUnits>
            <anchorXOffset>sample string 22</anchorXOffset>
            <anchorYOffset>sample string 23</anchorYOffset>
            <conditionalParentLabel>sample string 32</conditionalParentLabel>
            <conditionalParentValue>sample string 33</conditionalParentValue>
            <customTabId>sample string 34</customTabId>
            <documentId>sample string 16</documentId>
            <mergeField />
            <pageNumber>sample string 18</pageNumber>
            <recipientId>sample string 17</recipientId>
            <tabId>sample string 29</tabId>
            <tabOrder>sample string 35</tabOrder>
            <templateLocked>sample string 30</templateLocked>
            <templateRequired>sample string 31</templateRequired>
            <xPosition>sample string 19</xPosition>
            <yPosition>sample string 20</yPosition>
            <bold>sample string 11</bold>
            <font>sample string 10</font>
            <fontColor>sample string 14</fontColor>
            <fontSize>sample string 15</fontSize>
            <italic>sample string 12</italic>
            <tabLabel>sample string 9</tabLabel>
            <underline>sample string 13</underline>
            <listItems>
              <listItem>
                <selected>sample string 3</selected>
                <text>sample string 1</text>
                <value>sample string 2</value>
              </listItem>
            </listItems>
            <locked>sample string 6</locked>
            <requireAll>sample string 8</requireAll>
            <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
            <required>sample string 5</required>
            <senderRequired>sample string 7</senderRequired>
            <shared>sample string 3</shared>
            <value>sample string 1</value>
            <width>2</width>
          </list>
        </listTabs>
        <notarizeTabs>
          <notarize>
            <anchorCaseSensitive>sample string 13</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 15</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 12</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 14</anchorMatchWholeWord>
            <anchorString>sample string 8</anchorString>
            <anchorUnits>sample string 11</anchorUnits>
            <anchorXOffset>sample string 9</anchorXOffset>
            <anchorYOffset>sample string 10</anchorYOffset>
            <conditionalParentLabel>sample string 19</conditionalParentLabel>
            <conditionalParentValue>sample string 20</conditionalParentValue>
            <customTabId>sample string 21</customTabId>
            <documentId>sample string 3</documentId>
            <mergeField />
            <pageNumber>sample string 5</pageNumber>
            <recipientId>sample string 4</recipientId>
            <tabId>sample string 16</tabId>
            <tabOrder>sample string 22</tabOrder>
            <templateLocked>sample string 17</templateLocked>
            <templateRequired>sample string 18</templateRequired>
            <xPosition>sample string 6</xPosition>
            <yPosition>sample string 7</yPosition>
            <locked>sample string 2</locked>
            <required>sample string 1</required>
          </notarize>
        </notarizeTabs>
        <noteTabs>
          <note>
            <anchorCaseSensitive>sample string 23</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 25</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 22</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 24</anchorMatchWholeWord>
            <anchorString>sample string 18</anchorString>
            <anchorUnits>sample string 21</anchorUnits>
            <anchorXOffset>sample string 19</anchorXOffset>
            <anchorYOffset>sample string 20</anchorYOffset>
            <conditionalParentLabel>sample string 29</conditionalParentLabel>
            <conditionalParentValue>sample string 30</conditionalParentValue>
            <customTabId>sample string 31</customTabId>
            <documentId>sample string 13</documentId>
            <mergeField />
            <pageNumber>sample string 15</pageNumber>
            <recipientId>sample string 14</recipientId>
            <tabId>sample string 26</tabId>
            <tabOrder>sample string 32</tabOrder>
            <templateLocked>sample string 27</templateLocked>
            <templateRequired>sample string 28</templateRequired>
            <xPosition>sample string 16</xPosition>
            <yPosition>sample string 17</yPosition>
            <bold>sample string 8</bold>
            <font>sample string 7</font>
            <fontColor>sample string 11</fontColor>
            <fontSize>sample string 12</fontSize>
            <italic>sample string 9</italic>
            <tabLabel>sample string 6</tabLabel>
            <underline>sample string 10</underline>
            <height>2</height>
            <name>sample string 5</name>
            <shared>sample string 3</shared>
            <value>sample string 4</value>
            <width>1</width>
          </note>
        </noteTabs>
        <numberTabs>
          <number>
            <anchorCaseSensitive>sample string 35</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 37</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 34</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 36</anchorMatchWholeWord>
            <anchorString>sample string 30</anchorString>
            <anchorUnits>sample string 33</anchorUnits>
            <anchorXOffset>sample string 31</anchorXOffset>
            <anchorYOffset>sample string 32</anchorYOffset>
            <conditionalParentLabel>sample string 41</conditionalParentLabel>
            <conditionalParentValue>sample string 42</conditionalParentValue>
            <customTabId>sample string 43</customTabId>
            <documentId>sample string 25</documentId>
            <mergeField />
            <pageNumber>sample string 27</pageNumber>
            <recipientId>sample string 26</recipientId>
            <tabId>sample string 38</tabId>
            <tabOrder>sample string 44</tabOrder>
            <templateLocked>sample string 39</templateLocked>
            <templateRequired>sample string 40</templateRequired>
            <xPosition>sample string 28</xPosition>
            <yPosition>sample string 29</yPosition>
            <bold>sample string 20</bold>
            <font>sample string 19</font>
            <fontColor>sample string 23</fontColor>
            <fontSize>sample string 24</fontSize>
            <italic>sample string 21</italic>
            <tabLabel>sample string 18</tabLabel>
            <underline>sample string 22</underline>
            <concealValueOnDocument>sample string 15</concealValueOnDocument>
            <disableAutoSize>sample string 16</disableAutoSize>
            <locked>sample string 14</locked>
            <maxLength>17</maxLength>
            <name>sample string 9</name>
            <originalValue>sample string 11</originalValue>
            <required>sample string 13</required>
            <value>sample string 10</value>
            <width>12</width>
            <requireAll>sample string 8</requireAll>
            <requireInitialOnSharedChange>sample string 6</requireInitialOnSharedChange>
            <senderRequired>sample string 7</senderRequired>
            <shared>sample string 5</shared>
            <validationMessage>sample string 4</validationMessage>
            <validationPattern>sample string 3</validationPattern>
            <formula>sample string 2</formula>
            <isPaymentAmount>sample string 1</isPaymentAmount>
          </number>
        </numberTabs>
        <radioGroupTabs>
          <radioGroup>
            <conditionalParentLabel>sample string 5</conditionalParentLabel>
            <conditionalParentValue>sample string 6</conditionalParentValue>
            <documentId>sample string 1</documentId>
            <groupName>sample string 7</groupName>
            <radios>
              <radio>
                <anchorCaseSensitive>sample string 9</anchorCaseSensitive>
                <anchorHorizontalAlignment>sample string 11</anchorHorizontalAlignment>
                <anchorIgnoreIfNotPresent>sample string 8</anchorIgnoreIfNotPresent>
                <anchorMatchWholeWord>sample string 10</anchorMatchWholeWord>
                <anchorString>sample string 4</anchorString>
                <anchorUnits>sample string 7</anchorUnits>
                <anchorXOffset>sample string 5</anchorXOffset>
                <anchorYOffset>sample string 6</anchorYOffset>
                <locked>sample string 16</locked>
                <pageNumber>sample string 1</pageNumber>
                <required>sample string 15</required>
                <selected>sample string 13</selected>
                <tabId>sample string 14</tabId>
                <tabOrder>sample string 17</tabOrder>
                <value>sample string 12</value>
                <xPosition>sample string 2</xPosition>
                <yPosition>sample string 3</yPosition>
              </radio>
            </radios>
            <recipientId>sample string 2</recipientId>
            <requireAll>sample string 10</requireAll>
            <requireInitialOnSharedChange>sample string 9</requireInitialOnSharedChange>
            <shared>sample string 8</shared>
            <templateLocked>sample string 3</templateLocked>
            <templateRequired>sample string 4</templateRequired>
          </radioGroup>
        </radioGroupTabs>
        <signHereTabs>
          <signHere>
            <anchorCaseSensitive>sample string 15</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 17</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 14</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 16</anchorMatchWholeWord>
            <anchorString>sample string 10</anchorString>
            <anchorUnits>sample string 13</anchorUnits>
            <anchorXOffset>sample string 11</anchorXOffset>
            <anchorYOffset>sample string 12</anchorYOffset>
            <conditionalParentLabel>sample string 21</conditionalParentLabel>
            <conditionalParentValue>sample string 22</conditionalParentValue>
            <customTabId>sample string 23</customTabId>
            <documentId>sample string 5</documentId>
            <mergeField>
              <allowSenderToEdit>sample string 4</allowSenderToEdit>
              <configurationType>sample string 1</configurationType>
              <path>sample string 2</path>
              <row>sample string 5</row>
              <writeBack>sample string 3</writeBack>
            </mergeField>
            <pageNumber>sample string 7</pageNumber>
            <recipientId>sample string 6</recipientId>
            <tabId>sample string 18</tabId>
            <tabOrder>sample string 24</tabOrder>
            <templateLocked>sample string 19</templateLocked>
            <templateRequired>sample string 20</templateRequired>
            <xPosition>sample string 8</xPosition>
            <yPosition>sample string 9</yPosition>
            <name>sample string 2</name>
            <optional>sample string 4</optional>
            <scaleValue>1.1</scaleValue>
            <tabLabel>sample string 3</tabLabel>
            <stampType>sample string 1</stampType>
          </signHere>
        </signHereTabs>
        <signerAttachmentTabs>
          <signerAttachment>
            <anchorCaseSensitive>sample string 14</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 16</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 13</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 15</anchorMatchWholeWord>
            <anchorString>sample string 9</anchorString>
            <anchorUnits>sample string 12</anchorUnits>
            <anchorXOffset>sample string 10</anchorXOffset>
            <anchorYOffset>sample string 11</anchorYOffset>
            <conditionalParentLabel>sample string 20</conditionalParentLabel>
            <conditionalParentValue>sample string 21</conditionalParentValue>
            <customTabId>sample string 22</customTabId>
            <documentId>sample string 4</documentId>
            <mergeField />
            <pageNumber>sample string 6</pageNumber>
            <recipientId>sample string 5</recipientId>
            <tabId>sample string 17</tabId>
            <tabOrder>sample string 23</tabOrder>
            <templateLocked>sample string 18</templateLocked>
            <templateRequired>sample string 19</templateRequired>
            <xPosition>sample string 7</xPosition>
            <yPosition>sample string 8</yPosition>
            <name>sample string 1</name>
            <optional>sample string 3</optional>
            <scaleValue>1.1</scaleValue>
            <tabLabel>sample string 2</tabLabel>
          </signerAttachment>
        </signerAttachmentTabs>
        <ssnTabs>
          <ssn>
            <anchorCaseSensitive>sample string 33</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 35</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 32</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 34</anchorMatchWholeWord>
            <anchorString>sample string 28</anchorString>
            <anchorUnits>sample string 31</anchorUnits>
            <anchorXOffset>sample string 29</anchorXOffset>
            <anchorYOffset>sample string 30</anchorYOffset>
            <conditionalParentLabel>sample string 39</conditionalParentLabel>
            <conditionalParentValue>sample string 40</conditionalParentValue>
            <customTabId>sample string 41</customTabId>
            <documentId>sample string 23</documentId>
            <mergeField />
            <pageNumber>sample string 25</pageNumber>
            <recipientId>sample string 24</recipientId>
            <tabId>sample string 36</tabId>
            <tabOrder>sample string 42</tabOrder>
            <templateLocked>sample string 37</templateLocked>
            <templateRequired>sample string 38</templateRequired>
            <xPosition>sample string 26</xPosition>
            <yPosition>sample string 27</yPosition>
            <bold>sample string 18</bold>
            <font>sample string 17</font>
            <fontColor>sample string 21</fontColor>
            <fontSize>sample string 22</fontSize>
            <italic>sample string 19</italic>
            <tabLabel>sample string 16</tabLabel>
            <underline>sample string 20</underline>
            <concealValueOnDocument>sample string 13</concealValueOnDocument>
            <disableAutoSize>sample string 14</disableAutoSize>
            <locked>sample string 12</locked>
            <maxLength>15</maxLength>
            <name>sample string 7</name>
            <originalValue>sample string 9</originalValue>
            <required>sample string 11</required>
            <value>sample string 8</value>
            <width>10</width>
            <requireAll>sample string 6</requireAll>
            <requireInitialOnSharedChange>sample string 4</requireInitialOnSharedChange>
            <senderRequired>sample string 5</senderRequired>
            <shared>sample string 3</shared>
            <validationMessage>sample string 2</validationMessage>
            <validationPattern>sample string 1</validationPattern>
          </ssn>
        </ssnTabs>
        <textTabs>
          <text>
            <anchorCaseSensitive>sample string 36</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 38</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 35</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 37</anchorMatchWholeWord>
            <anchorString>sample string 31</anchorString>
            <anchorUnits>sample string 34</anchorUnits>
            <anchorXOffset>sample string 32</anchorXOffset>
            <anchorYOffset>sample string 33</anchorYOffset>
            <conditionalParentLabel>sample string 42</conditionalParentLabel>
            <conditionalParentValue>sample string 43</conditionalParentValue>
            <customTabId>sample string 44</customTabId>
            <documentId>sample string 26</documentId>
            <mergeField />
            <pageNumber>sample string 28</pageNumber>
            <recipientId>sample string 27</recipientId>
            <tabId>sample string 39</tabId>
            <tabOrder>sample string 45</tabOrder>
            <templateLocked>sample string 40</templateLocked>
            <templateRequired>sample string 41</templateRequired>
            <xPosition>sample string 29</xPosition>
            <yPosition>sample string 30</yPosition>
            <bold>sample string 21</bold>
            <font>sample string 20</font>
            <fontColor>sample string 24</fontColor>
            <fontSize>sample string 25</fontSize>
            <italic>sample string 22</italic>
            <tabLabel>sample string 19</tabLabel>
            <underline>sample string 23</underline>
            <concealValueOnDocument>sample string 16</concealValueOnDocument>
            <disableAutoSize>sample string 17</disableAutoSize>
            <locked>sample string 15</locked>
            <maxLength>18</maxLength>
            <name>sample string 10</name>
            <originalValue>sample string 12</originalValue>
            <required>sample string 14</required>
            <value>sample string 11</value>
            <width>13</width>
            <requireAll>sample string 9</requireAll>
            <requireInitialOnSharedChange>sample string 7</requireInitialOnSharedChange>
            <senderRequired>sample string 8</senderRequired>
            <shared>sample string 6</shared>
            <validationMessage>sample string 5</validationMessage>
            <validationPattern>sample string 4</validationPattern>
            <formula>sample string 3</formula>
            <height>1</height>
            <isPaymentAmount>sample string 2</isPaymentAmount>
          </text>
        </textTabs>
        <titleTabs>
          <title>
            <anchorCaseSensitive>sample string 27</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 29</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 26</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 28</anchorMatchWholeWord>
            <anchorString>sample string 22</anchorString>
            <anchorUnits>sample string 25</anchorUnits>
            <anchorXOffset>sample string 23</anchorXOffset>
            <anchorYOffset>sample string 24</anchorYOffset>
            <conditionalParentLabel>sample string 33</conditionalParentLabel>
            <conditionalParentValue>sample string 34</conditionalParentValue>
            <customTabId>sample string 35</customTabId>
            <documentId>sample string 17</documentId>
            <mergeField />
            <pageNumber>sample string 19</pageNumber>
            <recipientId>sample string 18</recipientId>
            <tabId>sample string 30</tabId>
            <tabOrder>sample string 36</tabOrder>
            <templateLocked>sample string 31</templateLocked>
            <templateRequired>sample string 32</templateRequired>
            <xPosition>sample string 20</xPosition>
            <yPosition>sample string 21</yPosition>
            <bold>sample string 12</bold>
            <font>sample string 11</font>
            <fontColor>sample string 15</fontColor>
            <fontSize>sample string 16</fontSize>
            <italic>sample string 13</italic>
            <tabLabel>sample string 10</tabLabel>
            <underline>sample string 14</underline>
            <concealValueOnDocument>sample string 7</concealValueOnDocument>
            <disableAutoSize>sample string 8</disableAutoSize>
            <locked>sample string 6</locked>
            <maxLength>9</maxLength>
            <name>sample string 1</name>
            <originalValue>sample string 3</originalValue>
            <required>sample string 5</required>
            <value>sample string 2</value>
            <width>4</width>
          </title>
        </titleTabs>
        <viewTabs>
          <view>
            <anchorCaseSensitive>sample string 23</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 25</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 22</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 24</anchorMatchWholeWord>
            <anchorString>sample string 18</anchorString>
            <anchorUnits>sample string 21</anchorUnits>
            <anchorXOffset>sample string 19</anchorXOffset>
            <anchorYOffset>sample string 20</anchorYOffset>
            <conditionalParentLabel>sample string 29</conditionalParentLabel>
            <conditionalParentValue>sample string 30</conditionalParentValue>
            <customTabId>sample string 31</customTabId>
            <documentId>sample string 13</documentId>
            <mergeField />
            <pageNumber>sample string 15</pageNumber>
            <recipientId>sample string 14</recipientId>
            <tabId>sample string 26</tabId>
            <tabOrder>sample string 32</tabOrder>
            <templateLocked>sample string 27</templateLocked>
            <templateRequired>sample string 28</templateRequired>
            <xPosition>sample string 16</xPosition>
            <yPosition>sample string 17</yPosition>
            <bold>sample string 8</bold>
            <font>sample string 7</font>
            <fontColor>sample string 11</fontColor>
            <fontSize>sample string 12</fontSize>
            <italic>sample string 9</italic>
            <tabLabel>sample string 6</tabLabel>
            <underline>sample string 10</underline>
            <buttonText>sample string 1</buttonText>
            <height>3</height>
            <required>sample string 4</required>
            <requiredRead>sample string 5</requiredRead>
            <width>2</width>
          </view>
        </viewTabs>
        <zipTabs>
          <zip>
            <anchorCaseSensitive>sample string 34</anchorCaseSensitive>
            <anchorHorizontalAlignment>sample string 36</anchorHorizontalAlignment>
            <anchorIgnoreIfNotPresent>sample string 33</anchorIgnoreIfNotPresent>
            <anchorMatchWholeWord>sample string 35</anchorMatchWholeWord>
            <anchorString>sample string 29</anchorString>
            <anchorUnits>sample string 32</anchorUnits>
            <anchorXOffset>sample string 30</anchorXOffset>
            <anchorYOffset>sample string 31</anchorYOffset>
            <conditionalParentLabel>sample string 40</conditionalParentLabel>
            <conditionalParentValue>sample string 41</conditionalParentValue>
            <customTabId>sample string 42</customTabId>
            <documentId>sample string 24</documentId>
            <mergeField />
            <pageNumber>sample string 26</pageNumber>
            <recipientId>sample string 25</recipientId>
            <tabId>sample string 37</tabId>
            <tabOrder>sample string 43</tabOrder>
            <templateLocked>sample string 38</templateLocked>
            <templateRequired>sample string 39</templateRequired>
            <xPosition>sample string 27</xPosition>
            <yPosition>sample string 28</yPosition>
            <bold>sample string 19</bold>
            <font>sample string 18</font>
            <fontColor>sample string 22</fontColor>
            <fontSize>sample string 23</fontSize>
            <italic>sample string 20</italic>
            <tabLabel>sample string 17</tabLabel>
            <underline>sample string 21</underline>
            <concealValueOnDocument>sample string 14</concealValueOnDocument>
            <disableAutoSize>sample string 15</disableAutoSize>
            <locked>sample string 13</locked>
            <maxLength>16</maxLength>
            <name>sample string 8</name>
            <originalValue>sample string 10</originalValue>
            <required>sample string 12</required>
            <value>sample string 9</value>
            <width>11</width>
            <requireAll>sample string 7</requireAll>
            <requireInitialOnSharedChange>sample string 5</requireInitialOnSharedChange>
            <senderRequired>sample string 6</senderRequired>
            <shared>sample string 4</shared>
            <validationMessage>sample string 3</validationMessage>
            <validationPattern>sample string 2</validationPattern>
            <useDash4>sample string 1</useDash4>
          </zip>
        </zipTabs>
      </tabs>
    </templateRole>
  </templateRoles>
</envelopeDefinition> 
Response
<envelopeDocumentsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <envelopeDocuments>
    <envelopeDocument>
      <attachmentTabId>sample string 8</attachmentTabId>
      <authoritativeCopy>sample string 13</authoritativeCopy>
      <availableDocumentTypes>
        <signatureType>
          <isDefault>sample string 2</isDefault>
          <type>sample string 1</type>
        </signatureType>
      </availableDocumentTypes>
      <containsPdfFormFields>sample string 7</containsPdfFormFields>
      <display>sample string 9</display>
      <documentFields>
        <nameValue />
      </documentFields>
      <documentGroup>sample string 12</documentGroup>
      <documentId>sample string 1</documentId>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <includeInDownload>sample string 10</includeInDownload>
      <name>sample string 2</name>
      <order>sample string 5</order>
      <pages>sample string 6</pages>
      <signerMustAcknowledge>sample string 11</signerMustAcknowledge>
      <type>sample string 3</type>
      <uri>sample string 4</uri>
    </envelopeDocument>
  </envelopeDocuments>
  <envelopeId>sample string 1</envelopeId>
</envelopeDocumentsResult> 
}} />