Folders: search

This method is deprecated in API v2.1.

Use Envelopes::listStatusChanges instead.

Retrieves a list of items that match the criteria specified in the query.

If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Request

HTTP request

GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}

Parameters

Parameter Name	Value	Description
Path Parameters
accountId	string	The external account number (int) or account ID GUID.
searchFolderId	string	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
Optional Query Parameters
all	string	Specifies that all envelopes that match the criteria are returned.
count	string	Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
from_date	string	Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
include_recipients	string	When set to true, the recipient information is returned in the response.
order	string	Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.
order_by	string	Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.
start_position	string	Specifies the the starting location in the result set of the items that are returned.
to_date	string	Specifies the end of the date range to return.

Responses

Code	Description	Reference
200	Successful response.	folderItemResponse
400	Error encountered.	errorDetails

Code

Description

Reference

200

Successful response.

folderItemResponse

400

Error encountered.

errorDetails

SDK Method

Folders::search

Definitions

addressInformation

Contains address information.
`address1`	string	The first line of the user's address. Maximum length: 100 characters.
`address2`	string	The second line of the user's address. Maximum length: 100 characters.
`city`	string	The user's city.
`country`	string	The user's country.
`fax`	string	A fax number associated with the address, if one is available.
`phone`	string	A phone number associated with the address.
`postalCode`	string	The user's postal code.
`stateOrProvince`	string	The user's state or province.

addressInformationInput

Contains address input information.
`addressInformation`	addressInformation	A complex type that contains the following information for the new account (all string content): address1, address2, city, country, fax, phone, postalCode and state. Note: If country is US (United States) then State codes are validated for US States. Otherwise, State is treated as a non-validated string and serves the purpose of entering a state/province/region. The maximum characters for the strings are: address1, address2, city, country and state: 100 characters postalCode, phone, and fax: 20 characters
`displayLevelCode`	string	Specifies the display level for the recipient. Valid values are: ReadOnly Editable DoNotDisplay
`receiveInResponse`	string	When set to true, the information needs to be returned in the response.

agent

Contains information about agent recipients.
`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates whether the `accessCode` property is editable.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending. Maximum length: 100 characters.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Metadata that indicates whether the `deliveryMethod` property is editable.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	The email id of the agent. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the email id of the agent.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	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.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Metadata that indicates whether the `faxNumber` property is editable.
`firstName`	string	The agent's first name. Maximum Length: 50 characters.
`firstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the agent's first name.
`fullName`	string	Reserved for DocuSign.
`fullNameMetadata`	propertyMetadata	Reserved for DocuSign.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates whether the `idCheckConfigurationName` property is editable.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lastName`	string	The agent's last name.
`lastNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the agent's last name.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The full legal name of the agent.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the full legal name of the agent.
`note`	string	A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the note sent to the recipient in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata that indicates whether the `recipientFeature` property is editable.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates whether the `recipientType` property is editable.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	The date and time the envelope was sent.
`signedDateTime`	string	Reserved for DocuSign.
`signingGroupId`	string	The id of the signing group of which the agent is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates whether the `signingGroupId` property is editable.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Metadata that indicates whether the `anchorCaseSensitive` property is editable.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Metadata that indicates whether the `anchorTabProcessorVersion` property is editable.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`buttonText`	string	Specifies the approval text that displays in the tab.
`buttonTextMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `buttonText` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates whether the `conditionalParentLabel` property is editable.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates whether the `formOrder` property is editable.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates whether the `formPageLabel` property is editable.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`pageNumber`	string	Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. The tab element uses this id to indicate which recipient is to sign the document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates whether the `recipientIdGuid` property is editable.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

authenticationStatus

Contains information about the authentication status.
`accessCodeResult`	eventResult
`ageVerifyResult`	eventResult
`anySocialIDResult`	eventResult
`facebookResult`	eventResult
`googleResult`	eventResult
`idLookupResult`	eventResult
`idQuestionsResult`	eventResult
`linkedinResult`	eventResult
`liveIDResult`	eventResult
`ofacResult`	eventResult
`openIDResult`	eventResult
`phoneAuthResult`	eventResult
`salesforceResult`	eventResult
`signatureProviderResult`	eventResult
`smsAuthResult`	eventResult
`sTANPinResult`	eventResult
`twitterResult`	eventResult
`yahooResult`	eventResult

carbonCopy

A carbon copy recipient.
`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates whether the `accessCode` property is editable.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`agentCanEditEmail`	string	Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.
`agentCanEditName`	string	Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `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.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Reserved for DocuSign.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the email id of the recipient.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	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.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Reserved for DocuSign.
`firstName`	string	The recipient's first name. Maximum Length: 50 characters.
`firstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's first name.
`fullName`	string	Reserved for DocuSign.
`fullNameMetadata`	propertyMetadata	Reserved for DocuSign.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `idCheckConfigurationName` property.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lastName`	string	The recipient's last name.
`lastNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's last name.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The full legal name of the recipient. Maximum Length: 100 characters.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the full legal name of the recipient.
`note`	string	A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata indicating if the sender can edit the note sent to the recipient in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient type.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	The date and time the envelope was sent.
`signedDateTime`	string	Reserved for DocuSign.
`signingGroupId`	string	The ID of the signing group of which the recipient is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signing group id.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string	The code for recipient's status.
`tabs`	EnvelopeRecipientTabs	A list of `commentTabs` that contains the carbon copy recipient's comments.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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


