Templates: update

Updates an existing template.

Request

HTTP request

PUT /v2.1/accounts/{accountId}/templates/{templateId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

templateIdstring

The ID of the template.

Request Body

Templates

Responses

CodeDescriptionReference
200

Successful response.

templateUpdateSummary
400

Error encountered.

errorDetails

SDK Method

Templates::update

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

Contains address input information.

addressInformationaddressInformation

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

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

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

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

displayLevelCodestring

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

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

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

agent

Contains information about agent recipients.

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Metadata that indicates whether the deliveryMethod property is editable.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

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 if the sender can edit the email id of the agent.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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

Metadata that indicates whether the faxNumber property is editable.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the agent's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The agent's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the agent's last name.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The full legal name of the agent.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the full legal name of the agent.

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 if the sender can edit the note sent to the recipient in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

recipientFeatureMetadata[featureAvailableMetadata]

Metadata that indicates whether the recipientFeature property is editable.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientTypestring

The recipient type.

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 is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

The id of the signing group of which the agent is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

approve

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Metadata that indicates whether the anchorMatchWholeWord property is editable.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Metadata that indicates whether the anchorTabProcessorVersion property is editable.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

buttonTextstring

Specifies the approval text that displays in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates if the sender can edit the buttonText property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. The tab element uses this id to indicate which recipient is to sign the document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates whether the recipientIdGuid property is editable.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

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 if the sender can edit the yPosition property.

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 chunkedUpload. This property is used as the reference to the blob of data when uploading an attachment, and cannot be used for downloads.

authenticationStatus

Contains information about the authentication status.

accessCodeResulteventResult

ageVerifyResulteventResult

anySocialIDResulteventResult

facebookResulteventResult

googleResulteventResult

idLookupResulteventResult

idQuestionsResulteventResult

linkedinResulteventResult

liveIDResulteventResult

ofacResulteventResult

openIDResulteventResult

phoneAuthResulteventResult

salesforceResulteventResult

signatureProviderResulteventResult

smsAuthResulteventResult

sTANPinResulteventResult

twitterResulteventResult

yahooResulteventResult

bccEmailAddress

Contains information about the BCC email address.

bccEmailAddressIdstring

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

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

emailstring

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

Maximum of length: 100 characters.

bulkEnvelope

bulkRecipientRowstring

Reserved: TBD

bulkStatusstring

Indicates the status of the bulk send operation. Returned values can be:

  • queued
  • processing
  • sent
  • failed

emailstring

Filters returned user records by the specified email address.

envelopeIdstring

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

envelopeUristring

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

namestring

submittedDateTimestring

transactionIdstring

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

bulkEnvelopeStatus

batchIdstring

Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.

batchSizestring

The number of items returned in this response.

bulkEnvelopes[bulkEnvelope]

Reserved: TBD

bulkEnvelopesBatchUristring

Reserved: TBD

endPositionstring

The last position in the result set.

failedstring

The number of entries with a status of failed.

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

queuedstring

The number of entries with a status of queued.

resultSetSizestring

The number of results returned in this response.

sentstring

The number of entries with a status of sent.

startPositionstring

Starting position of the current result set.

submittedDatestring

totalSetSizestring

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

carbonCopy

A carbon copy recipient.

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

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

agentCanEditEmailstring

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates if the sender can edit the email id of the recipient.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the recipient's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the idCheckConfigurationName property.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's last name.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The full legal name of the recipient. Maximum Length: 100 characters.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the full legal name of the recipient.

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 indicating if the sender can edit the note sent to the recipient in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

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 Guid for the recipient.

recipientTypestring

The recipient type.

recipientTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient type.

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 is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

The ID of the signing group of which the recipient is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signing group id.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

The code for recipient's status.

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

userIdstring

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

certifiedDelivery

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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

agentCanEditEmailstring

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

emailstring

The email id of the recipient.

emailMetadatapropertyMetadata

Metadata that indicates if the sender can edit the email address of the recipient.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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

Metadata that indicates whether the faxNumber property is editable.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the idCheckConfigurationName property.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The last name of the recipient.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender is able to edit the last name of the recipient.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The full legal name of the recipient.

nameMetadatapropertyMetadata

Metadata that indicates if the user can edit the full legal name of the recipient.

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 if the sender can edit the note sent to the recipient in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

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 Guid for the recipient.

recipientTypestring

The recipient type.

recipientTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient type.

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 is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

The id of the signing group of which the recipient is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signing group id.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

checkbox

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid of the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

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 if the sender can edit the requireInitialOnSharedChange property.

selectedstring

When set to true, the checkbox is selected.

selectedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the selected property.

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
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

comment

envelopeIdstring

The Guid of the envelope the comment thread belongs to.

hmacstring

Reserved for DocuSign.

idstring

The unique identifier for the comment.

mentions[array]

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

readboolean

When true, indicates that the comment was read.

sentByEmailstring

The email address of the user who created the comment.

sentByFullNamestring

The full name of the user who created the comment.

sentByImageIdstring

Reserved for DocuSign.

sentByInitialsstring

The initials of the user who created the comment.

sentByRecipientIdstring

The recipient id of the user who created the comment.

sentByUserIdstring

The user id of the user who created the comment.

signingGroupIdstring

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

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

subjectstring

The subject of the envelope.

tabIdstring

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

textstring

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

Maximum Length: 500 characters.

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

threadIdstring

The unique identifier for the comment thread.

threadOriginatorIdstring

The userId of the user who created the thread.

timestampstring

The time the comment was created.

timeStampFormattedstring

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

visibleTo[array]

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

commentThread

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Metadata that indicates whether the anchorCaseSensitive property is editable.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates whether the anchorString property is editable.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Metadata that indicates whether the anchorTabProcessorVersion property is editable.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates whether the anchorXOffset property is editable.

anchorYOffsetstring

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

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 if the sender can edit the bold property.

comments[comment]

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 if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the item.

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

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 if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

company

A tab that displays the recipient's company name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

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

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

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

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 if the sender can edit the disableAutoSize property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates whether the pageNumber property is editable.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

date

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

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

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

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

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 if the sender can edit the disableAutoSize property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

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 if the sender can edit the requireInitialOnSharedChange property.

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 if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

dateSigned

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

decline

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

buttonTextstring

Specifies the decline text displayed in the tab.

buttonTextMetadatapropertyMetadata

Metadata that indicates if the sender can edit the buttonText property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

declineReasonstring

The reason the recipient declined the document.

declineReasonMetadatapropertyMetadata

Metadata that indicates if the sender can edit the declineReason property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

dobInformationInput

Complex type containing:

  • dateOfBirth
  • displayLevelCode
  • receiveInResponse

dateOfBirthstring

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

displayLevelCodestring

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

  • ReadOnly
  • Editable
  • DoNotDisplay

receiveInResponsestring

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

document

A document object.

applyAnchorTabsstring

Reserved for DocuSign

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 the document belongs to (certificate or content).

documentIdstring

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

encryptedWithKeyManagerstring

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

fileExtensionstring

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

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

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

fileFormatHintstring

htmlDefinitiondocumentHtmlDefinition

includeInDownloadstring

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

matchBoxes[matchBox]

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

A matchbox consists of 5 elements:

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

namestring

The name of the document.

orderstring

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

Valid values are:

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

pageCountstring

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

pagesstring

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

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

URI containing the user ID.

documentHtmlCollapsibleDisplaySettings

arrowClosedstring

arrowColorstring

arrowLocationstring

arrowOpenstring

arrowSizestring

arrowStylestring

containerStylestring

labelStylestring

onlyArrowIsClickableboolean

outerLabelAndArrowStylestring

documentHtmlDefinition

displayAnchorPrefixstring

displayAnchors[documentHtmlDisplayAnchor]

displayOrderstring

displayPageNumberstring

documentGuidstring

documentIdstring

The ID of the document being accessed.

headerLabelstring

maxScreenWidthstring

removeEmptyTagsstring

showMobileOptimizedTogglestring

sourcestring

documentHtmlDisplayAnchor

caseSensitiveboolean

displaySettingsdocumentHtmlDisplaySettings

endAnchorstring

removeEndAnchorboolean

removeStartAnchorboolean

startAnchorstring

documentHtmlDisplaySettings

cellStylestring

collapsibleSettingsdocumentHtmlCollapsibleDisplaySettings

displaystring

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

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

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

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

displayLabelstring

displayOrderinteger

displayPageNumberinteger

hideLabelWhenOpenedboolean

inlineOuterStylestring

labelWhenOpenedstring

scrollToTopWhenOpenedboolean

tableStylestring

documentVisibility

documentIdstring

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

recipientIdstring

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

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

visiblestring

editor

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the accessCode property.

addAccessCodeToEmailstring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Metadata that indicates whether the deliveryMethod property is editable.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates if the sender can edit the email id of the recipient.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Metadata that indicates whether the faxNumber property is editable.

firstNamestring

The recipient's first name.

Maximum Length: 50 characters.

firstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the idCheckConfigurationName property.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's last name.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The full legal name of the recipient. Maximum Length: 100 characters.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the full legal name of the recipient.

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 if the sender can edit the note sent to the recipient in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

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 Guid for the recipient.

recipientTypestring

The recipient type.

recipientTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient type.

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 is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

The id of the signing group of which the recipient is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signing group id.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

email

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

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

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

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

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

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 if the sender can edit the disableAutoSize property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

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 if the sender can edit the requireInitialOnSharedChange property.

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 if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

emailAddress

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

envelopeDocument

addedRecipientIds[array]

If recipients were added by converting form fields into tabs, their ids will 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

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

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]

