EnvelopeDocuments: updateList

Adds one or more documents to an existing envelope document.

Note: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.

If the file name of a document contains unicode characters, you need to include a Content-Disposition header. Example:

Header: Content-Disposition

Value: file; filename=\"name\";fileExtension=ext;documentId=1

Request

HTTP request

PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Request Body

envelopeDefinition

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeDocuments
400

Error encountered.

errorDetails

SDK Method

Envelopes::updateDocuments

Definitions

addressInformation

Contains address information.

address1string

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

address2string

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

citystring

The user's city.

countrystring

The user's country.

faxstring

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

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

addressInformationInput

addressInformationaddressInformation

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.

displayLevelCodestring

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

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

A Boolean value that specifies whether the information must be returned in the response.

agent

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.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

completedCountstring

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

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

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

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 enforceSignerVisibility property must be set to true for the envelope to use this.

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

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates whether the firstame property is editable.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates whether the lastName property is editable.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

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.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notestring

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

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

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.

recipientIdGuidstring

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.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

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

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

roleNamestring

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

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

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

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.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

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.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

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

suppressEmailsstring

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

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

approve

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

buttonTextstring

Specifies the approval text that displays in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates whether the buttonText property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

attachment

Contains information about an attachment.

accessControlstring

Valid values are sender and senderAndAllRecipients.

attachmentIdstring

The unique identifier for the attachment.

attachmentTypestring

Specifies the type of the attachment for the recipient. Possible values are:

  • .htm
  • .xml

datastring

A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.

labelstring

A label for the attachment. Potential values include:

  • guidedForm: Guided forms provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.
  • eventNotifications: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the url property.

namestring

The name of the attachment.

remoteUrlstring

The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the remoteUrl property to reference the chunked upload as the content in attachment and document-related requests. The remoteUrl property cannot be used for downloads.

authenticationStatus

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

accessCodeResulteventResult

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.

ageVerifyResulteventResult

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.

anySocialIDResulteventResult

Deprecated.

facebookResulteventResult

Deprecated.

googleResulteventResult

Deprecated.

identityVerificationResulteventResult

The result of an Identity Verification workflow.

idLookupResulteventResult

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.

idQuestionsResulteventResult

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.

linkedinResulteventResult

Deprecated.

liveIDResulteventResult

Deprecated.

ofacResulteventResult

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.

openIDResulteventResult

Deprecated.

phoneAuthResulteventResult

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.

salesforceResulteventResult

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.

signatureProviderResulteventResult

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

smsAuthResulteventResult

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

sTANPinResulteventResult

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.

twitterResulteventResult

Deprecated.

yahooResulteventResult

Deprecated.

bccEmailAddress

Contains information about the BCC email address.

bccEmailAddressIdstring

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

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

emailstring

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

Maximum of length: 100 characters.

carbonCopy

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.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

agentCanEditEmailstring

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.

agentCanEditNamestring

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.

clientUserIdstring

Not applicable for Carbon Copy recipients.

completedCountstring

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

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

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

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 enforceSignerVisibility property must be set to true for the envelope to use this.

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

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates whether the firstame property is editable.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates whether the lastName property is editable.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

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.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notestring

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

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

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.

recipientIdGuidstring

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.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

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

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

roleNamestring

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

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

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

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.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

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.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

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

suppressEmailsstring

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

tabsEnvelopeRecipientTabs

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

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

certifiedDelivery

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.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

agentCanEditEmailstring

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.

agentCanEditNamestring

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.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

completedCountstring

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

The recipient's email address.

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

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

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

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 enforceSignerVisibility property must be set to true for the envelope to use this.

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

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates whether the firstame property is editable.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates whether the lastName property is editable.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

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.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notestring

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

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

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

recipientIdGuidstring

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.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

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

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

roleNamestring

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

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

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

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.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

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.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

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

suppressEmailsstring

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

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

checkbox

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

requireInitialOnSharedChangestring

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

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

selectedstring

When true, the checkbox is selected.

selectedMetadatapropertyMetadata

Metadata that indicates whether the selected property is editable.

sharedstring

When true, this tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

commentThread

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

comments[Comments]

An array of comment tabs that contain information about users' comments on documents.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

threadIdstring

The unique identifier for the comment thread.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

company

A tab that displays the recipient's company name.

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

concealValueOnDocumentstring

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

When an envelope is completed the information is 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.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

disableAutoSizestring

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

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates whether the disableAutoSize property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

compositeTemplate

This object contains information about a composite template, which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.

compositeTemplateIdstring

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

documentdocument

An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.

inlineTemplates[inlineTemplate]

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

pdfMetaDataTemplateSequencestring

A number representing the sequence in which to apply the template that contains the PDF metadata.

Example: 4

serverTemplates[serverTemplate]

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

date

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

concealValueOnDocumentstring

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

When an envelope is completed the information is 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.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