`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates whether the `accessCode` property is editable.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`agentCanEditEmail`	string	Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.
`agentCanEditName`	string	Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `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.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Reserved for DocuSign.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	The email id of the recipient.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the email address of the recipient.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	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.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Metadata that indicates whether the `faxNumber` property is editable.
`firstName`	string	The recipient's first name. Maximum Length: 50 characters.
`firstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's first name.
`fullName`	string	Reserved for DocuSign.
`fullNameMetadata`	propertyMetadata	Reserved for DocuSign.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `idCheckConfigurationName` property.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lastName`	string	The last name of the recipient.
`lastNameMetadata`	propertyMetadata	Metadata that indicates if the sender is able to edit the last name of the recipient.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The full legal name of the recipient.
`nameMetadata`	propertyMetadata	Metadata that indicates if the user can edit the full legal name of the recipient.
`note`	string	A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the note sent to the recipient in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient type.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	The date and time the envelope was sent.
`signedDateTime`	string	Reserved for DocuSign.
`signingGroupId`	string	The id of the signing group of which the recipient is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signing group id.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid of the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`required`	string	This property does not apply to `checkbox` tabs. Check boxes are always optional.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`selected`	string	When set to true, the checkbox is selected.
`selectedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `selected` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates whether the `shared` property is editable.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

comment


`envelopeId`	string	The Guid of the envelope the comment thread belongs to.
`hmac`	string	Reserved for DocuSign.
`id`	string	The unique identifier for the comment.
`mentions`	[array]	An array of userIds that are mentioned directly in the body of a comment.
`read`	boolean	When true, indicates that the comment was read.
`sentByEmail`	string	The email address of the user who created the comment.
`sentByFullName`	string	The full name of the user who created the comment.
`sentByImageId`	string	Reserved for DocuSign.
`sentByInitials`	string	The initials of the user who created the comment.
`sentByRecipientId`	string	The recipient id of the user who created the comment.
`sentByUserId`	string	The user id of the user who created the comment.
`signingGroupId`	string	The id of the signing group that can view the comment or that created the comment.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`subject`	string	The subject of the envelope.
`tabId`	string	The unique identifier for the tab that represents the comment thread.
`text`	string	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.
`threadId`	string	The unique identifier for the comment thread.
`threadOriginatorId`	string	The userId of the user who created the thread.
`timestamp`	string	The time the comment was created.
`timeStampFormatted`	string	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


`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Metadata that indicates whether the `anchorCaseSensitive` property is editable.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates whether the `anchorString` property is editable.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Metadata that indicates whether the `anchorTabProcessorVersion` property is editable.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates whether the `anchorXOffset` property is editable.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates whether the `anchorYOffset` property is editable.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	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.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	The ID of the document being accessed.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`pageNumber`	string	The page number being accessed.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	The `recipientId` used when the envelope or template was created.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the item.
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`threadId`	string	The unique identifier for the comment thread.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

company

A tab that displays the recipient's company name.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`concealValueOnDocument`	string	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`concealValueOnDocumentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `concealValueOnDocument` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`disableAutoSize`	string	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
`disableAutoSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `disableAutoSize` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`maxLength`	string	An optional value that describes the maximum length of the property when the property is a string.
`maxLengthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `maxLength` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`originalValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `originalValue` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates whether the `pageNumber` property is editable.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`concealValueOnDocument`	string	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`concealValueOnDocumentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `concealValueOnDocument` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`disableAutoSize`	string	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
`disableAutoSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `disableAutoSize` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`maxLength`	string	An optional value that describes the maximum length of the property when the property is a string.
`maxLengthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `maxLength` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`originalValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `originalValue` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	The unique id for the recipient. It is used by the tab element to indicate which recipient is to sign the document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`senderRequired`	string	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
`senderRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `senderRequired` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`validationMessage`	string	The message displayed if the custom tab fails input validation (either custom of embedded).
`validationMessageMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationMessage` property.
`validationPattern`	string	A regular expression used to validate input for the tab.
`validationPatternMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationPattern` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

dateSigned

A tab that displays the date that the recipient signed the document.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`buttonText`	string	Specifies the decline text displayed in the tab.
`buttonTextMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `buttonText` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`declineReason`	string	The reason the recipient declined the document.
`declineReasonMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `declineReason` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

dobInformationInput

Complex type containing: dateOfBirth displayLevelCode receiveInResponse
`dateOfBirth`	string	Specifies the recipient's date, month, and year of birth.
`displayLevelCode`	string	Specifies the display level for the recipient. Valid values are: ReadOnly Editable DoNotDisplay
`receiveInResponse`	string	When set to true, the information needs to be returned in the response.

documentVisibility