The custom fields on the document.

documentGroupstring

The type of group the document belongs to (certificate or content).

documentIdstring

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

documentIdGuidstring

The Guid of the document.

errorDetailserrorDetails

If an error occurs, this property describes the error.

includeInDownloadstring

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

includeInDownloadMetadatapropertyMetadata

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

namestring

The name of the document.

nameMetadatapropertyMetadata

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

orderstring

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

Valid values are:

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

pages[page]

An array of page objects that contain information about the pages in a 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

Type of user:

  • type_owner
  • type_participant

uristring

URI containing the user ID.

envelopeId

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

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

A code associated with the error condition.

messagestring

A brief message describing the error condition.

eventResult

eventTimestampstring

failureDescriptionstring

statusstring

Event status.

vendorFailureStatusCodestring

expirations

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

expireAfterstring

An integer that sets the number of days a sent envelope is active before it expires.

In a response, a negative number indicates that the envelope has already expired.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) a certain number of days after it is sent (the sentDateTime). Use the expireAfter property to set the number of days before an envelope expires.

If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

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

featureAvailableMetadata

availabiltystring

featureNamestring

filter

actionRequiredstring

Action required.

expiresstring

folderIdsstring

fromDateTimestring

isTemplatestring

orderstring

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

Valid values are:

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

