Folders: search

Contains address information.

The first line of the user's address. Maximum length: 100 characters.

The second line of the user's address. Maximum length: 100 characters.

The user's city. Maximum length: 40 characters.

The user's country. Maximum length: 50 characters.

A fax number associated with the address, if one is available.

A phone number associated with the address.

The user's postal code. Maximum length: 20 characters.

The user's state or province. Maximum length: 40 characters.

A complex type that contains the following information for the new account: address1, address2, city, country, fax, phone, postalCode and stateOrProvince.

The maximum characters for the strings are:

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

Note: If country is US (United States), stateOrProvince codes are validated. Otherwise, stateOrProvince is treated as a non-validated string used to specify a state, province, or region.

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

• ReadOnly
• Editable
• DoNotDisplay

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.

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

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

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

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

Metadata that indicates whether the accessCode property is editable. Read only.

Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of accessCode on the recipient.

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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. Read only.

An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

The date and time the recipient declined the document. Read only.

The reason the recipient declined the document. Read only.

The date and time that the envelope was delivered to the recipient. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

A list of documentVisibility objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true.

The email id of the agent. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

Metadata that indicates whether the email property is editable. Read only.

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

Note: You can set the emailNotification property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level emailSubject and emailBlurb.

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

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

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 EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

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

Example:

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

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

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

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

Reserved for DocuSign.

Reserved for DocuSign.

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

Metadata that indicates whether the firstame property is editable. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

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:

• Phone Auth $: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the phoneAuthentication object.
• SMS Auth $: The recipient must authenticate via SMS. You provide the phone number to use in the smsAuthentication object.
• ID Check $: The recipient must answer detailed security questions.

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.

Metadata that indicates whether the idCheckConfigurationName property is editable. Read only.

An object that contains input information related to a recipient ID check.

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.

The recipient's last name.

Metadata that indicates whether the lastName property is editable. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

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 firstName and lastName are set.

Metadata that indicates whether the name property is editable. Read only.

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.

Metadata that indicates whether the note property is editable. Read only.

When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements:

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

Reserved for DocuSign.

Information about the recipient's authentication status. Read only.

Metadata about the features that are supported for the recipient type. Read only.

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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. Read only.

The recipient type, as specified by the following values:

• agent: Agent recipients can add name and email information for recipients that appear after the agent in routing order.
• carbonCopy: 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. This type of recipient can be used in any routing order.
• certifiedDelivery: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
• editor: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
• inPersonSigner: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.
• intermediaries: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
• seal: Electronic seal recipients represent legal entities.
• signer: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
• witness: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.

Metadata that indicates whether the recipientType property is editable. Read only.

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

Metadata that indicates whether the requireIdLookup property is editable. Read only.

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

This property is required when you are working with template recipients.

Specifies the routing order of the recipient in the envelope.

Metadata that indicates whether the routingOrder property is editable. Read only.

The UTC DateTime when the envelope was sent. Read only.

Reserved for DocuSign.

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.

Metadata that indicates whether the signingGroupId property is editable. Read only.

Optional. The name of the signing group.

Maximum Length: 100 characters.

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

When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication.

Deprecated.

The recipient's status. Read only.

Possible values:

• autoresponded: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if Send-on-behalf-of is turned off for the account.
• completed: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.
• created: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of created).
• declined: The recipient declined to sign the document(s) in the envelope.
• delivered: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.
• faxPending: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.
• sent: The recipient has been sent an email notification that it is their turn to sign an envelope.
• signed: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to completed.

The code associated with the recipient's status. Read only.

When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.

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

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

The total number of tabs in the documents. Read only.

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, userId can represent another user whom the Administrator is accessing.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

• Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

  $~><|^+=

  For example, the anchorString water will match on the string Fetch a pail of water.

• Strings embedded in other strings are ignored during the matching process.

• In words that have dashes, the parts separated by dashes are treated as distinct words.

  Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

• Letters with accent marks are treated as distinct characters from their unaccented counterparts.

• For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

  Example: If the anchor string is i, then only one anchor tab is placed in skiing.

• Unlike punctuation, numbers are not ignored when finding anchor words.

  Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

Metadata that indicates whether the anchorCaseSensitive property is editable.

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

• left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
• right: Aligns the tab’s left side with the last character of the matching anchor word.

Note: You can only specify the value of this property in POST requests.

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

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

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When set to false, if the input is man then man, manpower, fireman, and penmanship will all match.