disableAutoSizestring

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

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates whether the disableAutoSize property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

requireInitialOnSharedChangestring

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

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

senderRequiredstring

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

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

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

senderRequiredMetadatapropertyMetadata

Metadata that indicates whether the senderRequired property is editable.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

dateSigned

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

decline

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

buttonTextstring

Specifies the decline text displayed in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates whether the buttonText property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

declineReasonstring

The reason the recipient declined the document.

declineReasonMetadatapropertyMetadata

Metadata that indicates whether the declineReason property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

dobInformationInput

dateOfBirthstring

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

displayLevelCodestring

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

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

A Boolean value that specifies whether the information must be returned in the response.

document

A document object.

applyAnchorTabsstring

Reserved for DocuSign

displaystring

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

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

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

  • inline
    The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.

documentBase64string

The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

documentFields[nameValue]

documentGroupstring

The type of group to which the document belongs. Valid values are:

  • content: This is the default value for non-certificate documents.
  • certificate: When a user makes a request to download a certificate of completion, the documents in the certificate document group are appended to the DocuSign certificate and the resulting PDF is returned. Documents returned with the DocuSign certificate are stamped or watermarked to indicate that they were not created by DocuSign.

Note: A document may only be in a single document group.

documentIdstring

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

encryptedWithKeyManagerstring

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

fileExtensionstring

The file extension type of the document. Non-PDF documents are converted to PDF.

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

If you try to upload a non-PDF document without a fileExtension, you will receive an "unable to load document" error message.

fileFormatHintstring

htmlDefinitiondocumentHtmlDefinition

includeInDownloadstring

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

matchBoxes[matchBox]

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

A matchbox consists of 5 elements:

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

namestring

The name of the document.

orderstring

(Optional) The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.

pageCountstring

An integer value specifying the number of document pages in the template.

pagesstring

An array of page objects.

pageSizes[pageSize]

passwordstring

The user's encrypted password hash.

pdfFormFieldOptionstring

remoteUrlstring

The file id from the cloud storage service where the document is located. This information is returned using CloudStorage::listFolders or CloudStorage::list.

signerMustAcknowledgestring

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

  • no_interaction
    No recipient action is required.

  • view
    The recipient is required to view the document.

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

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

tabsEnvelopeRecipientTabs

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.

templateLockedstring

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

templateRequiredstring

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

transformPdfFieldsstring

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF.

uristring

A URI containing the user ID.

documentHtmlCollapsibleDisplaySettings

arrowClosedstring

arrowColorstring

arrowLocationstring

arrowOpenstring

arrowSizestring

arrowStylestring

containerStylestring

labelStylestring

onlyArrowIsClickableboolean

outerLabelAndArrowStylestring

documentHtmlDefinition

Holds the properties that define how to generate the responsive-formatted HTML for the document.

displayAnchorPrefixstring

Contains text that all display anchors must start with. Using at least 4 characters will improve anchor processing performance.

displayAnchors[documentHtmlDisplayAnchor]

An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the display enum.

displayOrderstring

The position on the page where the display section appears.

displayPageNumberstring

The number of the page on which the display section appears.

documentGuidstring

The GUID of the document.

documentIdstring

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.

headerLabelstring

Header text or an HTML tag to place above the responsive HTML block.

maxScreenWidthstring

If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead.

removeEmptyTagsstring

Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).

showMobileOptimizedTogglestring

When set to true, the Mobile-Friendly toggle displays at the top of the screen on the user's mobile device. This toggle enables the user to switch between the mobile-friendly and PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.

sourcestring

Specifies the type of responsive signing that will be used with the document. Valid strings are:

documentHtmlDisplayAnchor

caseSensitiveboolean

When set to true, the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content.

displaySettingsdocumentHtmlDisplaySettings

This object defines how the HTML section inside the startAnchor and endAnchor displays.

endAnchorstring

Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.

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

removeEndAnchorboolean

When true, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.

removeStartAnchorboolean

When true, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.

startAnchorstring

Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.

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

documentHtmlDisplaySettings

cellStylestring

Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of responsive_table or responsive_table_single_column types.

collapsibleSettingsdocumentHtmlCollapsibleDisplaySettings

This object defines the appearance and function of a collapsible section or item.

displaystring

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

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

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

  • inline
    The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.

displayLabelstring

The label for the display section.

displayOrderinteger

The position on the page where the display section appears.

displayPageNumberinteger

The number of the page on which the display section appears.

hideLabelWhenOpenedboolean

When true, the displayLabel is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the display property is collapsed.

inlineOuterStylestring

Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the display property is inline.

labelWhenOpenedstring

The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the display property is collapsed.

scrollToTopWhenOpenedboolean

When true and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the display property is collapsed.

tableStylestring

Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the display property is responsive_table or responsive_table_single_column.

documentVisibility

This object configures a recipient's read/write access to a document.