orderBystring

searchTargetstring

searchTextstring

statusstring

Filter status.

toDateTimestring

Latest date to filter.

firstName

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

folder

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

filterfilter

folderIdstring

Unique identifier for the folder.

folderItems[folderItem_v2]

A list of the envelopes in the specified folder or folders.

folders[folder]

A collection of folder objects returned in a response.

hasAccessstring

hasSubFoldersstring

itemCountstring

namestring

owneruserInfo

parentFolderIdstring

parentFolderUristring

subFolderCountstring

typestring

Type of user:

  • type_owner
  • type_participant

uristring

URI containing the user ID.

folderItem_v2

Information about folder item results.

completedDateTimestring

Specifies the date and time this item was completed.

createdDateTimestring

The date and time the item was created.

envelopeIdstring

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

envelopeUristring

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

expireDateTimestring

The date and time the envelope is set to expire.

folderIdstring

Unique identifier for the folder.

folderUristring

is21CFRPart11string

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

ownerNamestring

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

senderEmailstring

senderNamestring

senderUserIdstring

sentDateTimestring

The date and time the envelope was sent.

statusstring

The status of the item.

subjectstring

templateIdstring

The ID of the template.

templateUristring

formulaTab

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

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

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

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

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

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

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 if the sender can edit the disableAutoSize property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

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 if the sender can edit the height property.

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 if the sender can edit the hidden property.

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 if the sender can edit the isPaymentAmount property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

paymentDetailspaymentDetails

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

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

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 if the sender can edit the requireInitialOnSharedChange property.

roundDecimalPlacesstring

The number of decimal places to round to.

roundDecimalPlacesMetadatapropertyMetadata

Metadata that indicates if the sender can edit the roundDecimalPlaces property.

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 if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

fullName

A tab that displays the recipient's full name.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

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. It can include the following information.

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

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

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

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

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

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

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

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

addressInformationInputaddressInformationInput

dobInformationInputdobInformationInput

Complex type containing:

  • dateOfBirth
  • displayLevelCode
  • receiveInResponse

ssn4InformationInputssn4InformationInput

ssn9InformationInputssn9InformationInput

initialHere

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

mergeFieldmergeField

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

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

optionalstring

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

optionalMetadatapropertyMetadata

Metadata that indicates if the sender can edit the optional property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

scaleValuestring

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

scaleValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the scaleValue property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

inPersonSigner

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

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates whether the accessCode property is editable.

addAccessCodeToEmailstring

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

autoNavigationstring

When true, auto navigation is set for the recipient.

canSignOfflinestring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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

customFields[array]

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

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

defaultRecipientstring

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

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Metadata that indicates whether the deliveryMethod property is editable.

documentVisibility[documentVisibility]

Specifies if the documents are 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.

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 if the sender can edit the signer's email address in an eNotary flow.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the email address of the signing host.

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

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

inPersonSigningTypestring

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

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

inPersonSigningTypeMetadatapropertyMetadata

Metadata that indicates whether the inPersonSigningType property is editable.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

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

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

Maximum Length: 100 characters.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signer's full legal name in an eNotary flow.

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 if the sender can edit the note sent to the in-person signer in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

recipientFeatureMetadata[featureAvailableMetadata]

Metadata that indicates whether the recipientFeature property is editable.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

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

recipientTypestring

The recipient type.

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.

roleNamestring

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

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates whether the routingOrder property is editable.

sentDateTimestring

The date and time the envelope was sent.

signatureInforecipientSignatureInformation

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