This functionality uses the following rules:

• Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

  $~><|^+=

  For example, the anchorString water will match on the string Fetch a pail of water.

• Strings embedded in other strings are ignored during the matching process.

• In words that have dashes, the parts separated by dashes are treated as distinct words.

  Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

• Letters with accent marks are treated as distinct characters from their unaccented counterparts.

• For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

  Example: If the anchor string is i, then only one anchor tab is placed in skiing.

• Unlike punctuation, numbers are not ignored when finding anchor words.

  Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

Metadata that indicates whether the anchorMatchWholeWord property is editable.

Specifies the string to find in the document and use as the basis for tab placement.

Metadata that indicates whether the anchorString property is editable.

Reserved for DocuSign.

Reserved for DocuSign.

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

Metadata that indicates whether the anchorUnits property is editable.

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

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.

Metadata that indicates whether the anchorXOffset property is editable.

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

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.

Metadata that indicates whether the anchorYOffset property is editable.

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

Metadata that indicates whether the bold property is editable.

Specifies the approval text that displays in the tab.

Metadata that indicates whether the buttonText property is editable.

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

Metadata that indicates whether the conditionalParentLabel property is editable.

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.

Metadata that indicates whether the conditionalParentValue property is editable.

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.

Metadata that indicates whether the customTabId property is editable.

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

Metadata that indicates whether the documentId property is editable.

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

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

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

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

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

Metadata that indicates whether the fontColor property is editable.

Metadata that indicates whether the font property is editable.

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

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

Metadata that indicates whether the fontSize property is editable.

An integer specifying the order in which the guided form HTML should render. The order is relative to the formPageLabel, the group by which to place the guided form HTML block.

Metadata that indicates whether the formOrder property is editable.

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.

Metadata that indicates whether the formPageLabel property is editable.

An integer specifying the order in which to present the guided form pages.

Metadata that indicates whether the fromPageNumber property is editable.

The height of the tab in pixels.

Metadata that indicates whether the height property is editable.

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

Metadata that indicates whether the italic property is editable.

Reserved for DocuSign.

Contains the information necessary to map the tab to a field in SalesForce.

Specifies the page number on which the tab is located. For supplemental documents, this value must be 1.

Metadata that indicates whether the pageNumber property is editable.

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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. Read only.

Metadata that indicates whether the recipientIdGuid property is editable.

Metadata that indicates whether the recipientId property is editable.

The status of the tab. Possible values are:

• active: The tab is active, but the recipient has not yet interacted with it.
• signed: The recipient signed the tab.
• declined: The recipient declined the envelope.
• na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

Metadata that indicates whether the status property is editable.

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

Metadata that indicates whether the tabGroupLabels property is editable.

The unique identifier for the tab.

Metadata that indicates whether the tabId property is editable.

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.

Metadata that indicates whether the tabLabel property is editable.

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

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

Metadata that indicates whether the tabOrder property is editable.

Indicates the type of tab (for example, signHere or initialHere).

Metadata that indicates whether the tabType property is editable.

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

Metadata that indicates whether the templateLocked property is editable.

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

Metadata that indicates whether the templateRequired property is editable.

The text of a tooltip that appears when a user hovers over a form field or tab.

Metadata that indicates whether the toolTip property is editable.

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

Metadata that indicates whether the underline property is editable.

The width of the tab in pixels.

Metadata that indicates whether the width property is editable.

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

Metadata that indicates whether the xPosition property is editable.

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

Metadata that indicates whether the yPosition property is editable.

A complex element that contains information about a user's authentication status.

The result of a user's attempt to authenticate by using an access code. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

The result of an age verification check. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Deprecated.

Deprecated.

Deprecated.

The result of an Identity Verification workflow.

The result of an ID lookup authentication check. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

The result of the user's answers to ID challenge questions. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Deprecated.

Deprecated.

The result of an Office of Foreign Asset Control (OFAC) check. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Deprecated.

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Success/failure result of authentication using sign-in with a Salesforce account. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

The result of the user's attempt to authenticate by using a signature provider.

The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.

The result of a Student Authentication Network (STAN) authentication check. It returns:

• Status: Pass or Fail.
• dateTime: The date and time that the event occurred.
• FailureDescription: A string containing the details about a failed authentication.
• VendorFailureStatusCode: A string containing the vendor's status code for a failed authentication.

Deprecated.

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.

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

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

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

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