documentIdstring

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.

errorDetailserrorDetails

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

recipientIdstring

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.

rightsstring

Indicates whether the document is editable:

  • editable
  • read_only

visiblestring

When true, the document is visible to the recipient.

editor

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.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

completedCountstring

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

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

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

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

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

firstNamestring

The recipient's first name.

Maximum Length: 50 characters.

firstNameMetadatapropertyMetadata

Metadata that indicates whether the firstame property is editable.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates whether the lastName property is editable.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

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.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notestring

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

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

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

recipientIdGuidstring

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.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

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

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

roleNamestring

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

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

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

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.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

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.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

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

suppressEmailsstring

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

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

email

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

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

concealValueOnDocumentstring

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

When an envelope is completed the information is 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.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

disableAutoSizestring

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

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates whether the disableAutoSize property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

requireInitialOnSharedChangestring

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

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

senderRequiredstring

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

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

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

senderRequiredMetadatapropertyMetadata

Metadata that indicates whether the senderRequired property is editable.

sharedstring

When set to true, this tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

emailAddress

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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.

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

envelopeDefinition

Envelope object definition.

accessControlListBase64string

Reserved for DocuSign.

accessibilitystring

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

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

allowCommentsstring

When true, comments are allowed on the envelope.

allowMarkupstring

When set to true, the Document Markup feature is enabled.

Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.

allowReassignstring

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

allowRecipientRecursionstring

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

allowViewHistorystring

When true, users can view the history of the envelope.

anySignerstring

Deprecated. This feature has been replaced by signing groups.

asynchronousstring

When true, the envelope is queued for processing and the value of the status property is set to Processing. Additionally, GET status calls return Processing until completed.

Note: A transactionId is required for this call to work correctly. When the envelope is created, the status is Processing and an envelopeId is not returned in the response. To get the envelopeId, use a GET envelope query by using the transactionId or by checking the Connect notification.

attachments[attachment]

An array of attachment objects containing details about any envelope attachments.

attachmentsUristring

The URI for retrieving the envelope attachments.

authoritativeCopystring

When true, marks all of the documents in the envelope as authoritative copies.

Note: You can override this value for a specific document. For example, you can set the authoritativeCopy property to true at the envelope level, but turn it off for a single document by setting the authoritativeCopy property for the document to false.

authoritativeCopyDefaultstring

The default authoritativeCopy setting for documents in this envelope that do not have authoritativeCopy set. If this property is not set, each document defaults to the envelope's authoritativeCopy.

autoNavigationstring

When true, autonavigation is set for the recipient.

brandIdstring

The id of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account.

brandLockstring

When true, the brandId for the envelope is locked and senders cannot change the brand used for the envelope.

certificateUristring

The URI for retrieving certificate information.

completedDateTimestring

The date and time that the envelope was completed.

compositeTemplates[compositeTemplate]

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

createdDateTimestring

The date and time that the envelope was created.

customFieldsAccountCustomFields

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.

customFieldsUristring

The URI for retrieving custom fields.

declinedDateTimestring

The date and time that the recipient declined the envelope.

deletedDateTimestring

The date and time that the envelope was deleted.

deliveredDateTimestring

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

disableResponsiveDocumentstring

When set to true, the responsive document feature is turned off for the envelope.

documents[document]

A complex element that contains details about the documents associated with the envelope.

documentsCombinedUristring

The URI for retrieving all of the documents associated with the envelope as a single PDF file.

documentsUristring

The URI for retrieving all of the documents associated with the envelope as separate files.

emailBlurbstring

This optional element holds the body of the email message that is sent to all envelope recipients.

Maximum Length: 10000 characters.

emailSettingsEnvelopeEmailSettings

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

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

emailSubjectstring

The subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see Template Email Subject Merge Fields.

enableWetSignstring

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

enforceSignerVisibilitystring

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

Note: To use this functionality, Document Visibility must be enabled for the account by making the account setting allowDocumentVisibility true.

envelopeAttachments[attachment]

An array of attachment objects that provide information about the attachments that are associated with the envelope.

envelopeDocuments[envelopeDocument]

An array containing information about the documents that are included in the envelope.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

envelopeIdStampingstring

When set to true, Envelope ID Stamping is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed.

envelopeLocationstring

Reserved for DocuSign.

envelopeMetadataenvelopeMetadata

Metadata about the features that are enabled for the envelope.

envelopeUristring

The URI for retrieving the envelope or envelopes.

eventNotificationeventNotification

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

eventNotifications[eventNotification]

An array of eventNotification objects.

expireAfterstring

An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.

expireDateTimestring

The date and time the envelope is set to expire.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (sentDateTime). Set expireAfter to set the number of days until an envelope expires. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

externalEnvelopeIdstring

May contain an external identifier for the envelope.

folders[folder]

An array of folders that the envelope belongs to.

hasCommentsstring