Used only with recipient types In Person Signers and Signers.

signedDateTimestring

Reserved for DocuSign.

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 first name of the in-person signer.

signerFirstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the first name of the in-person signer.

signerLastNamestring

The last name of the in-person siger.

signerLastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the last name of the in-person signer.

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 if the sender can edit the in-person signer's full legal name.

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 if the sender can edit the signInEachLocation property.

signingGroupIdstring

The id of the signing group of which the in-person signer is a member.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

tabsEnvelopeRecipientTabs

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

intermediary

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the accessCode property.

addAccessCodeToEmailstring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates if the sender can edit the email id of the recipient.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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

Metadata that indicates whether the faxNumber property is editable.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the idCheckConfigurationName property.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's last name.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The full legal name of the recipient.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the full legal name of the recipient.

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 if the sender can edit the note to the recipient.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

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 Guid for the recipient.

recipientTypestring

The recipient type.

recipientTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient type.

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 is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

The date and time the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

The id of the signing group of which the recipient is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signing group id.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

lastName

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

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

list

This tab offers a list of options to choose from. The listItems property contains a list of listItem objects to specify the selectable options.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

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 if the sender can edit the listSelectedValue property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

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

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

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 if the sender can edit the requireInitialOnSharedChange property.

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 if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

The value to use when the item is selected.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

listCustomField

configurationTypestring

If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

fieldIdstring

An ID used to specify a custom field.

listItems[array]

An array of strings that represent the items in a list.

namestring

The name of the custom field.

requiredstring

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

showstring

A boolean indicating if the value should be displayed. If this value is set to true, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to false, then it does not appear in the certificate of completion.

valuestring

The value of the custom field.

Maximum Length: 100 characters.

listItem

One of the selectable items in the listItems property of a list tab.

selectedstring

When set to true, indicates that this item is the default selection shown to a signer.

Only one selection can be set as the default.

selectedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the selected property.

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 if the sender can edit the value property.

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

namestring

The name or key of a name/value pair.

originalValuestring

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

valuestring

The value field of a name/value pair.

notarize

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

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

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

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 if the sender can edit the accessCode property.

addAccessCodeToEmailstring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Metadata that indicates whether the deliveryMethod property is editable.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

emailstring

The notary's email address.

Maximum Length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates if the sender can edit the notary's email address.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Reserved for DocuSign.

hostRecipientIdstring

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates whether the idCheckConfigurationName property is editable.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

inheritEmailNotificationConfigurationstring

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

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The notary's full legal name.

Maximum Length: 100 characters.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the notary's full legal name.

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 if the sender can edit the note sent to the notary in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

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 Guid for the recipient.

recipientTypestring

The recipient type.

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 is required when 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 date and time the envelope was sent.

signedDateTimestring

Reserved for DocuSign.

signingGroupIdstring

The ID of the signing group of which the notary is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates whether the signingGroupId property is editable.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Indicates the envelope status. Valid values are:

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

statusCodestring

tabsEnvelopeRecipientTabs

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

note

A tab that displays additional information, in the form of a note, for the recipient.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

mergeFieldmergeField

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

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

notification

A complex element that specifies the notification options for the envelope. It consists of:

  • useAccountDefaults - When set to true, the account default notification settings are used for the envelope.
  • reminders - A complex element that specifies reminder settings for the envelope. It consists of:

    • reminderEnabled - When set to true, a reminder message is sent to the recipient.
    • reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.
    • reminderFrequency - An interger that sets the interval, in days, between reminder emails.
  • expirations - A complex element that specifies the expiration settings for the envelope. It consists of:

    • expireEnabled - When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.
    • expireAfter - An integer that sets the number of days the envelope is active.
    • expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

expirationsexpirations

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

remindersreminders

A complex element that specifies reminder settings for the envelope

useAccountDefaultsstring

When set to true, the account default notification settings are used for the envelope.

number

A tab that allows the recipient to enter numbers and decimal (.) points.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

concealValueOnDocumentstring

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

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

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

concealValueOnDocumentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the concealValueOnDocument property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

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 if the sender can edit the disableAutoSize property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

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 if the sender can edit the height property.

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 if the sender can edit the isPaymentAmount property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

localePolicylocalePolicyTab

Reserved for DocuSign.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

maxLengthstring

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

maxLengthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the maxLength property.

mergeFieldmergeField

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

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

originalValuestring

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

originalValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the originalValue property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

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 if the sender can edit the requireInitialOnSharedChange property.

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 if the sender can edit the senderRequired property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

validationMessagestring

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

validationMessageMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationMessage property.

validationPatternstring

A regular expression used to validate input for the tab.

validationPatternMetadatapropertyMetadata

Metadata that indicates if the sender can edit the validationPattern property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

page

Description of a page of a document.

dpistring

The number of dots per inch used for the page image.

errorDetailserrorDetails

