Updates recipients in a template.

You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.

Request

HTTP request

PUT /v2/accounts/{accountId}/templates/{templateId}/recipients

Parameters

Parameter name Value Description
Path parameters
accountId string

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

templateId string

The ID of the template being accessed.

Optional query parameters
resend_envelope string

When set to true, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Templates::updateRecipients

Definitions Expand All | Collapse All

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.

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.

addressInformation

Contains address information.

city string

The city associated with the address.

country string

Specifies the country associated with the address.

fax string

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

phone string

A phone number associated with the address.

state string

The state or province associated with the address.

street1 string

The first line of the address.

street2 string

The second line of the address (optional).

zip string

The zip or postal code associated with the address.

addressInformationInput

Contains address input information.

addressInformation addressInformation

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
displayLevelCode string

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

  • ReadOnly
  • Editable
  • DoNotDisplay
receiveInResponse string

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

agent

Contains information about agent recipients.

accessCode string

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.

addAccessCodeToEmail string

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.

clientUserId string

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
[string]

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.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string

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

Maximum length: 100 characters.

emailNotification recipientEmailNotification

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.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

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]]

errorDetails errorDetails
excludedDocuments
[string]

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.

faxNumber string

Reserved:

idCheckConfigurationName string

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.

idCheckInformationInput 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.
inheritEmailNotificationConfiguration string

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.

name string
note string

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.

phoneAuthentication 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.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

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

recipientIdGuid string
requireIdLookup string

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

roleName string

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

This is required when working with template recipients.

routingOrder string

Specifies the routing order of the recipient in the envelope.

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

sentDateTime string

The date and time the envelope was sent.

signedDateTime string

Reserved: For DocuSign use only.

signingGroupId string
signingGroupName string

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.

smsAuthentication recipientSMSAuthentication

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.

status string

Recipient status.

templateLocked string

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

templateRequired string

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

totalTabCount string
userId string

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.

approve

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

buttonText string

Specifies the approval text displayed in the tab.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

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
fontColor string

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

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

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
height integer (int32)

Height of the tab in pixels.

italic string

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

mergeField mergeField
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

authenticationStatus

Contains information about the authentication status.

accessCodeResult eventResult
ageVerifyResult eventResult
anySocialIDResult eventResult
facebookResult eventResult
googleResult eventResult
idLookupResult eventResult
idQuestionsResult eventResult
linkedinResult eventResult
liveIDResult eventResult
ofacResult eventResult
openIDResult eventResult
phoneAuthResult eventResult
salesforceResult eventResult
signatureProviderResult eventResult
smsAuthResult eventResult
sTANPinResult eventResult
twitterResult eventResult
yahooResult eventResult

carbonCopy

accessCode string

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.

addAccessCodeToEmail string

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.

clientUserId string

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
[string]

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.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string

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

Maximum length: 100 characters.

emailNotification recipientEmailNotification

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.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

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]]

errorDetails errorDetails
excludedDocuments
[string]

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.

faxNumber string

Reserved:

idCheckConfigurationName string

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.

idCheckInformationInput 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.
inheritEmailNotificationConfiguration string

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.

name string

legal name of the recipient.

Maximum Length: 100 characters.

note string

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.

phoneAuthentication 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.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

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

recipientIdGuid string
requireIdLookup string

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

roleName string

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

This is required when working with template recipients.

routingOrder string

Specifies the routing order of the recipient in the envelope.

samlAuthentication recipientSAMLAuthentication
sentDateTime string

The date and time the envelope was sent.

signedDateTime string

Reserved: For DocuSign use only.

signingGroupId string
signingGroupName string

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.

smsAuthentication recipientSMSAuthentication

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.

status string

Recipient status.

templateLocked string

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

templateRequired string

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

totalTabCount string
userId string

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.

certifiedDelivery

accessCode string

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.

addAccessCodeToEmail string

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.

clientUserId string

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
[string]

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.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string
emailNotification recipientEmailNotification

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.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

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]]