Metadata that indicates whether the accessCode property is editable. Read only.

Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of accessCode on the recipient.

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.

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.

Not applicable for Carbon Copy recipients.

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. Read only.

An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

The date and time the recipient declined the document. Read only.

The reason the recipient declined the document. Read only.

The date and time that the envelope was delivered to the recipient. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

A list of documentVisibility objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true.

The recipient's email address. Notification of the document to sign is sent to this email address.

Maximum length: 100 characters.

Metadata that indicates whether the email property is editable. Read only.

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

Note: You can set the emailNotification property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level emailSubject and emailBlurb.

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

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

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 EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

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

Example:

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

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

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

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

Reserved for DocuSign.

Reserved for DocuSign.

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

Metadata that indicates whether the firstame property is editable. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

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:

• Phone Auth $: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the phoneAuthentication object.
• SMS Auth $: The recipient must authenticate via SMS. You provide the phone number to use in the smsAuthentication object.
• ID Check $: The recipient must answer detailed security questions.

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.

Metadata that indicates whether the idCheckConfigurationName property is editable. Read only.

An object that contains input information related to a recipient ID check.

Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

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.

The recipient's last name.

Metadata that indicates whether the lastName property is editable. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

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 firstName and lastName are set.

Metadata that indicates whether the name property is editable. Read only.

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.

Metadata that indicates whether the note property is editable. Read only.

When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements:

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

Reserved for DocuSign.

Information about the recipient's authentication status. Read only.

Metadata about the features that are supported for the recipient type. Read only.

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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. Read only.

The recipient type, as specified by the following values:

• agent: Agent recipients can add name and email information for recipients that appear after the agent in routing order.
• carbonCopy: 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. This type of recipient can be used in any routing order.
• certifiedDelivery: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
• editor: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
• inPersonSigner: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.
• intermediaries: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
• seal: Electronic seal recipients represent legal entities.
• signer: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
• witness: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.

Metadata that indicates whether the recipientType property is editable. Read only.

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

Metadata that indicates whether the requireIdLookup property is editable. Read only.

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

This property is required when you are working with template recipients.

Specifies the routing order of the recipient in the envelope.

Metadata that indicates whether the routingOrder property is editable. Read only.

The UTC DateTime when the envelope was sent. Read only.

Reserved for DocuSign.

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.

Metadata that indicates whether the signingGroupId property is editable. Read only.

Optional. The name of the signing group.

Maximum Length: 100 characters.

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

When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication.

Deprecated.

The recipient's status. Read only.

Possible values:

• autoresponded: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if Send-on-behalf-of is turned off for the account.
• completed: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.
• created: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of created).
• declined: The recipient declined to sign the document(s) in the envelope.
• delivered: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.
• faxPending: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.
• sent: The recipient has been sent an email notification that it is their turn to sign an envelope.
• signed: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to completed.

The code associated with the recipient's status. Read only.

When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.

A list of commentTabs that contains the Carbon Copy recipient's comments.

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

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

The total number of tabs in the documents. Read only.

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, userId can represent another user whom the Administrator is accessing.

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.

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

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

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

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

Metadata that indicates whether the accessCode property is editable. Read only.

Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of accessCode on the recipient.

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.

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.

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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. Read only.

An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

The date and time the recipient declined the document. Read only.

The reason the recipient declined the document. Read only.

The date and time that the envelope was delivered to the recipient. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

A list of documentVisibility objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true.

The recipient's email address.

Metadata that indicates whether the email property is editable. Read only.

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

Note: You can set the emailNotification property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level emailSubject and emailBlurb.

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

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

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 EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

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

Example:

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

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

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

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

Reserved for DocuSign.

Reserved for DocuSign.

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

Metadata that indicates whether the firstame property is editable. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

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:

• Phone Auth $: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the phoneAuthentication object.
• SMS Auth $: The recipient must authenticate via SMS. You provide the phone number to use in the smsAuthentication object.
• ID Check $: The recipient must answer detailed security questions.

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.

Metadata that indicates whether the idCheckConfigurationName property is editable. Read only.

An object that contains input information related to a recipient ID check.

Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

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.

The recipient's last name.

Metadata that indicates whether the lastName property is editable. Read only.

Reserved for DocuSign.

Reserved for DocuSign.

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 firstName and lastName are set.

Metadata that indicates whether the name property is editable. Read only.

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.

Metadata that indicates whether the note property is editable. Read only.