`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`rights`	string	Indicates whether the property is editable. Valid values are: `editable` `read_only`
`visible`	string

editor


`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `accessCode` property.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending. Maximum length: 100 characters.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Metadata that indicates whether the `deliveryMethod` property is editable.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the email id of the recipient.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Metadata that indicates whether the `faxNumber` property is editable.
`firstName`	string	The recipient's first name. Maximum Length: 50 characters.
`firstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's first name.
`fullName`	string	Reserved for DocuSign.
`fullNameMetadata`	propertyMetadata	Reserved for DocuSign.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `idCheckConfigurationName` property.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lastName`	string	The recipient's last name.
`lastNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's last name.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The full legal name of the recipient. Maximum Length: 100 characters.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the full legal name of the recipient.
`note`	string	A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the note sent to the recipient in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient type.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	The date and time the envelope was sent.
`signedDateTime`	string	Reserved for DocuSign.
`signingGroupId`	string	The id of the signing group of which the recipient is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signing group id.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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.

A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`concealValueOnDocument`	string	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`concealValueOnDocumentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `concealValueOnDocument` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`disableAutoSize`	string	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
`disableAutoSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `disableAutoSize` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`maxLength`	string	An optional value that describes the maximum length of the property when the property is a string.
`maxLengthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `maxLength` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`originalValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `originalValue` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`senderRequired`	string	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
`senderRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `senderRequired` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`validationMessage`	string	The message displayed if the custom tab fails input validation (either custom of embedded).
`validationMessageMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationMessage` property.
`validationPattern`	string	A regular expression used to validate input for the tab.
`validationPatternMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationPattern` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

emailAddress

A tab that displays the recipient's email as entered in the recipient information.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

envelopeId

A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

errorDetails

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

errorCode

string

A code associated with the error condition.

message

string

A brief message describing the error condition.

eventResult


`eventTimestamp`	string
`failureDescription`	string
`status`	string	Event status.
`vendorFailureStatusCode`	string

featureAvailableMetadata


`availabilty`	string
`featureName`	string

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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

folderItem_v2

Information about folder item results.
`completedDateTime`	string	Specifies the date and time this item was completed.
`createdDateTime`	string	The date and time the item was created.
`envelopeId`	string	The envelope ID of the envelope status that failed to post.
`envelopeUri`	string	Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
`expireDateTime`	string	The date and time the envelope is set to expire.
`folderId`	string	Unique identifier for the folder.
`folderUri`	string
`is21CFRPart11`	string	When set to true, indicates that this module is enabled on the account.
`ownerName`	string
`recipients`	EnvelopeRecipients	An array of recipient objects that provides details about the recipients of the envelope.
`recipientsUri`	string	Contains a URI for an endpoint that you can use to retrieve the recipients.
`senderCompany`	string
`senderEmail`	string
`senderName`	string
`senderUserId`	string
`sentDateTime`	string	The date and time the envelope was sent.
`status`	string	The status of the item.
`subject`	string
`templateId`	string	The ID of the template.
`templateUri`	string

folderItemResponse

Results from a folder item request.
`endPosition`	string	The last position in the result set.
`folderItems`	[folderItem_v2]	A list of the envelopes in the specified folder or folders.
`nextUri`	string	The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
`previousUri`	string	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.
`resultSetSize`	string	The number of results returned in this response.
`startPosition`	string	Starting position of the current result set.
`totalRows`	string	The total number of items in the result.

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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`concealValueOnDocument`	string	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`concealValueOnDocumentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `concealValueOnDocument` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`disableAutoSize`	string	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
`disableAutoSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `disableAutoSize` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`formula`	string	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
`formulaMetadata`	propertyMetadata	Metadata indicating if the sender can edit the `formula` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`hidden`	string	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.
`hiddenMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `hidden` property.
`isPaymentAmount`	string	When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.
`isPaymentAmountMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `isPaymentAmount` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`maxLength`	string	An optional value that describes the maximum length of the property when the property is a string.
`maxLengthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `maxLength` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`originalValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `originalValue` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`paymentDetails`	paymentDetails	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.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`roundDecimalPlaces`	string	The number of decimal places to round to.
`roundDecimalPlacesMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `roundDecimalPlaces` property.
`senderRequired`	string	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
`senderRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `senderRequired` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`validationMessage`	string	The message displayed if the custom tab fails input validation (either custom of embedded).
`validationMessageMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationMessage` property.
`validationPattern`	string	A regular expression used to validate input for the tab.
`validationPatternMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationPattern` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

fullName

A tab that displays the recipient's full name.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

graphicsContext


`fillColor`	string	The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a friendly CSS color name.
`lineColor`	string	The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a friendly CSS color name.
`lineWeight`	string	The line weight or thickness to use for the overlay.

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.
`addressInformationInput`	addressInformationInput
`dobInformationInput`	dobInformationInput	Complex type containing: dateOfBirth displayLevelCode receiveInResponse
`ssn4InformationInput`	ssn4InformationInput
`ssn9InformationInput`	ssn9InformationInput

initialHere