When set to true, indicates that users have added comments to the envelope.

hasFormDataChangedstring

When set to true, indicates that the form data associated with the envelope has changed since it was sent. If false, this property does not appear in the response.

hasWavFilestring

When set to true, indicates that a wave file (voice recording) is part of the envelope.

holderstring

Reserved for DocuSign.

initialSentDateTimestring

The date and time that the envelope was first sent.

is21CFRPart11string

When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

isDynamicEnvelopestring

When set to true, indicates that the envelope is a dynamic envelope.

isSignatureProviderEnvelopestring

When set to true, indicates that the envelope is a signature-provided envelope.

lastModifiedDateTimestring

The date and time that the item was last modified.

locationstring

Reserved for DocuSign.

lockInformationEnvelopeLocks

Provides lock information about an envelope that a user has locked.

messageLockstring

When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.

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

However, if the messageLock node is set to true and the emailSubject property is empty, senders and correctors are able to add a subject to the envelope.

notificationnotification

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

notificationUristring

The URI for retrieving notifications.

passwordstring

The user's encrypted password hash.

powerFormPowerForms

Information about any PowerForms that are included in the envelope.

purgeCompletedDatestring

The date that a purge was completed.

purgeRequestDatestring

The date that a purge was requested.

purgeStatestring

Initiates a purge request. Valid values are:

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

recipientsEnvelopeRecipients

Specifies the envelope recipients.

recipientsLockstring

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

recipientsUristring

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

senderuserInfo

Information about the sender of the envelope.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signerCanSignOnMobilestring

When set to true, recipients can sign on a mobile device.

Note: Only Admin users can change this setting.

signingLocationstring

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

statusstring

Indicates the envelope status. Valid values are:

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

statusChangedDateTimestring

The data and time that the status changed.

statusDateTimestring

The DateTime that the envelope changed status (i.e. was created or sent.)

templateIdstring

The id of the template. If a value is not provided, DocuSign generates a value.

templateRoles[templateRole]

This object specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This object is comprised of the following elements:

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

templatesUristring

The URI for retrieving any templates associated with the envelope.

transactionIdstring

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. We recommend that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transactionId property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned.

useDisclosurestring

When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to false, the Electronic Record and Signature Disclosure is not shown to any envelope recipients.

If the useDisclosure property is not set, then the account's normal disclosure setting is used and the value of the useDisclosure property is not returned in responses when getting envelope information.

voidedDateTimestring

The date and time the envelope or template was voided.

voidedReasonstring

The reason the envelope or template was voided.

envelopeDocument

This object contains details about the envelope document.

addedRecipientIds[array]

If recipients were added by converting form fields into tabs, their ids appear here. Read only.

attachmentTabIdstring

If this document is an attachment to another document in the envelope, this is the id of the attachment tab it is associated with on the other document.

authoritativeCopystring

When true, marks all of the documents in the envelope as authoritative copies.

Note: You can override this value for a specific document. For example, you can set the authoritativeCopy property to true at the envelope level, but turn it off for a single document by setting the authoritativeCopy property for the document to false.

authoritativeCopyMetadatapropertyMetadata

Metadata that indicates if the sender can edit the authoritativeCopy property. Not applicable for template documents.

availableDocumentTypes[signatureType]

containsPdfFormFieldsstring

When true, the document has editable form fields that are made available through a PDF format.

displaystring

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

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

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

  • inline
    The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.

displayMetadatapropertyMetadata

Metadata that indicates if the sender can edit the display property. Not applicable for template documents.

documentFields[nameValue]

An object containing information about the custom fields on the document.

documentGroupstring

The type of group to which the document belongs. Valid values are:

  • content: This is the default value for non-certificate documents.
  • certificate: When a user makes a request to download a certificate of completion, the documents in the certificate document group are appended to the DocuSign certificate and the resulting PDF is returned. Documents returned with the DocuSign certificate are stamped or watermarked to indicate that they were not created by DocuSign.

Note: A document may only be in a single document group.

documentIdstring

The id of the document that the tab is placed on. This value must refer to the id of an existing document.

documentIdGuidstring

The GUID of the document.

errorDetailserrorDetails

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

includeInDownloadstring

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

includeInDownloadMetadatapropertyMetadata

Metadata that indicates if the sender can edit the includeInDowload property. Not applicable for template documents.

namestring

The document's file name.

Example: Q1-Report.docx

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property. Not applicable for template documents.

orderstring

(Optional) The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.

pages[page]

An array of page objects that contain information about the pages in the document.

signerMustAcknowledgestring

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

  • no_interaction
    No recipient action is required.

  • view
    The recipient is required to view the document.

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

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

signerMustAcknowledgeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signerMustAcknowledge property. Not applicable for template documents.

templateLockedstring

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

templateRequiredstring

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

typestring

uristring

The URI for retrieving the document.

envelopeEvent