When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements:

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

Reserved for DocuSign.

Information about the recipient's authentication status. Read only.

Metadata about the features that are supported for the recipient type. Read only.

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

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. Read only.

The recipient type, as specified by the following values:

• agent: Agent recipients can add name and email information for recipients that appear after the agent in routing order.
• carbonCopy: 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. This type of recipient can be used in any routing order.
• certifiedDelivery: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
• editor: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
• inPersonSigner: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.
• intermediaries: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
• seal: Electronic seal recipients represent legal entities.
• signer: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
• witness: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.

Metadata that indicates whether the recipientType property is editable. Read only.

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

Metadata that indicates whether the requireIdLookup property is editable. Read only.

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

This property is required when you are working with template recipients.

Specifies the routing order of the recipient in the envelope.

Metadata that indicates whether the routingOrder property is editable. Read only.

The UTC DateTime when the envelope was sent. Read only.

Reserved for DocuSign.

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.

Metadata that indicates whether the signingGroupId property is editable. Read only.

Optional. The name of the signing group.

Maximum Length: 100 characters.

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

When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication.

Deprecated.

The status of the recipient. Read only.

Possible values:

• autoresponded: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if Send-on-behalf-of is turned off for the account.
• completed: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.
• created: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of created).
• declined: The recipient declined to sign the document(s) in the envelope.
• delivered: The recipient has viewed the document(s) in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.
• faxPending: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.
• sent: The recipient has been sent an email notification that it is their turn to sign an envelope.
• signed: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to completed.

The code associated with the recipient's status. Read only.

When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.

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

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

The total number of tabs in the documents. Read only.

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, userId can represent another user whom the Administrator is accessing.

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

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

• Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

  $~><|^+=

  For example, the anchorString water will match on the string Fetch a pail of water.

• Strings embedded in other strings are ignored during the matching process.

• In words that have dashes, the parts separated by dashes are treated as distinct words.

  Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

• Letters with accent marks are treated as distinct characters from their unaccented counterparts.

• For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

  Example: If the anchor string is i, then only one anchor tab is placed in skiing.

• Unlike punctuation, numbers are not ignored when finding anchor words.

  Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

Metadata that indicates whether the anchorCaseSensitive property is editable.

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are :

• left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
• right: Aligns the tab’s left side with the last character of the matching anchor word.

Note: You can only specify the value of this property in POST requests.

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

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

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

When set to true, the text string in a document must match the value of the anchorString property in its entirety for an anchor tab to be created. The default value is false.

For example, when set to true, if the input is man then man will match but manpower, fireman, and penmanship will not. When set to false, if the input is man then man, manpower, fireman, and penmanship will all match.

This functionality uses the following rules:

• Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

  $~><|^+=

  For example, the anchorString water will match on the string Fetch a pail of water.

• Strings embedded in other strings are ignored during the matching process.

• In words that have dashes, the parts separated by dashes are treated as distinct words.

  Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

• Letters with accent marks are treated as distinct characters from their unaccented counterparts.

• For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

  Example: If the anchor string is i, then only one anchor tab is placed in skiing.

• Unlike punctuation, numbers are not ignored when finding anchor words.

  Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).

Note: You can only specify the value of this property in POST requests.

Metadata that indicates whether the anchorMatchWholeWord property is editable.

Specifies the string to find in the document and use as the basis for tab placement.

Metadata that indicates whether the anchorString property is editable.

Reserved for DocuSign.

Reserved for DocuSign.

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

Metadata that indicates whether the anchorUnits property is editable.

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

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.

Metadata that indicates whether the anchorXOffset property is editable.

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

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.

Metadata that indicates whether the anchorYOffset property is editable.

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

Metadata that indicates whether the bold property is editable.

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

Metadata that indicates whether the conditionalParentLabel property is editable.

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.

Metadata that indicates whether the conditionalParentValue property is editable.

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.

Metadata that indicates whether the customTabId property is editable.

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

Metadata that indicates whether the documentId property is editable.

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

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

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

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

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

Metadata that indicates whether the fontColor property is editable.

Metadata that indicates whether the font property is editable.

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

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

Metadata that indicates whether the fontSize property is editable.

An integer specifying the order in which the guided form HTML should render. The order is relative to the formPageLabel, the group by which to place the guided form HTML block.

Metadata that indicates whether the formOrder property is editable.

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.

Metadata that indicates whether the formPageLabel property is editable.