errorDetails errorDetails
excludedDocuments
[string]

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.

faxNumber string

Reserved:

idCheckConfigurationName string

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.

idCheckInformationInput 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.
inheritEmailNotificationConfiguration string

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.

name string
note string

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.

phoneAuthentication 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.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

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

recipientIdGuid string
requireIdLookup string

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

roleName string

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

This is required when working with template recipients.

routingOrder string

Specifies the routing order of the recipient in the envelope.

samlAuthentication recipientSAMLAuthentication
sentDateTime string

The date and time the envelope was sent.

signedDateTime string

Reserved: For DocuSign use only.

signingGroupId string
signingGroupName string

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.

smsAuthentication recipientSMSAuthentication

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.

status string

Recipient status.

templateLocked string

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

templateRequired string

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

totalTabCount string
userId string

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.

checkbox

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

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
locked string

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

mergeField mergeField
name string

Specifies the tool tip text for the tab.

pageNumber string

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

recipientId string

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

required string

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

requireInitialOnSharedChange string

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

selected string

When set to true, the checkbox is selected.

shared string

When set to true, this custom tab is shared.

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

xPosition string

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

yPosition string

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

concealValueOnDocument string

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.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

disableAutoSize string

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.

documentId string

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

errorDetails errorDetails
font string

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
fontColor string

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

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

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
italic string

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

locked string

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

maxLength integer (int32)

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

mergeField mergeField
name string

Specifies the tool tip text for the tab.

originalValue string

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

pageNumber string

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

recipientId string

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

required string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

concealValueOnDocument string

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.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

disableAutoSize string

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.

documentId string

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

errorDetails errorDetails
font string

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
fontColor string

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

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

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
italic string

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

locked string

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

maxLength integer (int32)

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

mergeField mergeField
name string
originalValue string

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

pageNumber string

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

recipientId string

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

requireAll string

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

required string

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

requireInitialOnSharedChange string

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

senderRequired string

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.

shared string

When set to true, this custom tab is shared.

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

validationMessage string

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

validationPattern string

A regular expressionn used to validate input for the tab.

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

documentId string

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

errorDetails errorDetails
font string

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
fontColor string

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

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

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
italic string

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

mergeField mergeField
name string
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

value string

Specifies the value of the tab.

xPosition string

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

yPosition string

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.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

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

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

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

anchorXOffset string

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

anchorYOffset string

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

bold string

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

buttonText string

Specifies the decline text displayed in the tab.

conditionalParentLabel string

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

conditionalParentValue string

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.

customTabId string

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.

declineReason string

The reason the recipient declined the document.

documentId string

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

errorDetails errorDetails
font string

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
fontColor string

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

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

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
height integer (int32)

Height of the tab in pixels.

italic string

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

mergeField mergeField
pageNumber string

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

recipientId string

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

status string

Tab status

tabId string

The unique identifier for the tab.

tabLabel string

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.

tabOrder string

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.

templateLocked string

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

templateRequired string

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

underline string

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

width integer (int32)

Width of the tab in pixels.

xPosition string

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

yPosition string

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
dateOfBirth string

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

displayLevelCode string

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

  • ReadOnly
  • Editable
  • DoNotDisplay
receiveInResponse string

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

documentVisibility

documentId string

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

errorDetails errorDetails
recipientId string

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

rights string
visible string

editor

accessCode string

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.

addAccessCodeToEmail string

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.

clientUserId string

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
[string]

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.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string

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

Maximum length: 100 characters.

emailNotification recipientEmailNotification

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.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

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]]

errorDetails errorDetails
faxNumber string

Reserved:

idCheckConfigurationName string

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.

idCheckInformationInput 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.
inheritEmailNotificationConfiguration string

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.

name string

legal name of the recipient.

Maximum Length: 100 characters.

note string

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.

phoneAuthentication 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.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

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

recipientIdGuid string
requireIdLookup string

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