For which envelope events should your webhook be called?

envelopeEventStatusCodestring

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

includeDocumentsstring

reserved

envelopeId

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

envelopeMetadata

allowAdvancedCorrectstring

Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature.

allowCorrectstring

Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information.

enableSignWithNotarystring

Specifies if DocuSign eNotary service is enabled for the envelope.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

eventNotification

Register a Connect webhook for a specific envelope

envelopeEvents[envelopeEvent]

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

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

includeCertificateOfCompletionstring

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

includeCertificateWithSoapstring

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

includeDocumentFieldsstring

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

includeDocumentsstring

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

includeEnvelopeVoidReasonstring

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

includeHMACstring

includeSenderAccountAsCustomFieldstring

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

includeTimeZonestring

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

loggingEnabledstring

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

recipientEvents[recipientEvent]

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

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

requireAcknowledgmentstring

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

signMessageWithX509Certstring

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

soapNameSpacestring

The namespace of the SOAP interface.

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

urlstring

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

useSoapInterfacestring

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

eventResult

Information about the result of an event.

eventTimestampstring

Date/time of the event.

failureDescriptionstring

Reason for failure, if the event failed.

statusstring

Event status.

vendorFailureStatusCodestring

Failure status code, if the event failed.

expirations

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

expireAfterstring

An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (sentDateTime). Set expireAfter to set the number of days until an envelope expires. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

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

featureAvailableMetadata

availabiltystring

featureNamestring

filter

Use this object to create a filtered view of the items in a folder.

actionRequiredstring

When set to true, the current user needs to take action on the item.

expiresstring

The number of days a sent envelope remains active before it expires.

folderIdsstring

Filters for any combination of folder ids and folder types. The possible folder types are:

  • awaiting_my_signature
  • completed
  • draft
  • drafts
  • expiring_soon
  • inbox
  • out_for_signature
  • recyclebin
  • sentitems
  • waiting_for_others

fromDateTimestring

The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days.

isTemplatestring

When set to true, the item is a template.

orderstring

(Optional) The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.

orderBystring

The field used to sort the results.

Example: Created

searchTargetstring

Reserved for DocuSign.

searchTextstring

A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject.

statusstring

The status of the envelope. By default, all statuses are returned.

For details, see Envelope Status Code Descriptions.

toDateTimestring

The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date.

firstName

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

folder

This object contains details about a folder.

errorDetailserrorDetails

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

filterfilter

An object used to present a filtered view of the items in a folder.

folderIdstring

The id of the folder.

folderItems[folderItem_v2]

A list of envelopes and templates that the folder contains.

folders[folder]

A list of folder objects.

hasAccessstring

When set to true, the current user has access to the folder.

hasSubFoldersstring

When set to true, the folder has subfolders.

itemCountstring

The number of items in the folder.

namestring

The name of the folder.

owneruserInfo

Information about the user who owns the folder.

parentFolderIdstring

The id of the parent folder, or the special value root for the root folder.

parentFolderUristring

The URI of the parent folder.

subFolderCountstring

The number of subfolders.

typestring

The type of folder. Possible values include:

  • draft
  • inbox
  • normal (a system-generated folder)
  • recyclebin
  • sentitems
  • custom (a custom folder created by a user)

uristring

The URI for the folder.

folderItem_v2

Information about folder item results.

completedDateTimestring

If the item is an envelope, this is the UTC DateTime when the envelope was completed.

createdDateTimestring

The UTC DateTime when the item was created.

envelopeIdstring

If the item is an envelope, this is the id of the envelope.

envelopeUristring

If the item is an envelope, this is the URI for retrieving it.

expireDateTimestring

The date and time the envelope is set to expire.

folderIdstring

The id of the folder.

folderUristring

If the item is a subfolder, this is the URI for retrieving it.

is21CFRPart11string

When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

ownerNamestring

The name of the user who owns the folder.

recipientsEnvelopeRecipients

An array of recipient objects that provides details about the recipients of the envelope.

recipientsUristring

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

senderCompanystring

The name of the sender's company.

senderEmailstring

The sender's email address.

senderNamestring

The sender's name.

senderUserIdstring

The sender's id.

sentDateTimestring

The UTC DateTime when the envelope was sent.

statusstring

The status of the item.

subjectstring

The subject of the envelope.

templateIdstring

The id of the template.

templateUristring

The URI for retrieving the template.

formulaTab

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

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

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

concealValueOnDocumentstring

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

When an envelope is completed the information is 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.

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates whether the concealValueOnDocument property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

disableAutoSizestring

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

disableAutoSizeMetadatapropertyMetadata

Metadata that indicates whether the disableAutoSize property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

formulastring

Contains the formula for calculating the value of this tab.

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

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

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

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

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

Maximum Length: 2000 characters

formulaMetadatapropertyMetadata

Metadata indicating if the sender can edit the formula property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