An integer specifying the order in which to present the guided form pages.

Metadata that indicates whether the fromPageNumber property is editable.

The height of the tab in pixels.

Metadata that indicates whether the height property is editable.

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

Metadata that indicates whether the italic property is editable.

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

Metadata that indicates whether the locked property is editable.

Contains the information necessary to map the tab to a field in SalesForce.

The name of the tab. For example, Sign Here or Initial Here.

Metadata that indicates whether the name property is editable. Read only.

The page number on which the tab is located. For supplemental documents, this value must be 1.

Metadata that indicates whether the pageNumber property is editable.

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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. Read only.

Metadata that indicates whether the recipientIdGuid property is editable.

Metadata that indicates whether the recipientId property is editable.

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

Metadata that indicates whether the required property is editable.

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

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

When true, the checkbox is selected.

Metadata that indicates whether the selected property is editable.

When true, this tab is shared.

Metadata that indicates whether the shared property is editable.

The status of the tab. Possible values are:

• active: The tab is active, but the recipient has not yet interacted with it.
• signed: The recipient signed the tab.
• declined: The recipient declined the envelope.
• na: Used when the status property is not applicable to the tab type. (For example, a tab that has the tabType SignerAttachmentOptional).

Metadata that indicates whether the status property is editable.

An array of tab group labels that uniquely identify tab groups. To assign a tab to a tabGroup, you assign the TabGroupLabel to the Tab.TabGroupLabels array.

Metadata that indicates whether the tabGroupLabels property is editable.

The unique identifier for the tab.

Metadata that indicates whether the tabId property is editable.

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.

Metadata that indicates whether the tabLabel property is editable.

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

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

Metadata that indicates whether the tabOrder property is editable.

Indicates the type of tab (for example, signHere or initialHere).

Metadata that indicates whether the tabType property is editable.

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

Metadata that indicates whether the templateLocked property is editable.

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

Metadata that indicates whether the templateRequired property is editable.

The text of a tooltip that appears when a user hovers over a form field or tab.

Metadata that indicates whether the toolTip property is editable.

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

Metadata that indicates whether the underline property is editable.

The width of the tab in pixels.

Metadata that indicates whether the width property is editable.

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

Metadata that indicates whether the xPosition property is editable.

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

Metadata that indicates whether the yPosition property is editable.

The Guid of the envelope the comment thread belongs to.

Reserved for DocuSign.

The unique identifier for the comment.

An array of userIds that are mentioned directly in the body of a comment.

When true, indicates that the comment was read.

The email address of the user who created the comment.

The full name of the user who created the comment.

Reserved for DocuSign.

The initials of the user who created the comment.

The recipient id of the user who created the comment.

The user id of the user who created the comment.

The id of the signing group that can view the comment or that created the comment.

Optional. The name of the signing group.

Maximum Length: 100 characters.

The subject of the envelope.

The unique identifier for the tab that represents the comment thread.

The content of the comment, as UTF-8 text.

Maximum Length: 500 characters.

Note: The maximum size allowed for the entire message body is 32 KB.

The unique identifier for the comment thread.

The userId of the user who created the thread.

The time the comment was created.

The time the comment was created, formatted according to the format of the user who created the comment.

The user ids of the users that the comment is visible to.

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the anchorString property for an anchor tab to be created. The default value is false.

For example, when set to true, if the anchor string is DocuSign, then DocuSign will match but Docusign, docusign, DoCuSiGn, etc. will not match. When set to false, DocuSign, Docusign, docusign, DoCuSiGn, etc. will all match.

This functionality uses the following rules:

• Unless punctuation is specified in the anchorString, this functionality ignores punctuation and the following characters:

  $~><|^+=

  For example, the anchorString water will match on the string Fetch a pail of water.

• Strings embedded in other strings are ignored during the matching process.

• In words that have dashes, the parts separated by dashes are treated as distinct words.

  Example: If the anchor string is forget, then an anchor tab is placed on the forget in forget-me-not, even when anchorMatchWholeWord is set to true.

• Letters with accent marks are treated as distinct characters from their unaccented counterparts.

• For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.

  Example: If the anchor string is i, then only one anchor tab is placed in skiing.

• Unlike punctuation, numbers are not ignored when finding anchor words.

  Example: If the anchor string is cat, then -cat- is matched but 1cat2 is not when anchorMatchWholeWord is set to true (its default value).