If an error occurs, this property describes the error.

heightstring

The height of the page in pixels.

imageBytesstring

The number of image bytes.

mimeTypestring

The MIME type.

pageIdstring

The unique ID of the page.

sequencestring

The sequence of the page in the document, or page number.

widthstring

The width of the page in pixels.

pageSize

pageHeightstring

pageWidthstring

pathExtendedElement

namestring

typestring

Type of user:

  • type_owner
  • type_participant

typeNamestring

paymentDetails

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

allowedPaymentMethods[array]

An array of accepted payment methods:

  • CreditCard
  • ApplePay
  • AndroidPay
  • BankAccount

For example, if you only accept credit cards and ACH transfers, you would set this property to:

'["BankAccount", "CreditCard"]'

Do not specify BankAccount (ACH) if you are also using in-person signing.

chargeIdstring

The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The chargeId is created when authorizing a payment and must be referenced when completing a payment.

currencyCodestring

Specifies the three-letter ISO 4217 currency code for the payment.

Supported currencies are:

  • AUD Australian dollar
  • CAD Canadian dollar
  • EUR Euro
  • GBP Great Britain pound
  • USD United States dollar

Specifying any other ISO 4217 code for payments is an error.

currencyCodeMetadatapropertyMetadata

gatewayAccountIdstring

A GUID that identifies the payment gateway connected to the sender's DocuSign account.

There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the DocuSign Admin console and through your chosen payment gateway.

You can get the gateway account ID in the Payments section of the DocuSign Admin console.

gatewayAccountIdMetadatapropertyMetadata

gatewayDisplayNamestring

Display name of the gateway connected to sender's Docusign account.

Possible values are: Stripe, Braintree, Authorize.Net.

gatewayNamestring

Name of the gateway connected to sender's DocuSign account.

Possible values are:

  • Stripe
  • Braintree
  • AuthorizeDotNet

lineItems[paymentLineItem]

A payment formula can have one or more line items that provide detail about individual items in a payment request.

The list of line items are returned as metadata to the payment gateway.

paymentOptionstring

statusstring

This read-only property describes the status of a payment.

  • new
    This is a new payment request. The envelope has been created, but no payment authorizations have been made.

  • auth_complete
    A recipient has entered their credit card information, but the envelope has not been completed. The card has not been charged.

  • payment_complete
    The recipient's card has been charged.

  • payment_capture_failed
    Final charge failed. This can happen when too much time passes between authorizing the payment and completing the document.

totalmoney

This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields.

paymentLineItem

A line item describes details about an individual line item in a payment request.

amountReferencestring

This is a the tabLabel that specifies the amount paid for the line items.

descriptionstring

A sender-defined description of the line item.

itemCodestring

This is the sender-defined SKU, inventory number, or other item code for the line item.

namestring

This is a sender-defined product name, service name, or other designation for the line item.

polyLine

x1string

x2string

y1string

y2string

polyLineOverlay

This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

The ID of the document being accessed.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

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

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

graphicsContextgraphicsContext

Contains details about the style used for the strike through graphic.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

mergeFieldmergeField

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

overlayTypestring

The type of overlay to use. The API currently supports only the outline overlay type.

overlayTypeMetadatapropertyMetadata

Metadata that indicates whether the overlayType property is editable.

pageNumberstring

The page number being accessed.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

polyLines[polyLine]

An array of polyLine objects that contain x- and y-coordinates representing the locations of the lines.

recipientIdstring

The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

sharedstring

When set to true, indicates that the tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

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

Maximum of 500 characters.

tabOrderstring

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

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

tabOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabOrder property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

powerFormRecipient

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.

accessCodeLockedstring

accessCodeRequiredstring

emailstring

Filters returned user records by the specified email address.

emailLockedstring

idCheckConfigurationNamestring

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

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

idCheckRequiredstring

Determines how authentication is configured for the account. Valid values are:

  • always: Authentication checks are performed on every envelope.
  • never: Authentication checks are not performed on any envelopes.
  • optional: Authentication is configurable per envelope.

namestring

recipientTypestring

The recipient type.

roleNamestring

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

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

templateRequiresIdLookupstring

userNameLockedstring

propertyMetadata

Metadata about a property.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

radio

One of the selectable radio buttons in the radios property of a radioGroup tab.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

boldstring

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

boldMetadatapropertyMetadata

Metadata that indicates if the sender can edit the bold property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the fontColor property.

fontMetadatapropertyMetadata

Metadata that indicates if the sender can edit the font property.

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 if the sender can edit the fontSize property.

italicstring

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

italicMetadatapropertyMetadata

Metadata that indicates if the sender can edit the italic property.

lockedstring

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

lockedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the locked property.

pageNumberstring

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

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

requiredstring

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

requiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the required property.

selectedstring

When set to true, the radio button is selected.

selectedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the selected property.

statusstring

