__INITIALS__
This method is deprecated in API v2.1.
Use Envelopes::listStatusChanges instead.
Retrieves a list of items that match the criteria specified in the query.
If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.
GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}
Parameter Name | Value | Description |
---|---|---|
Path Parameters | ||
accountId | string | The external account number (int) or account ID GUID. |
searchFolderId | string | Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature. |
Optional Query Parameters | ||
all | string | Specifies that all envelopes that match the criteria are returned. |
count | string | Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100. |
from_date | string | Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days. |
include_recipients | string | When set to true, the recipient information is returned in the response. |
order | string | Specifies the order in which the list is returned. Valid values are: |
order_by | string | Specifies the property used to sort the list. Valid values are: |
start_position | string | Specifies the the starting location in the result set of the items that are returned. |
to_date | string | Specifies the end of the date range to return. |
Code | Description | Reference |
---|---|---|
200 | Successful response. | folderItemResponse |
400 | Error encountered. | errorDetails |
Contains address information. | ||
address1 | string | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | The second line of the user's address. Maximum length: 100 characters. |
city | string | The user's city. |
country | string | The user's country. |
fax | string | A fax number associated with the address, if one is available. |
phone | string | A phone number associated with the address. |
postalCode | string | The user's postal code. |
stateOrProvince | string | The user's state or province. |
addressInformation | addressInformation | A complex type that contains the following information for the new account: The maximum characters for the strings are:
Note: If country is US (United States), |
displayLevelCode | string | Specifies the display level for the recipient. Valid values are:
|
receiveInResponse | string | A Boolean value that specifies whether the information must be returned in the response. |
Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order. | ||
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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, 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 Note: if the Maximum length: 100 characters. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The email id of the agent. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
excludedDocuments | [array] | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the 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 for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
firstName | string | The recipient's first name. Maximum Length: 50 characters. |
firstNameMetadata | propertyMetadata | Metadata that indicates whether the |
fullName | string | Reserved for DocuSign. |
fullNameMetadata | propertyMetadata | Reserved for DocuSign. |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
lastName | string | The recipient's last name. |
lastNameMetadata | propertyMetadata | Metadata that indicates whether the |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signedDateTime | string | Reserved for DocuSign. |
signingGroupId | string | Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
signingGroupIdMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupName | string | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupUsers | [userInfo] | A complex type that contains information about users in the signing group. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The recipient's status. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
A tab that allows the recipient to approve documents without placing a signature or initials on the document. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
buttonText | string | Specifies the approval text that displays in the tab. |
buttonTextMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
customTabId | string | The DocuSign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
pageNumber | string | Specifies the page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A complex element that contains information about a user's authentication status. | ||
accessCodeResult | eventResult | The result of a user's attempt to authenticate by using an access code. It returns:
|
ageVerifyResult | eventResult | The result of an age verification check. It returns:
|
anySocialIDResult | eventResult | Deprecated. |
facebookResult | eventResult | Deprecated. |
googleResult | eventResult | Deprecated. |
identityVerificationResult | eventResult | The result of an Identity Verification workflow. |
idLookupResult | eventResult | The result of an ID lookup authentication check. It returns:
|
idQuestionsResult | eventResult | The result of the user's answers to ID challenge questions. It returns:
|
linkedinResult | eventResult | Deprecated. |
liveIDResult | eventResult | Deprecated. |
ofacResult | eventResult | The result of an Office of Foreign Asset Control (OFAC) check. It returns:
|
openIDResult | eventResult | Deprecated. |
phoneAuthResult | eventResult | The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns:
|
salesforceResult | eventResult | Success/failure result of authentication using sign-in with a Salesforce account. It returns:
|
signatureProviderResult | eventResult | The result of the user's attempt to authenticate by using a signature provider. |
smsAuthResult | eventResult | The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone. |
sTANPinResult | eventResult | The result of a Student Authentication Network (STAN) authentication check. It returns:
|
twitterResult | eventResult | Deprecated. |
yahooResult | eventResult | Deprecated. |
Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. | ||
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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of Access Code on the recipient. |
agentCanEditEmail | string | Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. |
agentCanEditName | string | Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. |
clientUserId | string | Not applicable for Carbon Copy recipients. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
excludedDocuments | [array] | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the 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 for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
firstName | string | The recipient's first name. Maximum Length: 50 characters. |
firstNameMetadata | propertyMetadata | Metadata that indicates whether the |
fullName | string | Reserved for DocuSign. |
fullNameMetadata | propertyMetadata | Reserved for DocuSign. |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
lastName | string | The recipient's last name. |
lastNameMetadata | propertyMetadata | Metadata that indicates whether the |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signedDateTime | string | Reserved for DocuSign. |
signingGroupId | string | Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
signingGroupIdMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupName | string | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupUsers | [userInfo] | A complex type that contains information about users in the signing group. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The recipient's status. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
tabs | EnvelopeRecipientTabs | A list of |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. | ||
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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of Access Code on the recipient. |
agentCanEditEmail | string | Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. |
agentCanEditName | string | Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. |
clientUserId | string | Specifies whether the recipient is embedded or remote. If the Note: if the Maximum length: 100 characters. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The recipient's email address. |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
excludedDocuments | [array] | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the 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 for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
firstName | string | The recipient's first name. Maximum Length: 50 characters. |
firstNameMetadata | propertyMetadata | Metadata that indicates whether the |
fullName | string | Reserved for DocuSign. |
fullNameMetadata | propertyMetadata | Reserved for DocuSign. |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
lastName | string | The recipient's last name. |
lastNameMetadata | propertyMetadata | Metadata that indicates whether the |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signedDateTime | string | Reserved for DocuSign. |
signingGroupId | string | Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
signingGroupIdMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupName | string | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupUsers | [userInfo] | A complex type that contains information about users in the signing group. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The status of the recipient. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
A tab that allows the recipient to select a yes/no (on/off) option. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
customTabId | string | The DocuSign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | This property does not apply to |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
requireInitialOnSharedChange | string | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | propertyMetadata | Metadata that indicates whether the |
selected | string | When true, the checkbox is selected. |
selectedMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When true, this tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
comments | [Comments] | An array of comment tabs that contain information about users' comments on documents. |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
pageNumber | string | The page number being accessed. |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
threadId | string | The unique identifier for the comment thread. |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A tab that displays the recipient's company name. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
disableAutoSizeMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
maxLength | string | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
originalValue | string | The initial value of the tab when it was sent to the recipient. |
originalValueMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
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 | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
disableAutoSizeMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
maxLength | string | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
originalValue | string | The initial value of the tab when it was sent to the recipient. |
originalValueMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
requireAll | string | When set to true and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
requireInitialOnSharedChange | string | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
senderRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, this custom tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
validationMessage | string | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | propertyMetadata | Metadata that indicates whether the |
validationPattern | string | A regular expression used to validate input for the tab. |
validationPatternMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A tab that displays the date that the recipient signed the document. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
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 | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
buttonText | string | Specifies the decline text displayed in the tab. |
buttonTextMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
declineReason | string | The reason the recipient declined the document. |
declineReasonMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
dateOfBirth | string | Specifies the recipient's date, month, and year of birth. |
displayLevelCode | string | Specifies the display level for the recipient. Valid values are:
|
receiveInResponse | string | A Boolean value that specifies whether the information must be returned in the response. |
This object configures a recipient's read/write access to a document. | ||
documentId | string | The |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
rights | string | Indicates whether the document is editable:
|
visible | string | When true, the document is visible to the recipient. |
A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining 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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, 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 Note: if the Maximum length: 100 characters. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
faxNumber | string | Reserved for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
firstName | string | The recipient's first name. Maximum Length: 50 characters. |
firstNameMetadata | propertyMetadata | Metadata that indicates whether the |
fullName | string | Reserved for DocuSign. |
fullNameMetadata | propertyMetadata | Reserved for DocuSign. |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
lastName | string | The recipient's last name. |
lastNameMetadata | propertyMetadata | Metadata that indicates whether the |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signedDateTime | string | Reserved for DocuSign. |
signingGroupId | string | Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
signingGroupIdMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupName | string | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupUsers | [userInfo] | A complex type that contains information about users in the signing group. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The recipient's status. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
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. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
disableAutoSizeMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
maxLength | string | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
originalValue | string | The initial value of the tab when it was sent to the recipient. |
originalValueMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
requireAll | string | When set to true and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
requireInitialOnSharedChange | string | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
senderRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, this tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
validationMessage | string | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | propertyMetadata | Metadata that indicates whether the |
validationPattern | string | A regular expression used to validate input for the tab. |
validationPatternMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A tab that displays the recipient's email as entered in the recipient information. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
customTabId | string | The DocuSign-generated custom tab id for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located.
For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
This object describes errors that occur. It is only valid for responses and ignored in requests. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |
Information about the result of an event. | ||
eventTimestamp | string | Date/time of the event. |
failureDescription | string | Reason for failure, if the event failed. |
status | string | Event status. |
vendorFailureStatusCode | string | Failure status code, if the event failed. |
availabilty | string | |
featureName | string |
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. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
Information about folder item results. | ||
completedDateTime | string | If the item is an envelope, this is the UTC DateTime when the envelope was completed. |
createdDateTime | string | The UTC DateTime when the item was created. |
envelopeId | string | If the item is an envelope, this is the id of the envelope. |
envelopeUri | string | If the item is an envelope, this is the URI for retrieving it. |
expireDateTime | string | The date and time the envelope is set to expire. |
folderId | string | The id of the folder. |
folderUri | string | If the item is a subfolder, this is the URI for retrieving it. |
is21CFRPart11 | string | When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
ownerName | string | The name of the user who owns the folder. |
recipients | EnvelopeRecipients | An array of recipient objects that provides details about the recipients of the envelope. |
recipientsUri | string | Contains a URI for an endpoint that you can use to retrieve the recipients. |
senderCompany | string | The name of the sender's company. |
senderEmail | string | The sender's email address. |
senderName | string | The sender's name. |
senderUserId | string | The sender's id. |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
status | string | The status of the item. |
subject | string | The subject of the envelope. |
templateId | string | The id of the template. |
templateUri | string | The URI for retrieving the template. |
Results from a folder item request. | ||
endPosition | string | The last index position in the result set. |
folderItems | [folderItem_v2] | A list of the envelopes in the specified folder or folders. |
nextUri | string | The URI for the next chunk of records based on the search request. It is |
previousUri | string | The URI for the prior chunk of records based on the search request. It is |
resultSetSize | string | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the |
startPosition | string | The starting index position of the current result set. |
totalRows | string | The total number of items in the result. |
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 If a formula tab contains
a | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
disableAutoSizeMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
formula | string | Contains the formula for calculating the value of this tab. Use a tab's 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:
See Calculated Fields in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters |
formulaMetadata | propertyMetadata | Metadata indicating if the sender can edit the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
hidden | string | If this is a regular formula (no
If the formula is payment item (a
|
hiddenMetadata | propertyMetadata | Metadata that indicates whether the |
isPaymentAmount | string | 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. |
isPaymentAmountMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
maxLength | string | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
originalValue | string | The initial value of the tab when it was sent to the recipient. |
originalValueMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
paymentDetails | paymentDetails | This property indicates
that this formula tab
is a payment item. |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
requireAll | string | When set to true and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
requireInitialOnSharedChange | string | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | propertyMetadata | Metadata that indicates whether the |
roundDecimalPlaces | string | The number of decimal places to round to. |
roundDecimalPlacesMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
senderRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, this custom tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
validationMessage | string | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | propertyMetadata | Metadata that indicates whether the |
validationPattern | string | A regular expression used to validate input for the tab. |
validationPatternMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A tab that displays the recipient's full name. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
fillColor | string | The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a friendly CSS color name. |
lineColor | string | The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a friendly CSS color name. |
lineWeight | string | The line weight or thickness to use for the overlay. |
A complex element that contains input information related to a recipient ID check. | ||
addressInformationInput | addressInformationInput | An object that specifies recipient address information and how it is displayed. |
dobInformationInput | dobInformationInput | An object that specifies recipient date of birth information and how it is displayed. |
ssn4InformationInput | ssn4InformationInput | An object that specifies the last four digits of the recipient's Social Security Number (SSN). |
ssn9InformationInput | ssn9InformationInput | An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response. |
A tab that allows the recipient to initial the document. May be optional. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
optional | string | When set to true, the recipient does not need to complete this tab to complete the signing process. |
optionalMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
scaleValue | string | Sets the size of the tab. This field accepts values from |
scaleValueMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
Contains information about an in-person recipient. This is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the EnvelopeRecipients resource. | ||
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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of Access Code on the recipient. |
autoNavigation | string | When true, autonavigation is set for the recipient. |
canSignOffline | string | When set to true, specifies that the signer can perform the signing ceremony offline. |
clientUserId | string | Specifies whether the recipient is embedded or remote. If the Note: if the Maximum length: 100 characters. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion. If this number is greater than |
creationReason | string | The reason why the recipient was created (for example, |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
defaultRecipient | string | When set to true, this is the default recipient for the envelope. This option is used when creating an envelope from a template. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The signer's email address in an eNotary flow. Use only when |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
excludedDocuments | [array] | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the 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 for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
hostEmail | string | The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. Required when Maximum Length: 100 characters. |
hostEmailMetadata | propertyMetadata | Metadata that indicates whether the |
hostName | string | The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. Required when Maximum Length: 100 characters. |
hostNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
inPersonSigningType | string | Specifies whether the envelope uses the eNotary feature. Valid values:
|
inPersonSigningTypeMetadata | propertyMetadata | Metadata that indicates whether the |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The signer's full legal name in an eNotary flow. Required when Maximum Length: 100 characters. |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
notaryHost | notaryHost | Information about the notary host. The following information is required when using the eNotary in-person signing flow:
|
note | string | A note sent to the in-person signer in the signing email. This note is visible only to this recipient. Maximum Length: 1000 characters. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
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. |
recipientSuppliesTabs | string | Specifies whether the recipient creates the tabs. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
requireSignerCertificate | string | 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 Set this parameter to The signer must be enrolled in the SAFE program to sign with a SAFE certificate. |
requireSignOnPaper | string | When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign. |
requireUploadSignature | string | When set to true, the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account. |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signatureInfo | 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. |
signedDateTime | string | Reserved for DocuSign. |
signerEmail | string | The in-person signer's email address. Required when Maximum Length: 100 characters. |
signerEmailMetadata | propertyMetadata | Metadata that indicates if the sender can edit the in-person signer's email address. |
signerFirstName | string | The signer's first name. |
signerFirstNameMetadata | propertyMetadata | Metadata that indicates if the |
signerLastName | string | The signer's last name. |
signerLastNameMetadata | propertyMetadata | Metadata that indicates whether the |
signerName | string | The in-person signer's full legal name. Required when Maximum Length: 100 characters. |
signerNameMetadata | propertyMetadata | Metadata that indicates whether the |
signInEachLocation | string | 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). |
signInEachLocationMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupId | string | Not applicable. You cannot use a signing group for an in-person signer. |
signingGroupIdMetadata | propertyMetadata | Not applicable. |
signingGroupName | string | Not applicable. |
signingGroupUsers | [userInfo] | Not applicable. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The recipient's status. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
tabs | EnvelopeRecipientTabs | A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. | ||
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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, 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 Note: if the Maximum length: 100 characters. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
excludedDocuments | [array] | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the 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 for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
firstName | string | The recipient's first name. Maximum Length: 50 characters. |
firstNameMetadata | propertyMetadata | Metadata that indicates whether the |
fullName | string | Reserved for DocuSign. |
fullNameMetadata | propertyMetadata | Reserved for DocuSign. |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
lastName | string | The recipient's last name. |
lastNameMetadata | propertyMetadata | Metadata that indicates whether the |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signedDateTime | string | Reserved for DocuSign. |
signingGroupId | string | Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
signingGroupIdMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupName | string | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupUsers | [userInfo] | A complex type that contains information about users in the signing group. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The recipient's status. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
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. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
This tab offers a list of options to choose from.
The | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
listSelectedValue | string | The value in the list that is selected by default. |
listSelectedValueMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
requireAll | string | When set to true and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
requireInitialOnSharedChange | string | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
senderRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, this custom tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | The value to use when the item is selected. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
One of the selectable items
in the | ||
selected | string | 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. |
selectedMetadata | propertyMetadata | Metadata that indicates whether the |
text | string | Specifies the text that is shown in the dropdown list. |
textMetadata | propertyMetadata | |
value | string | Specifies the value that is used when the list item is selected. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
addressFormat | string | |
calendarType | string | |
cultureName | string | |
currencyNegativeFormat | string | |
currencyPositiveFormat | string | |
customDateFormat | string | |
customTimeFormat | string | |
dateFormat | string | |
initialFormat | string | |
nameFormat | string | |
timeFormat | string | |
timeZone | string |
Contains information for transfering values between Salesforce data fields and DocuSign Tabs. | ||
allowSenderToEdit | string | When true, the sender can modify the value of the |
allowSenderToEditMetadata | propertyMetadata | Metadata that indicates if the sender can edit the |
configurationType | string | If merge fields are being used, specifies the type of the merge field. The only supported value is |
configurationTypeMetadata | propertyMetadata | Metadata that indicates if the sender can edit the |
path | string | Sets the object associated with the custom tab. Currently this is the Salesforce Object. |
pathExtended | [pathExtendedElement] | Reserved for DocuSign. |
pathExtendedMetadata | propertyMetadata | Reserved for DocuSign. |
pathMetadata | propertyMetadata | Metadata that indicates whether the |
row | string | Specifies the row number in a Salesforce table that the merge field value corresponds to. |
rowMetadata | propertyMetadata | Metadata that indicates whether the |
writeBack | string | When true, data entered into the merge field during Signing will update the mapped Salesforce field. |
writeBackMetadata | propertyMetadata | Metadata that indicates if the sender can edit the |
Describes information
about the | ||
amountInBaseUnit | string | The total payment amount in the currency's base unit. For example, for USD the base currency is one cent. |
currency | string | The three-letter ISO 4217 currency code for the payment. For example:
This is a read-only property. |
displayAmount | string | The payment amount as displayed
in the For example, if the payment amount
is USD 12.59,
the This is a read-only property. |
A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
pageNumber | string | The page number being accessed. |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
This object is used only when It describes information about the notary host. The following information is required when using the eNotary in-person signing flow:
| ||
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 If blank and the signer |
accessCodeMetadata | propertyMetadata | Metadata that indicates whether the |
addAccessCodeToEmail | string | Optional. When set to true, 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 Note: if the Maximum length: 100 characters. |
completedCount | string | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. |
customFields | [array] | An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each |
declinedDateTime | string | The date and time the recipient declined the document. |
declinedReason | string | The reason the recipient declined the document. |
deliveredDateTime | string | The date and time that the envelope was delivered to the recipient. |
deliveryMethod | string | Reserved for DocuSign. |
deliveryMethodMetadata | propertyMetadata | Reserved for DocuSign. |
documentVisibility | [documentVisibility] | A list of |
email | string | The notary's email address. Maximum Length: 100 characters. |
emailMetadata | propertyMetadata | Metadata that indicates whether the |
emailNotification | recipientEmailNotification | An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: You can set the |
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 It is important to understand 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 processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets If the Example:
|
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
faxNumber | string | Reserved for DocuSign. |
faxNumberMetadata | propertyMetadata | Reserved for DocuSign. |
hostRecipientId | string | |
idCheckConfigurationName | string | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:
Example: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | propertyMetadata | Metadata that indicates whether the |
idCheckInformationInput | idCheckInformationInput | An object that contains input information related to a recipient ID check. |
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. |
lockedRecipientPhoneAuthEditable | string | Reserved for DocuSign. |
lockedRecipientSmsEditable | string | Reserved for DocuSign. |
name | string | The notary's full legal name. Maximum Length: 100 characters. |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
note | string | A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters. |
noteMetadata | propertyMetadata | Metadata that indicates whether the |
phoneAuthentication | recipientPhoneAuthentication | When
|
recipientAttachments | [recipientAttachment] | Reserved for DocuSign. |
recipientAuthenticationStatus | authenticationStatus | Information about the recipient's authentication status. |
recipientFeatureMetadata | [featureAvailableMetadata] | Metadata about the features that are supported for the recipient type. |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientType | string | The recipient type, as specified by the following values:
|
recipientTypeMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
requireIdLookupMetadata | propertyMetadata | Metadata that indicates whether the |
roleName | string | Optional element. Specifies the role name associated with the recipient. |
routingOrder | string | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | propertyMetadata | Metadata that indicates whether the |
sentDateTime | string | The UTC DateTime when the envelope was sent. |
signedDateTime | string | Reserved for DocuSign. |
signingGroupId | string | Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
signingGroupIdMetadata | propertyMetadata | Metadata that indicates whether the |
signingGroupName | string | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupUsers | [userInfo] | A complex type that contains information about users in the signing group. |
smsAuthentication | recipientSMSAuthentication | When |
socialAuthentications | [socialAuthentication] | Deprecated. |
status | string | The recipient's status. Read only. Possible values:
|
statusCode | string | The code associated with the recipient's status. Read only. |
suppressEmails | string | When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
tabs | EnvelopeRecipientTabs | A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. |
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 | The total number of tabs in the documents. |
userId | string | The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, |
A tab that displays additional information, in the form of a note, for the recipient. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, this custom tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
A tab that allows the recipient to enter numbers and decimal (.) points. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
bold | string | When set to true, the information in the tab is bold. |
boldMetadata | propertyMetadata | Metadata that indicates whether the |
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 only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. |
concealValueOnDocumentMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
disableAutoSizeMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
font | string | The font to be used for the tab value. Supported fonts include:
|
fontColor | string | The font color to use for the information in the tab. Possible values are:
|
fontColorMetadata | propertyMetadata | Metadata that indicates whether the |
fontMetadata | propertyMetadata | Metadata that indicates whether the |
fontSize | string | The font size used for the information in the tab. Possible values are:
|
fontSizeMetadata | propertyMetadata | Metadata that indicates whether the |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
formula | string | Contains the formula for calculating the value of this tab. Use a tab's 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:
See Calculated Fields in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters |
formulaMetadata | propertyMetadata | Metadata indicating if the sender can edit the |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
isPaymentAmount | string | 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. |
isPaymentAmountMetadata | propertyMetadata | Metadata that indicates whether the |
italic | string | When set to true, the information in the tab is italic. |
italicMetadata | propertyMetadata | Metadata that indicates whether the |
localePolicy | localePolicyTab | Reserved for DocuSign. |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
maxLength | string | An optional value that describes the maximum length of the property when the property is a string. |
maxLengthMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
name | string | The name of the tab. For example, |
nameMetadata | propertyMetadata | Metadata that indicates whether the |
originalValue | string | The initial value of the tab when it was sent to the recipient. |
originalValueMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number on which the tab is located. For supplemental documents, this value must be |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
requireAll | string | When set to true and shared is true, information must be entered in this field to complete the envelope. |
requireAllMetadata | propertyMetadata | Metadata that indicates whether the |
required | string | When set to true, the signer is required to fill out this tab. |
requiredMetadata | propertyMetadata | Metadata that indicates whether the |
requireInitialOnSharedChange | string | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. |
requireInitialOnSharedChangeMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
senderRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, this custom tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. |
tabLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
underline | string | When set to true, the information in the tab is underlined. |
underlineMetadata | propertyMetadata | Metadata that indicates whether the |
validationMessage | string | The message displayed if the custom tab fails input validation (either custom of embedded). |
validationMessageMetadata | propertyMetadata | Metadata that indicates whether the |
validationPattern | string | A regular expression used to validate input for the tab. |
validationPatternMetadata | propertyMetadata | Metadata that indicates whether the |
value | string | Specifies the value of the tab. |
valueMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
name | string | |
type | string | |
typeName | string |
When a formula tab
has a | ||
allowedPaymentMethods | [array] | An array of accepted payment methods:
For example, if you only accept credit cards and ACH transfers, you would set this property to:
Do not specify |
chargeId | string | The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The |
currencyCode | string | Specifies the three-letter ISO 4217 currency code for the payment. Supported currencies are:
Specifying any other ISO 4217 code for payments is an error. |
currencyCodeMetadata | propertyMetadata | Metadata that indicates whether the |
customerId | string | The customer ID. |
customMetadata | string | This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under Description in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. The following example shows what the Description field of the transaction will look like:
|
customMetadataRequired | boolean | A sender-defined field that specifies whether custom metadata is required for the transaction. When set to true, custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account. |
gatewayAccountId | string | 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. |
gatewayAccountIdMetadata | propertyMetadata | Metadata that indicates whether the |
gatewayDisplayName | string | Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net. |
gatewayName | string | Name of the gateway connected to sender's DocuSign account. Possible values are:
|
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. |
paymentOption | string | This property specifies how the signer's collected payment details will be used. Possible values:
|
paymentSourceId | string | The payment source ID. |
status | string | This read-only property describes the status of a payment.
|
total | money | 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. |
A line item describes details about an individual line item in a payment request. | ||
amountReference | string | This is a the |
description | string | A sender-defined description of the line item. |
itemCode | string | This is the sender-defined SKU, inventory number, or other item code for the line item. |
name | string | This is a sender-defined product name, service name, or other designation for the line item. |
x1 | string | |
x2 | string | |
y1 | string | |
y2 | string |
This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string | Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches. |
anchorUnitsMetadata | propertyMetadata | Metadata that indicates whether the |
anchorXOffset | string | Specifies the X axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorXOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
anchorYOffset | string | Specifies the Y axis location of the tab in Note: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value. |
anchorYOffsetMetadata | propertyMetadata | Metadata that indicates whether the |
conditionalParentLabel | string | For conditional fields this is the |
conditionalParentLabelMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
conditionalParentValueMetadata | propertyMetadata | Metadata that indicates whether the |
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. |
customTabIdMetadata | propertyMetadata | Metadata that indicates whether the |
documentId | string | The |
documentIdMetadata | propertyMetadata | Metadata that indicates whether the |
errorDetails | errorDetails | This object describes errors that occur. It is only valid for responses and ignored in requests. |
formOrder | string | An integer specifying the order in which the guided form HTML should render. The order is relative to the |
formOrderMetadata | propertyMetadata | Metadata that indicates whether the |
formPageLabel | string | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. |
formPageLabelMetadata | propertyMetadata | Metadata that indicates whether the |
formPageNumber | string | An integer specifying the order in which to present the guided form pages. |
formPageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
graphicsContext | graphicsContext | Contains details about the style used for the strike through graphic. |
height | string | The height of the tab in pixels. |
heightMetadata | propertyMetadata | Metadata that indicates whether the |
locked | string | When set to true, the signer cannot change the data of the custom tab. |
lockedMetadata | propertyMetadata | Metadata that indicates whether the |
mergeField | mergeField | Contains the information necessary to map the tab to a field in SalesForce. |
mergeFieldXml | string | |
overlayType | string | The type of overlay to use. The API currently supports only the |
overlayTypeMetadata | propertyMetadata | Metadata that indicates whether the |
pageNumber | string | The page number being accessed. |
pageNumberMetadata | propertyMetadata | Metadata that indicates whether the |
polyLines | [polyLine] | An array of |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientIdGuid | string | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. |
recipientIdGuidMetadata | propertyMetadata | Metadata that indicates whether the |
recipientIdMetadata | propertyMetadata | Metadata that indicates whether the |
shared | string | When set to true, indicates that the tab is shared. |
sharedMetadata | propertyMetadata | Metadata that indicates whether the |
status | string | The status of the tab. Possible values are:
|
statusMetadata | propertyMetadata | Metadata that indicates whether the |
tabGroupLabels | [array] | An array of tab group labels that uniquely identify tab groups. To assign a tab to a |
tabGroupLabelsMetadata | propertyMetadata | Metadata that indicates whether the |
tabId | string | The unique identifier for the tab. |
tabIdMetadata | propertyMetadata | Metadata that indicates whether the |
tabLabel | string | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 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 |
tabOrderMetadata | propertyMetadata | Metadata that indicates whether the |
tabType | string | Indicates the type of tab (for example, |
tabTypeMetadata | propertyMetadata | Metadata that indicates whether the |
templateLocked | string | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateLockedMetadata | propertyMetadata | Metadata that indicates whether the |
templateRequired | string | When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
templateRequiredMetadata | propertyMetadata | Metadata that indicates whether the |
tooltip | string | The text of a tooltip that appears when a user hovers over a form field or tab. |
toolTipMetadata | propertyMetadata | Metadata that indicates whether the |
width | string | The width of the tab in pixels. |
widthMetadata | propertyMetadata | Metadata that indicates whether the |
xPosition | string | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. |
xPositionMetadata | propertyMetadata | Metadata that indicates whether the |
yPosition | string | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. |
yPositionMetadata | propertyMetadata | Metadata that indicates whether the |
Metadata about a property. | ||
options | [array] | An array of option strings supported by this setting. |
rights | string | Indicates whether the property is editable. Valid values are:
|
One of the selectable radio buttons
in the | ||
anchorCaseSensitive | string | This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the For example, when set to true, if the anchor string is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorCaseSensitiveMetadata | propertyMetadata | Metadata that indicates whether the |
anchorHorizontalAlignment | string | This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :
Note: You can only specify the value of this property in POST requests. |
anchorHorizontalAlignmentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorIgnoreIfNotPresent | string | When set to true, this tab is ignored if the |
anchorIgnoreIfNotPresentMetadata | propertyMetadata | Metadata that indicates whether the |
anchorMatchWholeWord | string | When set to true, the text string in a document must match the value of the For example, when set to true, if the input is This functionality uses the following rules:
Note: You can only specify the value of this property in POST requests. |
anchorMatchWholeWordMetadata | propertyMetadata | Metadata that indicates whether the |
anchorString | string | Specifies the string to find in the document and use as the basis for tab placement. |
anchorStringMetadata | propertyMetadata | Metadata that indicates whether the |
anchorTabProcessorVersion | string | Reserved for DocuSign. |
anchorTabProcessorVersionMetadata | propertyMetadata | Reserved for DocuSign. |
anchorUnits | string |