hiddenstring

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

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

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

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

hiddenMetadatapropertyMetadata

Metadata that indicates whether the hidden property is editable.

isPaymentAmountstring

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

isPaymentAmountMetadatapropertyMetadata

Metadata that indicates whether the isPaymentAmount property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates whether the maxLength property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates whether the originalValue property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

paymentDetailspaymentDetails

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

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

requireInitialOnSharedChangestring

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

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

roundDecimalPlacesstring

The number of decimal places to round to.

roundDecimalPlacesMetadatapropertyMetadata

Metadata that indicates whether the roundDecimalPlaces property is editable.

senderRequiredstring

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

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

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

senderRequiredMetadatapropertyMetadata

Metadata that indicates whether the senderRequired property is editable.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates whether the validationMessage property is editable.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates whether the validationPattern property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

fullName

A tab that displays the recipient's full name.

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

graphicsContext

fillColorstring

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.

lineColorstring

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.

lineWeightstring

The line weight or thickness to use for the overlay.

idCheckInformationInput

A complex element that contains input information related to a recipient ID check.

addressInformationInputaddressInformationInput

An object that specifies recipient address information and how it is displayed.

dobInformationInputdobInformationInput

An object that specifies recipient date of birth information and how it is displayed.

ssn4InformationInputssn4InformationInput

An object that specifies the last four digits of the recipient's Social Security Number (SSN).

ssn9InformationInputssn9InformationInput

An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

initialHere

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates whether the optional property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

scaleValuestring

Sets the size of the tab. This field accepts values from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% of full size.

scaleValueMetadatapropertyMetadata

Metadata that indicates whether the scaleValue property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

inlineTemplate

customFieldsAccountCustomFields

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.

documents[document]

A complex element that contains details about the documents associated with the envelope.

envelopeEnvelopes

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

recipientsEnvelopeRecipients

An array of recipient objects that provides details about the recipients of the envelope.

sequencestring

Specifies the order in which templates are overlaid.

inPersonSigner

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.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

autoNavigationstring

When true, autonavigation is set for the recipient.

canSignOfflinestring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

completedCountstring

Indicates the number of times that the recipient has been through a signing completion.

If this number is greater than 0 for a signing group, only the user who previously completed may sign again.

creationReasonstring

The reason why the recipient was created (for example, sender). This property is only returned in responses.

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

defaultRecipientstring

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

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

The signer's email address in an eNotary flow.

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

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

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

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

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 enforceSignerVisibility property must be set to true for the envelope to use this.

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

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

hostEmailstring

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

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

Maximum Length: 100 characters.

hostEmailMetadatapropertyMetadata

Metadata that indicates whether the hostEmail property is editable.

hostNamestring

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

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

Maximum Length: 100 characters.

hostNameMetadatapropertyMetadata

Metadata that indicates whether the hostName property is editable.

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

inheritEmailNotificationConfigurationstring

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

inPersonSigningTypestring

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

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

inPersonSigningTypeMetadatapropertyMetadata

Metadata that indicates whether the inPersonSigningType property is editable.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

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

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

Maximum Length: 100 characters.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notaryHostnotaryHost

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

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

notestring

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

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

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

recipientIdGuidstring

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.

recipientSuppliesTabsstring

Specifies whether the recipient creates the tabs.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

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

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

requireSignerCertificatestring

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

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

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

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

requireSignOnPaperstring

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

requireUploadSignaturestring

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.

roleNamestring

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

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

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signatureInforecipientSignatureInformation

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

Used only with recipient types In Person Signers and Signers.

signedDateTimestring

Reserved for DocuSign.

signerEmailstring

The in-person signer's email address.

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

Maximum Length: 100 characters.

signerEmailMetadatapropertyMetadata

Metadata that indicates if the sender can edit the in-person signer's email address.

signerFirstNamestring

The signer's first name.

signerFirstNameMetadatapropertyMetadata

Metadata that indicates if the signerFirstName property is editable.

signerLastNamestring

The signer's last name.

signerLastNameMetadatapropertyMetadata

Metadata that indicates whether the signerLastName property is editable.

signerNamestring

The in-person signer's full legal name.

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

Maximum Length: 100 characters.

signerNameMetadatapropertyMetadata

Metadata that indicates whether the signerName property is editable.

signInEachLocationstring

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

signInEachLocationMetadatapropertyMetadata

Metadata that indicates whether the signInEachLocation property is editable.

signingGroupIdstring

Not applicable. You cannot use a signing group for an in-person signer.

signingGroupIdMetadatapropertyMetadata

Not applicable.

signingGroupNamestring

Not applicable.

signingGroupUsers[userInfo]

Not applicable.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

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

suppressEmailsstring

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

tabsEnvelopeRecipientTabs

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.

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

intermediary

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.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