The status of the item.

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

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 if the sender can edit the tabOrder property.

underlinestring

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

underlineMetadatapropertyMetadata

Metadata that indicates if the sender can edit the underline property.

valuestring

Specifies the value of the tab.

valueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the value property.

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 if the sender can edit the xPosition property.

yPositionstring

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

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

radioGroup

This group tab is used to place radio buttons on a document. The radios property contains a list of radio objects associated with the group. Only one radio button can be selected in a group.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

groupNamestring

The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.

groupNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the groupName property.

radios[radio]

Specifies the locations and status for radio buttons that are grouped together.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

requireAllstring

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

requireAllMetadatapropertyMetadata

Metadata that indicates if the sender can edit the requireAll property.

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 if the sender can edit the requireInitialOnSharedChange property.

sharedstring

When set to true, this custom tab is shared.

sharedMetadatapropertyMetadata

Metadata that indicates if the sender can edit the shared property.

tabTypestring

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

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

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

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

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

tooltipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tooltip property.

recipientAttachment

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

namestring

remoteUrlstring

The URL of a previously staged chunkedUpload. This property is used as the reference to the blob of data when uploading an attachment, and cannot be used for downloads.

recipientEmailNotification

emailBodystring

Not applicable

emailBodyMetadatapropertyMetadata

emailSubjectstring

Not applicable

emailSubjectMetadatapropertyMetadata

supportedLanguagestring

Specifies the language used to localize Electronic Seals UI texts such as "Sealed by", etc.

The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).

This parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing.

supportedLanguageMetadatapropertyMetadata

recipientIdentityVerification

Specifies ID Verification applied on an envelope by workflow ID. See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other recipient authentication methods.

workflowIdstring

ID of the Identity Verification worklow used to verify recipients' identity.
This ID must match one of the workflowId available to your account.

recipientPhoneAuthentication

A complex type that Contains the elements:

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

recipMayProvideNumberstring

Boolean. When set to true, the recipient can supply a phone number their choice.

recipMayProvideNumberMetadatapropertyMetadata

recordVoicePrintstring

Reserved.

recordVoicePrintMetadatapropertyMetadata

senderProvidedNumbers[array]

An Array containing a list of phone numbers the recipient may use for SMS text authentication.

senderProvidedNumbersMetadatapropertyMetadata

validateRecipProvidedNumberstring

Reserved.

validateRecipProvidedNumberMetadatapropertyMetadata

recipientSignatureInformation

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

Used only with recipient types In Person Signers and Signers.

fontStylestring

signatureInitialsstring

signatureNamestring

Specifies the user signature name.

recipientSignatureProvider

An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.

sealDocumentsWithTabsOnlystring

By default, electronic seals apply on all documents in an envelope. If any of the documents has a signHere tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.

To apply electronic seals on specific documents only, you must enable the sealDocumentsWithTabsOnly parameter. In this case, Electronic Seal applies only on documents that have signHere tabs set for the Electronic Seal recipient. Other documents won't be sealed.

sealNamestring

Indicates the name of the electronic seal to apply on documents.

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.

signatureProviderNameMetadatapropertyMetadata

Metadata that indicates whether the signatureProviderName property is editable.

signatureProviderOptionsrecipientSignatureProviderOptions

Not applicable.

recipientSignatureProviderOptions

Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.

cpfNumberstring

Reserved for DocuSign

cpfNumberMetadatapropertyMetadata

oneTimePasswordstring

A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.

oneTimePasswordMetadatapropertyMetadata

signerRolestring

The role or capacity of the signing recipient. Examples: Manager, Approver, etc.

signerRoleMetadatapropertyMetadata

smsstring

The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.

smsMetadatapropertyMetadata

recipientSMSAuthentication

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

senderProvidedNumbers[array]

An Array containing a list of phone numbers the recipient may use for SMS text authentication.

senderProvidedNumbersMetadatapropertyMetadata

recipientUpdateResponse

combinedstring

This property is returned when you use the query parameter combine_same_order_recipients with the PUT Recipients call. When set to true, it indicates that the recipient has been combined or merged with a matching recipient.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

recipientIdstring

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

recipientIdGuidstring

The Guid for the recipient.

tabsEnvelopeRecipientTabs

All of the tabs associated with the recipient.

reminders

A complex element that specifies reminder settings for the envelope

reminderDelaystring

An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

reminderEnabledstring

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

reminderFrequencystring

An interger that sets the interval, in days, between reminder emails.

sealSign

Specifies one or more electronic seals to apply on documents.

"recipients": {
      "seals": [
        {
          "recipientId": "1",
          "routingOrder" : 1,
          "recipientSignatureProviders": [
            {
              "sealName": "52e9d968-13be-42ca-a6fe-4682bc45c106"
            }
          ]
        }
      ]
    },

For more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals

accessCodestring

Not applicable