A tab that allows the recipient to initial the document. May be optional.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string	Specifies the tool tip text for the tab.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`optional`	string	When set to true, the recipient does not need to complete this tab to complete the signing process.
`optionalMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `optional` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`scaleValue`	string	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.
`scaleValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `scaleValue` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates 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.
`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates whether the `accessCode` property is editable.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`autoNavigation`	string	When true, auto navigation is set for the recipient.
`canSignOffline`	string	When set to true, specifies that the signer can perform the signing ceremony offline.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `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.
`completedCount`	string	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.
`creationReason`	string
`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.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`defaultRecipient`	string	When set to true, this is the default recipient for the envelope. This option is used when creating an envelope from a template.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	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.
`email`	string	The signer's email address in an eNotary flow. Use only when `inPersonSigningType` is `notary`. For regular in-person-signer flow, use `signerEmail` instead.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signer's email address in an eNotary flow.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	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.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Reserved for DocuSign.
`hostEmail`	string	The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters.
`hostEmailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the email address of the signing host.
`hostName`	string	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.
`hostNameMetadata`	propertyMetadata	Metadata that indicates whether the `hostName` property is editable.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates whether the `idCheckConfigurationName` property is editable.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`inPersonSigningType`	string	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.
`inPersonSigningTypeMetadata`	propertyMetadata	Metadata that indicates whether the `inPersonSigningType` property is editable.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	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.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signer's full legal name in an eNotary flow.
`notaryHost`	notaryHost	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.
`note`	string	A note sent to the in-person signer in the signing email. This note is visible only to this recipient. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the note sent to the in-person signer in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata that indicates whether the `recipientFeature` property is editable.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The 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.
`recipientSuppliesTabs`	string
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates whether the `recipientType` property is editable.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`requireSignerCertificate`	string	By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `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.
`requireSignOnPaper`	string	When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates whether the `routingOrder` property is editable.
`sentDateTime`	string	The date and time the envelope was sent.
`signatureInfo`	recipientSignatureInformation	Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
`signedDateTime`	string	Reserved for DocuSign.
`signerEmail`	string	The in-person signer's email address. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters.
`signerEmailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the in-person signer's email address.
`signerFirstName`	string	The first name of the in-person signer.
`signerFirstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the first name of the in-person signer.
`signerLastName`	string	The last name of the in-person siger.
`signerLastNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the last name of the in-person signer.
`signerName`	string	The in-person signer's full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters.
`signerNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the in-person signer's full legal name.
`signInEachLocation`	string	When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).
`signInEachLocationMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `signInEachLocation` property.
`signingGroupId`	string	The id of the signing group of which the in-person signer is a member.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates whether the `signingGroupId` property is editable.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string
`tabs`	EnvelopeRecipientTabs
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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


`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `accessCode` property.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending. Maximum length: 100 characters.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Reserved for DocuSign.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the email id of the recipient.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	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.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Metadata that indicates whether the `faxNumber` property is editable.
`firstName`	string	The recipient's first name. Maximum Length: 50 characters.
`firstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's first name.
`fullName`	string	Reserved for DocuSign.
`fullNameMetadata`	propertyMetadata	Reserved for DocuSign.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `idCheckConfigurationName` property.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lastName`	string	The recipient's last name.
`lastNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's last name.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The full legal name of the recipient.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the full legal name of the recipient.
`note`	string	A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the note to the recipient.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient type.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	The date and time the envelope was sent.
`signedDateTime`	string	Reserved for DocuSign.
`signingGroupId`	string	The id of the signing group of which the recipient is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signing group id.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	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.
`listSelectedValue`	string	The value in the list that is selected by default.
`listSelectedValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `listSelectedValue` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`senderRequired`	string	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
`senderRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `senderRequired` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	The value to use when the item is selected.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

listItem

One of the selectable items in the `listItems` property of a `list` tab.
`selected`	string	When set to true, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.
`selectedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `selected` property.
`text`	string	Specifies the text that is shown in the dropdown list.
`textMetadata`	propertyMetadata
`value`	string	Specifies the value that is used when the list item is selected.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.

localePolicyTab


`addressFormat`	string
`calendarType`	string
`cultureName`	string
`currencyNegativeFormat`	string
`currencyPositiveFormat`	string
`customDateFormat`	string
`customTimeFormat`	string
`dateFormat`	string
`initialFormat`	string
`nameFormat`	string
`timeFormat`	string
`timeZone`	string

mergeField

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
`allowSenderToEdit`	string	When true, the sender can modify the value of the `mergeField` tab during the sending process.
`allowSenderToEditMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `allowSenderToEdit` property.
`configurationType`	string	If merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.
`configurationTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `configurationType` property.
`path`	string	Sets the object associated with the custom tab. Currently this is the Salesforce Object.
`pathExtended`	[pathExtendedElement]	Reserved for DocuSign.
`pathExtendedMetadata`	propertyMetadata	Reserved for DocuSign.
`pathMetadata`	propertyMetadata	Metadata that indicates whether the `path` property is editable.
`row`	string	Specifies the row number in a Salesforce table that the merge field value corresponds to.
`rowMetadata`	propertyMetadata	Metadata that indicates whether the `row` property is editable.
`writeBack`	string	When true, data entered into the merge field during Signing will update the mapped Salesforce field.
`writeBackMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `writeBack` property.

money

Describes information about the `total` of a payment.
`amountInBaseUnit`	string	The total payment amount in the currency's base unit. For example, for USD the base currency is one cent.
`currency`	string	The three-letter ISO 4217 currency code for the payment. For example: AUD Australian dollar CAD Canadian dollar EUR Euro GBP Great Britain pound USD United States dollar This is a read-only property.
`displayAmount`	string	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.

notarize

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	The ID of the document being accessed.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`pageNumber`	string	The page number being accessed.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	The `recipientId` used when the envelope or template was created.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates 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.
`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `accessCode` property.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending. Maximum length: 100 characters.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Metadata that indicates whether the `deliveryMethod` property is editable.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	The notary's email address. Maximum Length: 100 characters.
`emailMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the notary's email address.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Reserved for DocuSign.
`hostRecipientId`	string
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates whether the `idCheckConfigurationName` property is editable.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The notary's full legal name. Maximum Length: 100 characters.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the notary's full legal name.
`note`	string	A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the note sent to the notary in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates whether the `recipientType` property is editable.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates whether the `routingOrder` property is editable.
`sentDateTime`	string	The date and time the envelope was sent.
`signedDateTime`	string	Reserved for DocuSign.
`signingGroupId`	string	The ID of the signing group of which the notary is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates whether the `signingGroupId` property is editable.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	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.
`statusCode`	string
`tabs`	EnvelopeRecipientTabs
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

number

A tab that allows the recipient to enter numbers and decimal (.) points.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`concealValueOnDocument`	string	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`concealValueOnDocumentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `concealValueOnDocument` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`disableAutoSize`	string	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
`disableAutoSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `disableAutoSize` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`formula`	string	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
`formulaMetadata`	propertyMetadata	Metadata indicating if the sender can edit the `formula` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`isPaymentAmount`	string	When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.
`isPaymentAmountMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `isPaymentAmount` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`maxLength`	string	An optional value that describes the maximum length of the property when the property is a string.
`maxLengthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `maxLength` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string	Specifies the tool tip text for the tab.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`originalValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `originalValue` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`senderRequired`	string	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
`senderRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `senderRequired` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`validationMessage`	string	The message displayed if the custom tab fails input validation (either custom of embedded).
`validationMessageMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationMessage` property.
`validationPattern`	string	A regular expression used to validate input for the tab.
`validationPatternMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `validationPattern` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

pathExtendedElement


`name`	string
`type`	string	Type of user: `type_owner` `type_participant`
`typeName`	string

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.
`chargeId`	string	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.
`currencyCode`	string	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.
`currencyCodeMetadata`	propertyMetadata
`gatewayAccountId`	string	A GUID that identifies the payment gateway connected to the sender's DocuSign account. There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the DocuSign Admin console and through your chosen payment gateway. You can get the gateway account ID in the Payments section of the DocuSign Admin console.
`gatewayAccountIdMetadata`	propertyMetadata
`gatewayDisplayName`	string	Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net.
`gatewayName`	string	Name of the gateway connected to sender's DocuSign account. Possible values are: `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.
`paymentOption`	string
`status`	string	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.
`total`	money	This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields.

paymentLineItem

A line item describes details about an individual line item in a payment request.
`amountReference`	string	This is a the `tabLabel` that specifies the amount paid for the line items.
`description`	string	A sender-defined description of the line item.
`itemCode`	string	This is the sender-defined SKU, inventory number, or other item code for the line item.
`name`	string	This is a sender-defined product name, service name, or other designation for the line item.

polyLine


`x1`	string
`x2`	string
`y1`	string
`y2`	string

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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	The ID of the document being accessed.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`graphicsContext`	graphicsContext	Contains details about the style used for the strike through graphic.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`overlayType`	string	The type of overlay to use. The API currently supports only the `outline` overlay type.
`overlayTypeMetadata`	propertyMetadata	Metadata that indicates whether the `overlayType` property is editable.
`pageNumber`	string	The page number being accessed.
`pageNumberMetadata`	propertyMetadata	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.
`recipientId`	string	The `recipientId` used when the envelope or template was created.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`shared`	string	When set to true, indicates that the tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

propertyMetadata

Metadata about a property.

options

[array]

An array of option strings supported by this setting.

rights

string

Indicates whether the property is editable. Valid values are:

editable
read_only

radio

One of the selectable radio buttons in the `radios` property of a `radioGroup` tab.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`selected`	string	When set to true, the radio button is selected.
`selectedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `selected` property.
`status`	string	The status of the item.
`statusMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `status` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`underline`	string	When set to true, the information in the tab is underlined.
`underlineMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `underline` property.
`value`	string	Specifies the value of the tab.
`valueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `value` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates 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.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`groupName`	string	The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.
`groupNameMetadata`	propertyMetadata	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.
`recipientId`	string	A unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`tooltipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tooltip` property.

recipientAttachment


`attachmentId`	string	The unique identifier for the attachment.
`attachmentType`	string	Specifies the type of the attachment for the recipient. Possible values are: `.htm` `.xml`
`data`	string	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.
`label`	string
`name`	string
`remoteUrl`	string	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


`emailBody`	string	Not applicable
`emailBodyMetadata`	propertyMetadata
`emailSubject`	string	Not applicable
`emailSubjectMetadata`	propertyMetadata
`supportedLanguage`	string	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.
`supportedLanguageMetadata`	propertyMetadata

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.

workflowId

string

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.
`recipMayProvideNumber`	string	Boolean. When set to true, the recipient can supply a phone number their choice.
`recipMayProvideNumberMetadata`	propertyMetadata
`recordVoicePrint`	string	Reserved.
`recordVoicePrintMetadata`	propertyMetadata
`senderProvidedNumbers`	[array]	An Array containing a list of phone numbers the recipient may use for SMS text authentication.
`senderProvidedNumbersMetadata`	propertyMetadata
`validateRecipProvidedNumber`	string	Reserved.
`validateRecipProvidedNumberMetadata`	propertyMetadata

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.
`fontStyle`	string
`signatureInitials`	string
`signatureName`	string	Specifies the user signature name.

recipientSignatureProvider

An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.
`sealDocumentsWithTabsOnly`	string	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.
`sealName`	string	Indicates the name of the electronic seal to apply on documents.
`signatureProviderName`	string	The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.
`signatureProviderNameMetadata`	propertyMetadata	Metadata that indicates whether the `signatureProviderName` property is editable.
`signatureProviderOptions`	recipientSignatureProviderOptions	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.
`cpfNumber`	string	Reserved for DocuSign
`cpfNumberMetadata`	propertyMetadata
`oneTimePassword`	string	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.
`oneTimePasswordMetadata`	propertyMetadata
`signerRole`	string	The role or capacity of the signing recipient. Examples: Manager, Approver, etc.
`signerRoleMetadata`	propertyMetadata
`sms`	string	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.
`smsMetadata`	propertyMetadata

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.

senderProvidedNumbersMetadata

propertyMetadata

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
`accessCode`	string	Not applicable
`accessCodeMetadata`	propertyMetadata	Not applicable.
`addAccessCodeToEmail`	string	Not applicable
`clientUserId`	string	Not applicable
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`customFields`	[array]	An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
`declinedDateTime`	string	Not applicable
`declinedReason`	string	Not applicable
`deliveredDateTime`	string	Not applicable
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Reserved for DocuSign.
`documentVisibility`	[documentVisibility]	Not applicable
`emailNotification`	recipientEmailNotification	Sets the language for electronic seals.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Metadata that indicates whether the `faxNumber` property is editable.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `idCheckConfigurationName` property.
`idCheckInformationInput`	idCheckInformationInput	Not applicable
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The name of the recipient.
`note`	string	Not applicable
`noteMetadata`	propertyMetadata	Not applicable
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Not applicable
`recipientAuthenticationStatus`	authenticationStatus	Not applicable
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	(Required) The `recipientId` used when the envelope or template was created.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientSignatureProviders`	[recipientSignatureProvider]	(Required) Indicates which electronic seal to apply on documents when creating an envelope.
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient type.
`requireIdLookup`	string	Not applicable
`requireIdLookupMetadata`	propertyMetadata	Not applicable
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	(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.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	Not applicable
`signedDateTime`	string	Not applicable
`smsAuthentication`	recipientSMSAuthentication	Not applicable
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	The status of the item.
`statusCode`	string
`tabs`	EnvelopeRecipientTabs
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string	Not applicable
`userId`	string	Not applicable

signer


`accessCode`	string	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
`accessCodeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `accessCode` property.
`addAccessCodeToEmail`	string	This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
`agentCanEditEmail`	string	Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.
`agentCanEditName`	string	Optional element. When set to true, the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.
`autoNavigation`	string	When true, auto navigation is set for the recipient.
`bulkRecipientsUri`	string	Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
`canSignOffline`	string	When set to true, specifies that the signer can perform the signing ceremony offline.
`clientUserId`	string	Specifies whether the recipient is embedded or remote. If the `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.
`completedCount`	string	Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again.
`creationReason`	string
`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.
`declinedDateTime`	string	The date and time the recipient declined the document.
`declinedReason`	string	The reason the recipient declined the document.
`defaultRecipient`	string	When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
`deliveredDateTime`	string	The date and time that the envelope was delivered to the recipient.
`deliveryMethod`	string	Reserved for DocuSign.
`deliveryMethodMetadata`	propertyMetadata	Reserved for DocuSign.
`documentVisibility`	[documentVisibility]	Valid values are: `Off` `MustSignToViewUnlessSenderAccount` `MustSignToViewUnlessSender` `SenderCanSetMustSignToViewUnlessSenderAccount` `SenderCanSetMustSignToViewUnlessSender`
`email`	string	Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
`emailMetadata`	propertyMetadata	Metadata that indicates if the signer can edit the email id of the recipient.
`emailNotification`	recipientEmailNotification	An optional complex type that sets a specific email subject and body for this recipient's notification email. Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope `Subject` and `EmailBlurb` property settings.
`embeddedRecipientStartURL`	string	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
`errorDetails`	errorDetails	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.
`faxNumber`	string	Reserved for DocuSign.
`faxNumberMetadata`	propertyMetadata	Metadata that indicates whether the `faxNumber` property is editable.
`firstName`	string	The recipient's first name. Maximum Length: 50 characters.
`firstNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's first name.
`fullName`	string	Reserved for DocuSign.
`fullNameMetadata`	propertyMetadata	Reserved for DocuSign.
`idCheckConfigurationName`	string	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account. These names can also be found in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as `ID Check $` and `SMS Auth $`. To use ID check in an envelope, the `idCheckConfigurationName` should be `ID Check $`. If you wanted to use SMS, it would be `SMS Auth $` and you would need to add phone number information to the `smsAuthentication` node.
`idCheckConfigurationNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `idCheckConfigurationName` property.
`idCheckInformationInput`	idCheckInformationInput	A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
`identityVerification`	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. 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).
`inheritEmailNotificationConfiguration`	string	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
`isBulkRecipient`	string	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.
`isBulkRecipientMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `isBulkRecipient` property.
`lastName`	string	The recipient's last name.
`lastNameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient's last name.
`lockedRecipientPhoneAuthEditable`	string
`lockedRecipientSmsEditable`	string
`name`	string	The full legal name of the recipient.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the full legal name of the recipient.
`note`	string	A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
`noteMetadata`	propertyMetadata	Metdata that indicates if the sender can edit the note sent to the recipient in the signing email.
`phoneAuthentication`	recipientPhoneAuthentication	A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved.
`recipientAttachments`	[recipientAttachment]	Reserved for DocuSign.
`recipientAuthenticationStatus`	authenticationStatus	Information about the authentication status of the recipient.
`recipientFeatureMetadata`	[featureAvailableMetadata]	Metadata about the features that are supported for the recipient type.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The 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.
`recipientSuppliesTabs`	string
`recipientType`	string	The recipient type.
`recipientTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the recipient type.
`requireIdLookup`	string	When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
`requireIdLookupMetadata`	propertyMetadata	Metadata that indicates whether the `requireIdLookup` property is editable.
`requireSignerCertificate`	string	By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `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.
`requireSignOnPaper`	string	When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.
`roleName`	string	Optional element. Specifies the role name associated with the recipient. This is required when working with template recipients.
`routingOrder`	string	Specifies the routing order of the recipient in the envelope.
`routingOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the routing order for the recipient.
`sentDateTime`	string	The date and time the envelope was sent.
`signatureInfo`	recipientSignatureInformation	Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
`signedDateTime`	string	Reserved for DocuSign.
`signInEachLocation`	string	When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).
`signInEachLocationMetadata`	propertyMetadata	Metadata that indicates whether the `signInEachLocation` property is editable.
`signingGroupId`	string	The id of the signing group of which the recipient is a member, if applicable.
`signingGroupIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the signing group id.
`signingGroupName`	string	The display name for the signing group. Maximum Length: 100 characters.
`signingGroupUsers`	[userInfo]	A complex type that contains information about users in the signing group.
`smsAuthentication`	recipientSMSAuthentication	Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
`socialAuthentications`	[socialAuthentication]	Lists the social ID type that can be used for recipient authentication.
`status`	string	Recipient status.
`statusCode`	string
`tabs`	EnvelopeRecipientTabs	The tabs to assign to the recipient.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`totalTabCount`	string
`userId`	string	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an 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.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`optional`	string	When set to true, the recipient does not need to complete this tab to complete the signing process.
`optionalMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `optional` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`scaleValue`	string	A value of `1` indicates 100% of the real value.
`scaleValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `scaleValue` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

signHere

A tab that allows the recipient to sign a document. May be optional.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`isSealSignTab`	string	When set to true, the tab contains a visual representation for an electronic seal in a document.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string	Specifies the tool tip text for the tab.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`optional`	string	When set to true, the recipient does not need to complete this tab to complete the signing process.
`optionalMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `optional` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`scaleValue`	string	A value of `1` indicates 100% of normal tab size.
`scaleValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `scaleValue` property.
`stampType`	string	If the recipient signs by using a personal stamp that is representative of their signature, this property specifies the stamp type.
`stampTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `stampType` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. The `signHere` tab appears 21 points lower than the value you provide here. To align the tab as expected, subtract 21 from the expected y-value. See Sign Here Tab Alignment
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

smartSection


`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`caseSensitive`	boolean
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`displaySettings`	smartSectionDisplaySettings
`documentId`	string	The ID of the document being accessed.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`endAnchor`	string
`endPosition`	smartSectionAnchorPosition	The last position in the result set.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`overlayType`	string
`overlayTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `overlayType` property.
`pageNumber`	string	The page number being accessed.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	The `recipientId` used when the envelope or template was created.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`removeEndAnchor`	boolean
`removeStartAnchor`	boolean
`shared`	string
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`startAnchor`	string
`startPosition`	smartSectionAnchorPosition	Starting position of the current result set.
`status`	string	The status of the item.
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateRequired` property.
`tooltip`	string	The text of a tooltip that appears when a user hovers over a form field or tab.
`toolTipMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `toolTip` property.
`width`	string	The width of the tab in pixels.
`widthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `width` property.
`xPosition`	string	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`xPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `xPosition` property.
`yPosition`	string	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
`yPositionMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `yPosition` property.

smartSectionAnchorPosition


`pageNumber`	integer	The page number being accessed.
`xPosition`	number	This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
`yPosition`	number	This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

smartSectionCollapsibleDisplaySettings


`arrowClosed`	string
`arrowColor`	string
`arrowLocation`	string
`arrowOpen`	string
`arrowSize`	string
`arrowStyle`	string
`containerStyle`	string
`labelStyle`	string
`onlyArrowIsClickable`	boolean
`outerLabelAndArrowStyle`	string

smartSectionDisplaySettings


`cellStyle`	string
`collapsibleSettings`	smartSectionCollapsibleDisplaySettings
`display`	string	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.
`displayLabel`	string
`displayOrder`	integer
`displayPageNumber`	integer
`hideLabelWhenOpened`	boolean
`inlineOuterStyle`	string
`labelWhenOpened`	string
`scrollToTopWhenOpened`	boolean
`tableStyle`	string

socialAuthentication

authentication

string

Reserved: TBD

ssn

A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.
`anchorCaseSensitive`	string	Reserved for DocuSign.
`anchorCaseSensitiveMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorHorizontalAlignment`	string	Reserved for DocuSign.
`anchorHorizontalAlignmentMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorIgnoreIfNotPresent`	string	When set to true, this tab is ignored if anchorString is not found in the document.
`anchorIgnoreIfNotPresentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorIgnoreIfNotPresent` property.
`anchorMatchWholeWord`	string	Reserved for DocuSign.
`anchorMatchWholeWordMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorString`	string	Specifies the anchor string.
`anchorStringMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorString` property.
`anchorTabProcessorVersion`	string	Reserved for DocuSign.
`anchorTabProcessorVersionMetadata`	propertyMetadata	Reserved for DocuSign.
`anchorUnits`	string	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
`anchorUnitsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorUnits` property.
`anchorXOffset`	string	Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`anchorXOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorXOffset` property.
`anchorYOffset`	string	Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`anchorYOffsetMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `anchorYOffset` property.
`bold`	string	When set to true, the information in the tab is bold.
`boldMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `bold` property.
`concealValueOnDocument`	string	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`concealValueOnDocumentMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `concealValueOnDocument` property.
`conditionalParentLabel`	string	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`conditionalParentLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentLabel` property.
`conditionalParentValue`	string	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
`conditionalParentValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `conditionalParentValue` property.
`customTabId`	string	The DocuSign-generated custom tab id for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
`customTabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `customTabId` property.
`disableAutoSize`	string	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
`disableAutoSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `disableAutoSize` property.
`documentId`	string	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
`documentIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `documentId` property.
`errorDetails`	errorDetails	Object that describes errors that occur. Only valid for responses; ignored in requests.
`font`	string	The font to be used for the tab value. Supported fonts include: Default Arial ArialNarrow Calibri CourierNew Garamond Georgia Helvetica LucidaConsole MSGothic MSMincho OCR-A Tahoma TimesNewRoman Trebuchet Verdana
`fontColor`	string	The font color to use for the information in the tab. Possible values are: Black BrightBlue BrightRed DarkGreen DarkRed Gold Green NavyBlue Purple White
`fontColorMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontColor` property.
`fontMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `font` property.
`fontSize`	string	The font size used for the information in the tab. Possible values are: Size7 Size8 Size9 Size10 Size11 Size12 Size14 Size16 Size18 Size20 Size22 Size24 Size26 Size28 Size36 Size48 Size72
`fontSizeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fontSize` property.
`formOrder`	string	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.
`formOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formOrder` property.
`formPageLabel`	string	A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
`formPageLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `formPageLabel` property.
`formPageNumber`	string	An integer specifying the order in which to present the guided form pages.
`formPageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `fromPageNumber` property.
`height`	string	The height of the tab in pixels.
`heightMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `height` property.
`italic`	string	When set to true, the information in the tab is italic.
`italicMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `italic` property.
`localePolicy`	localePolicyTab	Reserved for DocuSign.
`locked`	string	When set to true, the signer cannot change the data of the custom tab.
`lockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `locked` property.
`maxLength`	string	An optional value that describes the maximum length of the property when the property is a string.
`maxLengthMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `maxLength` property.
`mergeField`	mergeField	Contains the information necessary to map the tab to a field in SalesForce.
`name`	string	Specifies the tool tip text for the tab.
`nameMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `name` property.
`originalValue`	string	The initial value of the tab when it was sent to the recipient.
`originalValueMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `originalValue` property.
`pageNumber`	string	Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
`pageNumberMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `pageNumber` property.
`recipientId`	string	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
`recipientIdGuid`	string	The Guid for the recipient.
`recipientIdGuidMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientGuid` property.
`recipientIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `recipientId` property.
`requireAll`	string	When set to true and shared is true, information must be entered in this field to complete the envelope.
`requireAllMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireAll` property.
`required`	string	When set to true, the signer is required to fill out this tab.
`requiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `required` property.
`requireInitialOnSharedChange`	string	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
`requireInitialOnSharedChangeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `requireInitialOnSharedChange` property.
`senderRequired`	string	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
`senderRequiredMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `senderRequired` property.
`shared`	string	When set to true, this custom tab is shared.
`sharedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `shared` property.
`status`	string	The status of the tab. Possible values are: `active` `signed` `declined` `na`
`statusMetadata`	propertyMetadata	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.
`tabGroupLabelsMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabGroupLabels` property.
`tabId`	string	The unique identifier for the tab.
`tabIdMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabId` property.
`tabLabel`	string	The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
`tabLabelMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabLabel` property.
`tabOrder`	string	A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.
`tabOrderMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabOrder` property.
`tabType`	string	Indicates the type of tab (for example, `signHere` or `initialHere`).
`tabTypeMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `tabType` property.
`templateLocked`	string	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
`templateLockedMetadata`	propertyMetadata	Metadata that indicates if the sender can edit the `templateLocked` property.
`templateRequired`	string	When set to true, the sender may not remove the recipient. Used only when working with template recipients.
`templateRequiredMetadata`

Folders: search

Request

HTTP request

Parameters

Responses

SDK Method

Definitions

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