completedCountstring

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

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

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

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 enforceSignerVisibility property must be set to true for the envelope to use this.

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

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates whether the firstame property is editable.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates whether the lastName property is editable.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

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.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notestring

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

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

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

recipientIdGuidstring

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.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

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

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

roleNamestring

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

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

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

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.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

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.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

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

suppressEmailsstring

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

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

lastName

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

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

mergeFieldXmlstring

namestring

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

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

list

This tab offers a list of options to choose from. The listItems property contains a list of listItem objects to specify the selectable options.

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

fontstring

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

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

fontColorstring

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

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

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

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

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

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

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.

listSelectedValuestring

The value in the list that is selected by default.

listSelectedValueMetadatapropertyMetadata

Metadata that indicates whether the listSelectedValue property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates whether the requireAll property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

requireInitialOnSharedChangestring

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

requireInitialOnSharedChangeMetadatapropertyMetadata

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

senderRequiredstring

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

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

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

senderRequiredMetadatapropertyMetadata

Metadata that indicates whether the senderRequired property is editable.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

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

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

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

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

The value to use when the item is selected.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

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

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

listCustomField

This object represents a custom field that accepts a list.

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

errorDetailserrorDetails

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

fieldIdstring

The id of the custom field.

listItems[array]

An array of strings that represent the items in a list.

namestring

The name of the list custom field.

requiredstring

When set to true, the signer is required to fill out the custom field.

showstring

When set to true, the custom field displays at the top of the certificate of completion.

valuestring

The value of the custom field.

Maximum Length: 100 characters.

listItem

One of the selectable items in the listItems property of a list tab.

selectedstring

When set to true, indicates that this item is the default selection shown to a signer.

Only one selection can be set as the default.

selectedMetadatapropertyMetadata

Metadata that indicates whether the selected property is editable.

textstring

Specifies the text that is shown in the dropdown list.

textMetadatapropertyMetadata

valuestring

Specifies the value that is used when the list item is selected.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

localePolicyTab

addressFormatstring

calendarTypestring

cultureNamestring

currencyNegativeFormatstring

currencyPositiveFormatstring

customDateFormatstring

customTimeFormatstring

dateFormatstring

initialFormatstring

nameFormatstring

timeFormatstring

timeZonestring

matchBox

heightstring

The height of the tab in pixels.

pageNumberstring

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

widthstring

The width of the tab in pixels.

xPositionstring

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

yPositionstring

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

mergeField

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

allowSenderToEditstring

When true, the sender can modify the value of the mergeField tab during the sending process.

allowSenderToEditMetadatapropertyMetadata

Metadata that indicates if the sender can edit the allowSenderToEdit property.

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

configurationTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the configurationType property.

pathstring

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

pathExtended[pathExtendedElement]

Reserved for DocuSign.

pathExtendedMetadatapropertyMetadata

Reserved for DocuSign.

pathMetadatapropertyMetadata

Metadata that indicates whether the path property is editable.

rowstring

Specifies the row number in a Salesforce table that the merge field value corresponds to.

rowMetadatapropertyMetadata

Metadata that indicates whether the row property is editable.

writeBackstring

When true, data entered into the merge field during Signing will update the mapped Salesforce field.

writeBackMetadatapropertyMetadata

Metadata that indicates if the sender can edit the writeBack property.

money

Describes information about the total of a payment.

amountInBaseUnitstring

The total payment amount in the currency's base unit. For example, for USD the base currency is one cent.

currencystring

The three-letter ISO 4217 currency code for the payment.

For example:

  • AUD Australian dollar
  • CAD Canadian dollar
  • EUR Euro
  • GBP Great Britain pound
  • USD United States dollar

This is a read-only property.

displayAmountstring

The payment amount as displayed in the currency.

For example, if the payment amount is USD 12.59, the amountInBaseUnit is 1259 (cents), and the displayed amount is $12.59 USD.

This is a read-only property.

nameValue

A name-value pair that describes an item and provides a value for the item.

errorDetailserrorDetails

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

namestring

The name of the item.

originalValuestring

The initial value of the item.

valuestring

The current value of the item.

notarize

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

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

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

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

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

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

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

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

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

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates whether the locked property is editable.

mergeFieldmergeField

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

mergeFieldXmlstring

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates whether the required property is editable.

statusstring

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).

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

xPositionMetadatapropertyMetadata

Metadata that indicates whether the xPosition property is editable.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates whether the yPosition property is editable.

notaryHost

This object is used only when inPersonSigningType in the inPersonSigner object is notary.

It describes information about the notary host. The following information is required when using the eNotary in-person signing flow:

  • name: Specifies the notary's full legal name.
  • email: Specifies the notary's email address.
  • recipientId: A unique ID number for the notary signing host.

accessCodestring

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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.

clientUserIdstring

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

completedCountstring

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 customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

The date and time that the envelope was delivered to the recipient.

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

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.

emailstring

The notary's email address.

Maximum Length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates whether the email property is editable.

emailNotificationrecipientEmailNotification

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.

embeddedRecipientStartURLstring

Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation 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]]

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

hostRecipientIdstring

idCheckConfigurationNamestring

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.

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

An object that contains input information related to a recipient ID check.

inheritEmailNotificationConfigurationstring

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

lockedRecipientPhoneAuthEditablestring

Reserved for DocuSign.

lockedRecipientSmsEditablestring

Reserved for DocuSign.

namestring

The notary's full legal name.

Maximum Length: 100 characters.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

notestring

A note sent to the notary in the signing email. This note is visible only to this notary.

Maximum Length: 1000 characters.

noteMetadatapropertyMetadata

Metadata that indicates whether the note property is editable.

phoneAuthenticationrecipientPhoneAuthentication

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.

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the recipient's authentication status.

recipientFeatureMetadata[featureAvailableMetadata]

Metadata about the features that are supported for the recipient type.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientTypestring

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.

recipientTypeMetadatapropertyMetadata

Metadata that indicates whether the recipientType property is editable.

requireIdLookupstring

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

requireIdLookupMetadatapropertyMetadata

Metadata that indicates whether the requireIdLookup property is editable.

roleNamestring

Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The UTC DateTime when the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

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.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

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.

smsAuthenticationrecipientSMSAuthentication

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.

socialAuthentications[socialAuthentication]

Deprecated.

statusstring

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.

statusCodestring

The code associated with the recipient's status. Read only.

suppressEmailsstring

When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox.

tabsEnvelopeRecipientTabs

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.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCountstring

The total number of tabs in the documents.

userIdstring

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.

note

A tab that displays additional information, in the form of a note, for the recipient.

anchorCaseSensitivestring

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.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

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.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if the anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

anchorMatchWholeWordstring

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.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the string to find in the document and use as the basis for tab placement.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies the units of the X and Y offset. Units may be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates whether the anchorUnits property is editable.

anchorXOffsetstring

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.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorYOffset property is editable.

boldstring

When set to true, the information in the tab is bold.

boldMetadatapropertyMetadata

Metadata that indicates whether the bold property is editable.

conditionalParentLabelstring

For conditional fields this is the tabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentLabel property is editable.

conditionalParentValuestring

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

conditionalParentValueMetadatapropertyMetadata

Metadata that indicates whether the conditionalParentValue property is editable.

customTabIdstring

The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

customTabIdMetadatapropertyMetadata

Metadata that indicates whether the customTabId property is editable.

documentIdstring

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.

documentIdMetadatapropertyMetadata

Metadata that indicates whether the documentId property is editable.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

fontstring

The font to be used for the tab value. Supported fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color to use for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontColorMetadatapropertyMetadata

Metadata that indicates whether the fontColor property is editable.

fontMetadatapropertyMetadata

Metadata that indicates whether the font property is editable.

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

fontSizeMetadatapropertyMetadata

Metadata that indicates whether the fontSize property is editable.

formOrderstring

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.

formOrderMetadatapropertyMetadata

Metadata that indicates whether the formOrder property is editable.

formPageLabelstring

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.

formPageLabelMetadatapropertyMetadata

Metadata that indicates whether the formPageLabel property is editable.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates whether the fromPageNumber property is editable.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates whether the height property is editable.

italicstring

When set to true, the information in the tab is italic.

italicMetadatapropertyMetadata

Metadata that indicates whether the italic property is editable.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

mergeFieldXmlstring

namestring

The name of the tab. For example, Sign Here or Initial Here.

nameMetadatapropertyMetadata

Metadata that indicates whether the name property is editable.

pageNumberstring

The page number on which the tab is located. For supplemental documents, this value must be 1.

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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.

recipientIdGuidstring

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.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates whether the recipientId property is editable.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates whether the shared property is editable.

statusstring

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).

statusMetadatapropertyMetadata

Metadata that indicates whether the status property is editable.

tabGroupLabels[array]

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.

tabGroupLabelsMetadatapropertyMetadata

Metadata that indicates whether the tabGroupLabels property is editable.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates whether the tabId property is editable.

tabLabelstring

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.

tabLabelMetadatapropertyMetadata

Metadata that indicates whether the tabLabel property is editable.

tabOrderstring

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

tabOrderMetadatapropertyMetadata

Metadata that indicates whether the tabOrder property is editable.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates whether the tabType property is editable.

templateLockedstring

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateLockedMetadatapropertyMetadata

Metadata that indicates whether the templateLocked property is editable.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates whether the templateRequired property is editable.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates whether the toolTip property is editable.

underlinestring

When set to true, the information in the tab is underlined.

underlineMetadatapropertyMetadata

Metadata that indicates whether the underline property is editable.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates whether the value property is editable.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates whether the width property is editable.

xPositionstring

This property