accessCodeMetadatapropertyMetadata

Not applicable.

addAccessCodeToEmailstring

Not applicable

clientUserIdstring

Not applicable

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 allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTimestring

Not applicable

declinedReasonstring

Not applicable

deliveredDateTimestring

Not applicable

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

Not applicable

emailNotificationrecipientEmailNotification

Sets the language for electronic seals.

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

faxNumberstring

Reserved for DocuSign.

faxNumberMetadatapropertyMetadata

Metadata that indicates whether the faxNumber property is editable.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the idCheckConfigurationName property.

idCheckInformationInputidCheckInformationInput

Not applicable

inheritEmailNotificationConfigurationstring

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

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The name of the recipient.

notestring

Not applicable

noteMetadatapropertyMetadata

Not applicable

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Not applicable

recipientAuthenticationStatusauthenticationStatus

Not applicable

recipientFeatureMetadata[featureAvailableMetadata]

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

recipientIdstring

(Required) The recipientId used when the envelope or template was created.

recipientIdGuidstring

The Guid for the recipient.

recipientSignatureProviders[recipientSignatureProvider]

(Required) Indicates which electronic seal to apply on documents when creating an envelope.

recipientTypestring

The recipient type.

recipientTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient type.

requireIdLookupstring

Not applicable

requireIdLookupMetadatapropertyMetadata

Not applicable

roleNamestring

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

This is required when working with template recipients.

routingOrderstring

(Optional, default: 1) Specifies the routing order of the electronic seal in the envelope. The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

Not applicable

signedDateTimestring

Not applicable

smsAuthenticationrecipientSMSAuthentication

Not applicable

socialAuthentications[socialAuthentication]

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

statusstring

The status of the item.

statusCodestring

tabsEnvelopeRecipientTabs

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

Not applicable

userIdstring

Not applicable

signatureType

isDefaultstring

Indicates if the signature type is the default type.

typestring

Type of user:

  • type_owner
  • type_participant

signer

accessCodestring

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

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

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

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

accessCodeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the accessCode property.

addAccessCodeToEmailstring

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

agentCanEditEmailstring

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.

autoNavigationstring

When true, auto navigation is set for the recipient.

bulkRecipientsUristring

Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.

canSignOfflinestring

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

clientUserIdstring

Specifies whether the recipient is embedded or remote.

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

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

Maximum length: 100 characters.

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.

creationReasonstring

customFields[array]

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

declinedDateTimestring

The date and time the recipient declined the document.

declinedReasonstring

The reason the recipient declined the document.

defaultRecipientstring

When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.

deliveredDateTimestring

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

deliveryMethodstring

Reserved for DocuSign.

deliveryMethodMetadatapropertyMetadata

Reserved for DocuSign.

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

emailstring

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

Maximum length: 100 characters.

emailMetadatapropertyMetadata

Metadata that indicates if the signer can edit the email id of the recipient.

emailNotificationrecipientEmailNotification

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

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

embeddedRecipientStartURLstring

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

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

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

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

Example:

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

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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

Metadata that indicates whether the faxNumber property is editable.

firstNamestring

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

firstNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's first name.

fullNamestring

Reserved for DocuSign.

fullNameMetadatapropertyMetadata

Reserved for DocuSign.

idCheckConfigurationNamestring

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

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

idCheckConfigurationNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the idCheckConfigurationName property.

idCheckInformationInputidCheckInformationInput

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

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

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

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

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

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

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

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

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

identityVerificationrecipientIdentityVerification

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

inheritEmailNotificationConfigurationstring

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

isBulkRecipientstring

When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.

Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient.

isBulkRecipientMetadatapropertyMetadata

Metadata that indicates if the sender can edit the isBulkRecipient property.

lastNamestring

The recipient's last name.

lastNameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient's last name.

lockedRecipientPhoneAuthEditablestring

lockedRecipientSmsEditablestring

namestring

The full legal name of the recipient.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the full legal name of the recipient.

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

Metdata that indicates if the sender can edit the note sent to the recipient in the signing email.

phoneAuthenticationrecipientPhoneAuthentication

A complex type that Contains the elements:

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

recipientAttachments[recipientAttachment]

Reserved for DocuSign.

recipientAuthenticationStatusauthenticationStatus

Information about the authentication status of the recipient.

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 Guid for the recipient.

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

recipientTypestring

The recipient type.

recipientTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipient type.

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.

roleNamestring

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

This is required when working with template recipients.

routingOrderstring

Specifies the routing order of the recipient in the envelope.

routingOrderMetadatapropertyMetadata

Metadata that indicates if the sender can edit the routing order for the recipient.

sentDateTimestring

The date and time the envelope was sent.

signatureInforecipientSignatureInformation

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

Used only with recipient types In Person Signers and Signers.

signedDateTimestring

Reserved for DocuSign.

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

The id of the signing group of which the recipient is a member, if applicable.

signingGroupIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the signing group id.

signingGroupNamestring

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers[userInfo]

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

smsAuthenticationrecipientSMSAuthentication

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

socialAuthentications[socialAuthentication]

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

statusstring

Recipient status.

statusCodestring

tabsEnvelopeRecipientTabs

The tabs to assign to the recipient.

templateLockedstring

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

templateRequiredstring

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

totalTabCountstring

userIdstring

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

signerAttachment

A tab that allows the recipient to attach supporting documents to an envelope.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

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

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

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

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

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

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

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

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

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

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

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

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates if the sender can edit the optional property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

scaleValuestring

A value of 1 indicates 100% of the real value.

scaleValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the scaleValue property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabLabel property.

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 if the sender can edit the tabOrder property.

tabTypestring

Indicates the type of tab (for example, signHere or initialHere).

tabTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabType property.

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 if the sender can edit the templateLocked property.

templateRequiredstring

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

templateRequiredMetadatapropertyMetadata

Metadata that indicates if the sender can edit the templateRequired property.

tooltipstring

The text of a tooltip that appears when a user hovers over a form field or tab.

toolTipMetadatapropertyMetadata

Metadata that indicates if the sender can edit the toolTip property.

widthstring

The width of the tab in pixels.

widthMetadatapropertyMetadata

Metadata that indicates if the sender can edit the width property.

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 if the sender can edit the xPosition property.

yPositionstring

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

yPositionMetadatapropertyMetadata

Metadata that indicates if the sender can edit the yPosition property.

signHere

A tab that allows the recipient to sign a document. May be optional.

anchorCaseSensitivestring

Reserved for DocuSign.

anchorCaseSensitiveMetadatapropertyMetadata

Reserved for DocuSign.

anchorHorizontalAlignmentstring

Reserved for DocuSign.

anchorHorizontalAlignmentMetadatapropertyMetadata

Reserved for DocuSign.

anchorIgnoreIfNotPresentstring

When set to true, this tab is ignored if anchorString is not found in the document.

anchorIgnoreIfNotPresentMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorIgnoreIfNotPresent property.

anchorMatchWholeWordstring

Reserved for DocuSign.

anchorMatchWholeWordMetadatapropertyMetadata

Reserved for DocuSign.

anchorStringstring

Specifies the anchor string.

anchorStringMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorString property.

anchorTabProcessorVersionstring

Reserved for DocuSign.

anchorTabProcessorVersionMetadatapropertyMetadata

Reserved for DocuSign.

anchorUnitsstring

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorUnitsMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorUnits property.

anchorXOffsetstring

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorXOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorXOffset property.

anchorYOffsetstring

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffsetMetadatapropertyMetadata

Metadata that indicates if the sender can edit the anchorYOffset property.

conditionalParentLabelstring

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentLabelMetadatapropertyMetadata

Metadata that indicates if the sender can edit the conditionalParentLabel property.

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 if the sender can edit the conditionalParentValue property.

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 if the sender can edit the customTabId property.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

documentIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the documentId property.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; 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 if the sender can edit the formOrder property.

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 if the sender can edit the formPageLabel property.

formPageNumberstring

An integer specifying the order in which to present the guided form pages.

formPageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the fromPageNumber property.

heightstring

The height of the tab in pixels.

heightMetadatapropertyMetadata

Metadata that indicates if the sender can edit the height property.

isSealSignTabstring

When set to true, the tab contains a visual representation for an electronic seal in a document.

mergeFieldmergeField

Contains the information necessary to map the tab to a field in SalesForce.

namestring

Specifies the tool tip text for the tab.

nameMetadatapropertyMetadata

Metadata that indicates if the sender can edit the name property.

optionalstring

When set to true, the recipient does not need to complete this tab to complete the signing process.

optionalMetadatapropertyMetadata

Metadata that indicates if the sender can edit the optional property.

pageNumberstring

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

pageNumberMetadatapropertyMetadata

Metadata that indicates if the sender can edit the pageNumber property.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuidstring

The Guid for the recipient.

recipientIdGuidMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientGuid property.

recipientIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the recipientId property.

scaleValuestring

A value of 1 indicates 100% of normal tab size.

scaleValueMetadatapropertyMetadata

Metadata that indicates if the sender can edit the scaleValue property.

stampTypestring

If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.

stampTypeMetadatapropertyMetadata

Metadata that indicates if the sender can edit the stampType property.

statusstring

The status of the tab. Possible values are:

  • active
  • signed
  • declined
  • na

statusMetadatapropertyMetadata

Metadata that indicates if the sender can edit the status property.

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 if the sender can edit the tabGroupLabels property.

tabIdstring

The unique identifier for the tab.

tabIdMetadatapropertyMetadata

Metadata that indicates if the sender can edit the tabId property.

tabLabelstring

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabLabelMetadata