openapi: 3.0.1 info: title: DocuSign Admin AccountBrands EnvelopeRecipients API description: An API for an organization administrator to manage organizations, accounts and users termsOfService: https://www.docusign.com/company/terms-and-conditions/developers contact: name: DocuSign Developer Center url: https://developers.docusign.com email: devcenter@docusign.com version: v2.1 servers: - url: https://api.docusign.net/Management tags: - name: EnvelopeRecipients description: "\n\n\nThe EnvelopeRecipients resource allows you manage the recipients of an\nenvelope. There are seven recipient types. All types share\na [core set of parameters](#core-recipient-parameters).\nSome recipient types have additional parameters.\n\n
\n\n| Recipient type | Description |\n| :--- | :--- |\n| [Agents](#agents-recipient) | An agent recipient can add name and email information for recipients that appear after the agent in routing order. |\n| [Carbon Copies](#carbon-copies-recipient) | Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. |\n| [Certified Deliveries](#certified-deliveries-recipient) | Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. |\n| [Editors](#editors-recipient) | Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. |\n| [In-Person Signers](#in-person-signers-recipient) | An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. |\n| [Intermediaries](#intermediaries-recipient) | An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. |\n| [Seals](#seal-recipient) | An electronic seal recipient represents a legal person. Electronic seals can be used by organizations and governments to show evidence of origin and integrity of documents. |\n| [Signers](#signers-recipient) | A signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope. |\n\n
\n\nNot all recipients are are available to all account types.\nReview your account plan to determine\nwhich recipient types are available to you.\nAll recipient types are available in the Demo environment.\n\n\n## Core Recipient Parameters\n\nAll recipients, regardless of type, have the same common parameters.\nThe following table contains the descriptions\nfor the core properties for all recipient types.\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters. |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that 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. |\n| embeddedRecipientStartURL | No | String | This is 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, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, 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 would be 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 and 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 the `EmbeddedRecipientStartURL` property to `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 one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

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

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |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. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:

*emailBody*: a string with the email message sent to the recipient.
Maximum Length: 10000 characters.

*emailSubject*: a string with the subject of the email sent to the recipient.
Maximum Length: 100 characters.

*supportedLanguage*: The simple type enumeration of the language used. 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).

**IMPORTANT**: If this is enabled for one recipient, it overrides the Envelope Subject and `EmailBlurb` property settings. Also, you must set the `emailNotification` property for all recipients. |\n| excludedDocuments | No | Array of Strings | 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 the enforceSignerVisibility property is set to **true**, 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. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This 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` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element 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 street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: 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. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If 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. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

*recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to.

*senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use.

*recordVoicePrint* - Reserved for DocuSign.

*validateRecipProvidedNumber* - Reserved for DocuSign. | |\n| recipientAttachment | No | Attachment | Reserved for DocuSign. |\n| recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the envelope. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender may not remove the recipient. |\n\n
\n\n**JSON layout**\n\n```\n\"email\": \"email.name@company.com\",\n \"name\": \"recipient name\",\n \"accessCode\": \"\",\n \"addAccessCodeToEmail\": false,\n \"clientUserIs\": null,\n \"embeddedRecipientStartURL\": \"string\",\n \"customFields\": {\n \"sample string 1\",\n \"sample string 2\"\n },\n \"emailNotification\"{\n \"emailBody\":\"email text\",\n \"emailSubject\":\"Subject text\",\n \"supportedLanguage\":\"en\",\n },\n \"excludedDocuments\": [\"2\", \"4\"],\n \"idCheckConfigurationName\": null,\n \"idCheckInformationInput\": {\n \"addressInformationInput\": {\n \"addressInformation\": {\n \"street1\": \"sample string 1\",\n \"street2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"zip\": \"sample string 5\",\n \"zipPlus4\": \"sample string 6\"\n },\n \"displayLevelCode\": \"sample string 1\",\n \"receiveInResponse\": \"sample string 2\"\n },\n \"dobInformationInput\": {\n \"dateOfBirth\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn4InformationInput\": {\n \"ssn4\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn9InformationInput\": {\n \"ssn9\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\"\n }\n },\n \"inheritEmailNotificationConfiguration\": false,\n \"note\": \"\",\n \"phoneAuthentication\": {\n \"recipMayProvideNumber\": \"sample string 1\",\n \"validateRecipProvidedNumber\": \"sample string 2\",\n \"recordVoicePrint\": \"sample string 3\",\n \"senderProvidedNumbers\": [\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"recipientAttachment\": null,\n \"recipientCaptiveInfo\": null,\n \"recipientId\": \"1\",\n \"requireIdLookup\": false,\n \"roleName\": \"\",\n \"routingOrder\": 1,\n \"smsAuthentication\": {\n \"senderProvidedNumbers\":[\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"socialAuthentications\": null,\n \"templateAccessCodeRequired\": false,\n \"templateLocked\": false,\n \"templateRequired\": false,\n...\n```\n\n\n## Agents Recipient\n\nAn agent recipient can add name and email information for recipients that appear after the agent in routing order.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | 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. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n
\n\n**JSON layout**\n\n```\n\"agents\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\n\n## Carbon Copies Recipient\n\nCarbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed.\n\nThis recipient type uses only the [core parameters](#core-recipient-parameters).\n\n**JSON layout**\n\n```\n\"carbonCopies\": [{\n \n```\n\n\n## Certified Deliveries Recipient\n\nCertified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.\n\nThis recipient type uses only the [core parameters](#core-recipient-parameters).\n\n**JSON layout**\n\n```\n\"certifiedDeliveries\": [{\n\n}],\n```\n\n## Editors Recipient\n\nEditors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n
\n\n\n**JSON layout**\n\n```\n\"editors\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\n\n## In-Person Signers Recipient\n\nAn in-person recipient is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\nThe following restrictions apply\nto using electronic notary when sending documents:\n\n* Authentication methods are allowed for the signer but not the notary.\n* The Sign On Paper, Document Markup, Field Markup and Change Signer options cannot be used for the documents.\n* Tabs may be assigned to the signer, but cannot be assigned to the notary.\n\nRefer to [eNotary Resources][enotary-resources]\nin the DocuSign Support Center for more information\nabout how the eNotary feature works.\n\n
\n\n| Name | Required | Schema Type | Description |\n| :------------------ | :---------------------------------------------------------------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| inPersonSigningType | No | String | Specifies whether the envelope uses the eNotary feature. The accepted values are:

`inPersonSigner` The envelope uses the normal in-person signing flow.
`notary`: The envelope uses the eNotary signing flow.

`recipientId`: A unique ID number for the notary signing host.
`name`: Specifies the notary's full legal name.
`email`: Specifies the notary's email address.

|\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient. |\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. |\n| hostName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. |\n| hostEmail | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. |\n| signerName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's full legal name. |\n| signerEmail | No, but valid only when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's email address. |\n| name | Yes, when `inPersonSigningType` is `notary` | String | The full legal name of the signer in an eNotary flow. |\n| email | Yes, when `inPersonSigningType` is `notary` | String | The signer's email address in an eNotary flow. |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signInEachLocation | No | Boolean | 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). |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource][envelopeRecipientTabsResource] for more information about tabs. |\n\n
\n\n**JSON layout**\n\n```\n\"inPersonSigners\": [{\n \"hostEmail\": \"signing.host@company.com\",\n \"hostName\": \"Mike Host\",\n \n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"signerEmail\": \"inperson.signer@company.com\",\n \"signerName\": \"Isaac Inperson\",\n \"email\": \"notary.signer@example.com\",\n \"name\": \"Notary Signer\"\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"envelopeIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n \"inPersonSigningType\": \"notary\",\n \"notaryHost\": {\n \"email\": \"notary@example.com\",\n \"name\": \"Natalie Notary\",\n \"recipientId\": \"string\"\n }\n}],\n```\n\n\n## Intermediaries Recipient\n\nAn intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | 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. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n
\n\n**JSON layout**\n\n```\n\"intermediaries\": [{\n\n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\n\n\n## Seals Recipient\n\nAn electronic seal recipient is not a natural but a legal person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents.\nEven though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\nElectronic seal recipients rely on a subset of core properties. They also add a new `recipientSignatureProviders` parameter.\n\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| recipientId| Yes | String | Indicates the unique ID of the applied electronic seal.
|\n| routingOrder| No (default: 1) | String | 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.. |\n| recipientSignatureProviders| Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n\nBy default, Electronic Seals apply on all documents in an envelope. However, the sealDocumentsWithTabsOnly property (see recipientSignatureProvider) allows you to seal only documents that have signHere tabs set for the Electronic Seal recipients.\n\n\n\n**JSON layout (Apply Electronic Seals on all documents)**\n```\n{\n ....\n\n \"recipients\": {\n \"seals\": [ {\n \"recipientId\": \"10\",\n \"routingOrder\" : 2,\n \"recipientSignatureProviders\": [{\n \"sealName\": \"ed8f186c-3b12-45cb-9eb3-c8c33dc4f6b0\",\n \"sealDocumentsWithTabsOnly\": \"false\"\n }]\n }]\n },\n \"documents\": [\n {\n \"documentId\": \"55\",\n \"name\": \" ACME Contract\",\n \"fileExtension\": \"pdf\",\n \"documentBase64\": \"DOC_IN_BASE64\"\n }\n ]\n}\n```\n\n\n\n**JSON layout (Apply Electronic Seals on specific documents)**\n```\n{\n ....\n\n \"recipients\": {\n \"seals\": [{\n \"recipientId\": \"10\",\n \"routingOrder\" : 2,\n \"recipientSignatureProviders\": [{\n \"sealName\": \"ed8f186c-3b12-45cb-9eb3-c8c33dc4f6b0\",\n \"sealDocumentsWithTabsOnly\": \"true\"\n }],\n \"tabs\": {\n \"signHereTabs\": [{\n \"documentId\": \"55\",\n \"recipientId\": \"10\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"272\",\n \"yPosition\": \"98\",\n }]\n }\n }]\n },\n \"documents\": [{\n \"documentId\": \"55\",\n \"name\": \" ACME Contract\",\n \"fileExtension\": \"pdf\",\n \"documentBase64\": \"DOC_EN_BASE64\"\n }]\n}\n```\n\n\n\n\n## Signers Recipient\n\nA signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | 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). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.
Maximum Length: 100 characters. |\n| signerName | Yes | String | Required element with recipient type In Person Signers.
Maximum Length: 100 characters.

The full legal name of a signer for the envelope. |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the the [EnvelopeTabs resource][envelopeTabsResource] for more information about tabs. |\n| deliveryMethod | No | String | Reserved for DocuSign.|\n| deliveredDateTime | No | DateTime | Reserved for DocuSign. |\n| signedDateTime | No | DateTime | Reserved for DocuSign. |\n| offlineAttributes | No | | Reserved for DocuSign.|\n\n
\n\n**JSON layout**\n\n```\n\"Signers\": [{\n\n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"envelopeIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n \"deliveryMethod\":\"\",\n \"deliveredDateTime\":\"String Content\",\n \"signedDateTime\":\"String Content\",\n \"offlineAttributes\":{\n \"deviceName\":\"String Content\",\n \"deviceModel\":\"String Content\",\n \"gpsLatitude\":\"String Content\",\n \"gpsLongitude\":\"String Content\",\n \"accountEsignId\":\"String Content\"\n }\n}],\n```\n\n[envelopeRecipientTabsResource]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/\n[enotary-resources]: https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources\n\n" paths: /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients: get: tags: - EnvelopeRecipients summary: Docusign Gets the status of recipients for an envelope. description: 'Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.' operationId: Recipients_GetRecipients parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: include_anchor_tab_locations in: query description: ' When set to **true** and `include_tabs` value is set to **true**, all tabs with anchor tab properties are included in the response. ' schema: type: string - name: include_extended in: query description: ' When set to **true**, the extended properties are included in the response. ' schema: type: string - name: include_tabs in: query description: When set to **true**, the tab information associated with the recipient is included in the response. schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeRecipients' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: listRecipients x-ds-method: list x-ds-service: Envelopes x-ds-in-sdk: true x-ds-examples: - description: 'This example shows the result of an envelope with one signer and a CC''ed recipient. ### Request The request for this endpoint has no payload. ``` GET /restapi/v2/accounts/1703061/envelopes/44efc9e6-915e-4b1d-9b54-801410d6922d/recipients ``` ' direction: response format: json response: agents: [] carbonCopies: - email: aoneil@example.com name: Ariana O'Neill recipientId: '2' recipientIdGuid: 72edf9b6-4a4e-4c24-b982-86bc5d598bb8 requireIdLookup: 'false' routingOrder: '2' status: completed userId: b72bd827-096b-4c40-b33d-64ab32f0a0eb certifiedDeliveries: [] currentRoutingOrder: '1' editors: [] inPersonSigners: [] intermediaries: [] recipientCount: '2' signers: - deliveredDateTime: 2016-10-05 21:18:12.333000+00:00 email: jallard@example.com isBulkRecipient: 'false' name: Jennie Allard recipientId: '1' recipientIdGuid: 4575d5e9-7654-467b-b2f5-6c59ca7c43f8 requireIdLookup: 'false' routingOrder: '1' signedDateTime: 2016-10-05 21:18:41.693000+00:00 status: completed userId: ca45284a-a94e-4ee2-90af-76035bd795b2 style: custom title: List Recipients and CC-ed Recipients - description: 'This example shows the method''s response after the envelope was signed. The signer recipient successfully authenticated using: * An access code (a pre-shared secret between the sender and the signer) * Authentication via Facebook. The Facebook email address is recorded in the Certificate of Completion ' direction: response format: json response: agents: [] carbonCopies: [] certifiedDeliveries: [] currentRoutingOrder: '1' editors: [] inPersonSigners: [] intermediaries: [] recipientCount: '1' signers: - accessCode: '1234' deliveredDateTime: 2016-07-11 06:19:36.420000+00:00 email: larry@example.com idCheckConfigurationName: Facebook isBulkRecipient: 'false' name: Larry Smithers recipientAuthenticationStatus: accessCodeResult: eventTimestamp: 2016-07-11 06:18:55.717000+00:00 status: Passed facebookResult: eventTimestamp: 2016-07-11 06:19:28.317000+00:00 status: Passed recipientId: '1' recipientIdGuid: 9670e679-adbd-4d1b-913d-02b43027cb0a requireIdLookup: 'true' routingOrder: '1' signInEachLocation: 'false' signedDateTime: 2016-07-11 06:19:44.747000+00:00 status: completed userId: 57a7b68f-0113-4870-9385-381042d14ca5 style: custom title: List Recipients Who Used Facebook and Access Code Authentication put: tags: - EnvelopeRecipients summary: Docusign Updates recipients in a draft envelope or corrects recipient information for an in process envelope. description: "Updates recipients in a draft envelope or corrects recipient information for an in process envelope. \n\nFor draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.\n\nOnce an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `signingGroupId`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option.\n\nIf you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST)." operationId: Recipients_PutRecipients parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: offline_signing in: query schema: type: string - name: resend_envelope in: query description: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeRecipients' application/xml: schema: $ref: '#/components/schemas/EnvelopeRecipients' required: false responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/recipientsUpdateSummary' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: updateRecipients x-ds-method: update x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: EnvelopeRecipients post: tags: - EnvelopeRecipients summary: Docusign Adds one or more recipients to an envelope. description: 'Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient''s routing order is before or the same as the envelope''s next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.' operationId: Recipients_PostRecipients parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: resend_envelope in: query description: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeRecipients' application/xml: schema: $ref: '#/components/schemas/EnvelopeRecipients' required: false responses: '201': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeRecipients' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: createRecipient x-ds-method: create x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: EnvelopeRecipients delete: tags: - EnvelopeRecipients summary: Docusign Deletes recipients from an envelope. description: 'Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.' operationId: Recipients_DeleteRecipients parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/EnvelopeRecipients' application/xml: schema: $ref: '#/components/schemas/EnvelopeRecipients' required: false responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeRecipients' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: deleteRecipients x-ds-method: deleteList x-ds-service: Envelopes x-ds-in-sdk: true x-codegen-request-body-name: EnvelopeRecipients /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}: delete: tags: - EnvelopeRecipients summary: Docusign Deletes a recipient from an envelope. description: 'Deletes a recipient from a `draft` or `sent` envelope. If the envelope is "In Process" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.' operationId: Recipients_DeleteRecipient parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: recipientId in: path description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: true schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeRecipients' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: deleteRecipient x-ds-method: delete x-ds-service: Envelopes x-ds-in-sdk: true components: schemas: samlAssertionAttribute: type: object properties: errorDetails: $ref: '#/components/schemas/errorDetails' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' value: type: string description: The value associated with the named SAML assertion attribute description: '' x-ds-definition-name: samlAssertionAttribute x-ms-summary: '' company: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s company name. ' x-ds-definition-name: company x-ms-summary: 'A tab that displays the recipient''s company name. ' recipientProofFile: type: object properties: isInProofFile: type: string description: '' description: '' x-ds-definition-name: recipientProofFile x-ms-summary: '' radioGroup: type: object properties: conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. groupName: type: string description: The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. radios: type: array description: Specifies the locations and status for radio buttons that are grouped together. items: $ref: '#/components/schemas/radio' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. shared: type: string description: When set to **true**, this custom tab is shared. templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' description: 'This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio) objects associated with the group. Only one radio button can be selected in a group. ' x-ds-definition-name: radioGroup x-ms-summary: 'This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio) objects associated with the group. Only one radio button can be selected in a group. ' dobInformationInput: type: object properties: dateOfBirth: type: string description: Specifies the recipient's date, month, and year of birth. displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" receiveInResponse: type: string description: When set to **true**, the information needs to be returned in the response. description: 'Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse' x-ds-definition-name: dobInformationInput x-ms-summary: 'Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse' dateSigned: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the date that the recipient signed the document. ' x-ds-definition-name: dateSigned x-ms-summary: 'A tab that displays the date that the recipient signed the document. ' ssn4InformationInput: type: object properties: displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" receiveInResponse: type: string description: When set to **true**, the information needs to be returned in the response. ssn4: type: string description: The last four digits of the recipient's Social Security Number (SSN). description: '' x-ds-definition-name: ssn4InformationInput x-ms-summary: '' editor: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: The recipient's last name. name: type: string description: 'legal name of the recipient. Maximum Length: 100 characters.' note: type: string description: '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. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: editor x-ms-summary: '' errorDetails: type: object properties: errorCode: type: string description: An error code associated with the error. message: type: string description: A short error message. description: This object describes errors that occur. It is only valid for responses, and ignored in requests. x-ds-definition-name: errorDetails x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests. list: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. listItems: type: array description: "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. \n" items: $ref: '#/components/schemas/listItem' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: The value to use when the item is selected. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem) objects to specify the selectable options. ' x-ds-definition-name: list x-ms-summary: 'This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem) objects to specify the selectable options. ' propertyMetadata: type: object properties: options: type: array description: '' items: type: string rights: type: string description: '' description: '' x-ds-definition-name: propertyMetadata x-ms-summary: '' smartSectionDisplaySettings: type: object properties: cellStyle: type: string description: '' collapsibleSettings: $ref: '#/components/schemas/smartSectionCollapsibleDisplaySettings' display: type: string description: "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n" displayLabel: type: string description: '' displayOrder: type: integer description: '' format: int32 displayPageNumber: type: integer description: '' format: int32 hideLabelWhenOpened: type: boolean description: '' inlineOuterStyle: type: string description: '' labelWhenOpened: type: string description: '' preLabel: type: string description: '' scrollToTopWhenOpened: type: boolean description: '' tableStyle: type: string description: '' description: '' x-ds-definition-name: smartSectionDisplaySettings x-ms-summary: '' EnvelopeRecipientTabs: type: object properties: approveTabs: type: array description: "A list of\n[Approve tabs][approve].\n\n\nThis tab allows\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n" items: $ref: '#/components/schemas/approve' checkboxTabs: type: array description: 'A list of [Checkbox tabs][checkbox]. This tab allows the recipient to select a yes/no (on/off) option. [checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox ' items: $ref: '#/components/schemas/checkbox' companyTabs: type: array description: "A list of \n[Company tabs][company].\n\n\nThis tab displays the recipient's company name.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n" items: $ref: '#/components/schemas/company' dateSignedTabs: type: array description: "A list of \n[Date Signed tabs][dateSigned]\n\n\nThis tab displays the date that the recipient signed the\ndocument.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n" items: $ref: '#/components/schemas/dateSigned' dateTabs: type: array description: "A list of \n[Date tabs][date].\n\n\nThis tab allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n" items: $ref: '#/components/schemas/date' declineTabs: type: array description: "A list of \n[Decline tabs][decline].\n\nThis tab allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n" items: $ref: '#/components/schemas/decline' emailAddressTabs: type: array description: "A list of \n[Email Address tabs][emailAddress].\n\nThis tab \ndisplays the recipient's email as entered in the\nrecipient information.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n" items: $ref: '#/components/schemas/emailAddress' emailTabs: type: array description: "A list of \n[Email tabs][email].\n\nThis tab \nallows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n" items: $ref: '#/components/schemas/email' envelopeIdTabs: type: array description: "A list of \n[Envelope ID tabs][envelopeId].\n\nThis tab \ndisplays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n" items: $ref: '#/components/schemas/envelopeId' firstNameTabs: type: array description: "A list of \n[First Name tabs][firstName].\n\nThis tab \ndisplays the recipient's first name. It\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n" items: $ref: '#/components/schemas/firstName' formulaTabs: type: array description: "A list of [Formula tabs][formulaTab].\n\nThe value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n" items: $ref: '#/components/schemas/formulaTab' fullNameTabs: type: array description: "A list of \n[Full Name tabs][fullName].\n\nThis tab \ndisplays the recipient's full name.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n" items: $ref: '#/components/schemas/fullName' initialHereTabs: type: array description: "A list of \n[Initial Here tabs][initialHere].\n\nThis tab allows the recipient to initial the document. May\nbe optional.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n" items: $ref: '#/components/schemas/initialHere' lastNameTabs: type: array description: "A list of \n[Last Name tabs][lastName].\n\nThis tab \ndisplays the recipient's last name. It\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n" items: $ref: '#/components/schemas/lastName' listTabs: type: array description: "A list of \n[list tabs][list].\n\nThis tab offers a list of options to choose from. The\n`listItems` property is used to specify the selectable\noptions.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n" items: $ref: '#/components/schemas/list' notarizeTabs: type: array description: "A list of \n[Notarize tabs][notarize].\n\nA notarize tab is a tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n" items: $ref: '#/components/schemas/notarize' noteTabs: type: array description: "A list of \n[Note tabs][note].\n\nThis tab displays additional information, in the form of a\nnote, for the recipient.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n" items: $ref: '#/components/schemas/note' numberTabs: type: array description: "A list of \n[Number tabs][number].\n\nThis tab allows the recipient to enter numbers and decimal\n(.) points.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n" items: $ref: '#/components/schemas/number' radioGroupTabs: type: array description: "A list of \n[Radio Group tabs][radioGroup].\n\nThis tab \nThis group tab is used to place radio buttons on a document.\nThe `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can\nbe selected in a group.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n" items: $ref: '#/components/schemas/radioGroup' signerAttachmentTabs: type: array description: "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis tab \nallows the recipient to attach supporting\ndocuments to an envelope.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n" items: $ref: '#/components/schemas/signerAttachment' signHereTabs: type: array description: "A list of \n[Sign Here tabs][signHere].\n\nThis tab allows the recipient to sign a document. May be\noptional.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n" items: $ref: '#/components/schemas/signHere' smartSectionTabs: type: array description: '' items: $ref: '#/components/schemas/smartSection' ssnTabs: type: array description: "A list of \n[SSN tabs][ssn].\n\nThis tab \nis a one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n" items: $ref: '#/components/schemas/ssn' textTabs: type: array description: "A list of \n[Text tabs][text].\n\nThis tab \nA tab that allows the recipient to enter any type of text.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n" items: $ref: '#/components/schemas/text' titleTabs: type: array description: "A list of \n[Title tabs][title].\n\nThis tab displays the recipient's title.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n" items: $ref: '#/components/schemas/title' viewTabs: type: array description: "A list of \n[View tabs][view].\n\nThis tab \nThis tab is used with the Approve tab to handle\nsupplemental documents.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n" items: $ref: '#/components/schemas/view' zipTabs: type: array description: "A list of \n[Zip tabs][zip].\n\nThis tab \nallows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n" items: $ref: '#/components/schemas/zip' description: 'All of the tabs associated with a recipient. Each property is a list of a type of tab. ' x-ds-definition-name: tabs x-ds-category: Envelopes x-ds-order: '50' x-ms-summary: 'All of the tabs associated with a recipient. Each property is a list of a type of tab. ' title: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s title. ' x-ds-definition-name: title x-ms-summary: 'A tab that displays the recipient''s title. ' recipientSignatureProviderOptions: type: object properties: cpfNumber: type: string description: Reserved for DocuSign oneTimePassword: type: string description: '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.' signerRole: type: string description: 'The role or capacity of the signing recipient. Examples: Manager, Approver, etc.' sms: type: string description: '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.' description: Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) x-ds-definition-name: recipientSignatureProviderOptions x-ms-summary: Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) EnvelopeRecipients: type: object properties: agents: type: array description: A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. items: $ref: '#/components/schemas/agent' carbonCopies: type: array description: A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. items: $ref: '#/components/schemas/carbonCopy' certifiedDeliveries: type: array description: A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. items: $ref: '#/components/schemas/certifiedDelivery' currentRoutingOrder: type: string description: '' editors: type: array description: A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document. items: $ref: '#/components/schemas/editor' errorDetails: $ref: '#/components/schemas/errorDetails' inPersonSigners: type: array description: Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. items: $ref: '#/components/schemas/inPersonSigner' intermediaries: type: array description: Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). items: $ref: '#/components/schemas/intermediary' recipientCount: type: string description: 'The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message.' seals: type: array description: '' items: $ref: '#/components/schemas/sealSign' signers: type: array description: A complex type containing information about the Signer recipient. items: $ref: '#/components/schemas/signer' witnesses: type: array description: '' items: $ref: '#/components/schemas/witness' description: Envelope recipients x-ds-definition-name: recipients x-ds-category: Envelopes x-ds-order: '20' x-ms-summary: Envelope recipients note: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays additional information, in the form of a note, for the recipient. ' x-ds-definition-name: note x-ms-summary: 'A tab that displays additional information, in the form of a note, for the recipient. ' recipientSignatureInformation: type: object properties: fontStyle: type: string description: '' signatureInitials: type: string description: '' signatureName: type: string description: Specifies the user signature name. description: '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.' x-ds-definition-name: recipientSignatureInformation x-ms-summary: '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.' recipientSAMLAuthentication: type: object properties: samlAssertionAttributes: type: array description: '' items: $ref: '#/components/schemas/samlAssertionAttribute' description: "Contains the name/value pair information for the SAML assertion attributes:\n\n* name - The name of the SAML assertion attribute.\n* value - The value associated with the named SAML assertion attribute. \n\nYour account must be set up to use SSO to use this." x-ds-definition-name: recipientSAMLAuthentication x-ms-summary: "Contains the name/value pair information for the SAML assertion attributes:\n\n* name - The name of the SAML assertion attribute.\n* value - The value associated with the named SAML assertion attribute. \n\nYour account must be set up to use SSO to use this." decline: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: ' Specifies the decline text displayed in the tab.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. declineReason: type: string description: The reason the recipient declined the document. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: '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. ' x-ds-definition-name: decline x-ms-summary: '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. ' recipientSignatureProvider: type: object properties: sealDocumentsWithTabsOnly: type: string description: '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: type: string description: 'Indicates the name of the electronic seal to apply on documents. ' signatureProviderName: type: string description: The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) signatureProviderOptions: $ref: '#/components/schemas/recipientSignatureProviderOptions' description: 'An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). ' x-ds-definition-name: recipientSignatureProvider x-ms-summary: 'An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures). ' date: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: '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. ' x-ds-definition-name: date x-ms-summary: '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. ' paymentLineItem: type: object properties: amountReference: type: string description: 'This is a the `tabLabel` that specifies the amount paid for the line items. ' description: type: string description: 'A sender-defined description of the line item. ' itemCode: type: string description: 'This is the sender-defined SKU, inventory number, or other item code for the line item. ' name: type: string description: 'This is a sender-defined product name, service name, or other designation for the line item. ' description: 'A line item describes details about an individual line item in a payment request. ' x-ds-definition-name: paymentLineItem x-ms-summary: 'A line item describes details about an individual line item in a payment request. ' userInfo: type: object properties: activationAccessCode: type: string description: '' email: type: string description: '' errorDetails: $ref: '#/components/schemas/errorDetails' loginStatus: type: string description: '' sendActivationEmail: type: string description: '' uri: type: string description: '' userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' userName: type: string description: '' userStatus: type: string description: 'Status of the user''s account. One of: * ActivationRequired * ActivationSent * Active * Closed * Disabled ' userType: type: string description: '' description: '' x-ds-definition-name: userInfo x-ms-summary: '' recipientEmailNotification: type: object properties: emailBody: type: string description: Not applicable emailSubject: type: string description: Not applicable supportedLanguage: type: string description: "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe 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). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. " description: '' x-ds-definition-name: recipientEmailNotification x-ms-summary: '' witness: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: '' agentCanEditName: type: string description: '' autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. bulkRecipientsUri: type: string description: 'The URL for the bulk recipient file with the bulk recipient information for this envelope, if applicable. This information is read only and is only shown after the bulk recipient file is uploaded to the envelope by using the PUT method. ' canSignOffline: type: string description: When set to **true**, specifies that the signer can perform the signing ceremony offline. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " creationReason: type: string description: The reason why the recipient was created (for example, `sender`). Read only. customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. defaultRecipient: type: string description: When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: '' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote 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. \n" lastName: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: '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. ' offlineAttributes: $ref: '#/components/schemas/offlineAttributes' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: 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.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' recipientSuppliesTabs: type: string description: When set to **true**, specifies that the recipient creates the tabs. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' requireSignerCertificate: type: string description: "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.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate." requireSignOnPaper: type: string description: When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signatureInfo: $ref: '#/components/schemas/recipientSignatureInformation' signedDateTime: type: string description: Reserved for DocuSign. signInEachLocation: type: string description: 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). signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: Item status. tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' witnessFor: type: string description: '' witnessForGuid: type: string description: '' description: '' x-ds-definition-name: witness x-ms-summary: '' ssn9InformationInput: type: object properties: displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" ssn9: type: string description: ' The recipient''s Social Security Number(SSN).' description: '' x-ds-definition-name: ssn9InformationInput x-ms-summary: '' envelopeId: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. ' x-ds-definition-name: envelopeId x-ms-summary: 'A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. ' intermediary: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: '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. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 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). signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: intermediary x-ms-summary: '' recipientAttachment: type: object properties: attachmentId: type: string description: '' attachmentType: type: string description: '' data: type: string description: '' label: type: string description: '' name: type: string description: '' remoteUrl: type: string description: '' description: '' x-ds-definition-name: recipientAttachment x-ms-summary: '' addressInformation: type: object properties: city: type: string description: The city associated with the address. country: type: string description: Specifies the country associated with the address. fax: type: string description: A Fax number associated with the address if one is available. phone: type: string description: A phone number associated with the address. state: type: string description: The state or province associated with the address. street1: type: string description: The first line of the address. street2: type: string description: The second line of the address (optional). zip: type: string description: The zip or postal code associated with the address. zipPlus4: type: string description: '' description: Contains address information. x-ds-definition-name: addressInformation x-ms-summary: Contains address information. initialHere: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: ' 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.' format: float status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -23) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -23) ' description: 'A tab that allows the recipient to initial the document. May be optional. ' x-ds-definition-name: initialHere x-ms-summary: 'A tab that allows the recipient to initial the document. May be optional. ' ssn: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: '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. ' x-ds-definition-name: ssn x-ms-summary: '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. ' fullName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s full name. ' x-ds-definition-name: fullName x-ms-summary: 'A tab that displays the recipient''s full name. ' money: type: object properties: amountInBaseUnit: type: string description: 'The total payment amount in the currency''s base unit. For example, for USD the base currency is one cent. ' currency: type: string description: 'The three-letter [ISO 4217][ISO4217] 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. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 ' displayAmount: type: string description: '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. ' description: 'Describes information about the `total` of a payment. ' x-ds-definition-name: money x-ms-summary: 'Describes information about the `total` of a payment. ' idCheckInformationInput: type: object properties: addressInformationInput: $ref: '#/components/schemas/addressInformationInput' dobInformationInput: $ref: '#/components/schemas/dobInformationInput' ssn4InformationInput: $ref: '#/components/schemas/ssn4InformationInput' ssn9InformationInput: $ref: '#/components/schemas/ssn9InformationInput' description: "A complex element that contains input information related to a recipient ID check. It can include the following information.\n\naddressInformationInput: Used to set recipient address information and consists of:\n\n* 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.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\ndobInformationInput: Used to set recipient date of birth information and consists of:\n\n* dateOfBirth: Specifies the recipient's date, month and year of birth.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:\n\n* ssn4: Specifies the last four digits of the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn9InformationInput: 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: \n* ssn9: Specifies the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay." x-ds-definition-name: idCheckInformationInput x-ms-summary: "A complex element that contains input information related to a recipient ID check. It can include the following information.\n\naddressInformationInput: Used to set recipient address information and consists of:\n\n* 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.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\ndobInformationInput: Used to set recipient date of birth information and consists of:\n\n* dateOfBirth: Specifies the recipient's date, month and year of birth.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:\n\n* ssn4: Specifies the last four digits of the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn9InformationInput: 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: \n* ssn9: Specifies the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay." notarize: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: '' documentId: type: string description: The ID of the document being accessed. errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: The page number being accessed. recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.' x-ds-definition-name: notarize x-ms-summary: 'A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.' addressInformationInput: type: object properties: addressInformation: $ref: '#/components/schemas/addressInformation' displayLevelCode: type: string description: "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay" receiveInResponse: type: string description: When set to **true**, the information needs to be returned in the response. description: Contains address input information. x-ds-definition-name: addressInformationInput x-ms-summary: Contains address input information. firstName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: '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. ' x-ds-definition-name: firstName x-ms-summary: '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. ' signer: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: Optional element. When set to **true**, the agent 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: type: string description: Optional. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. autoNavigation: type: string description: When set to **true**, autonavigation is set for the recipient. bulkRecipientsUri: type: string description: 'The URL for the bulk recipient file with the bulk recipient information for this envelope, if applicable. This information is read only and is only shown after the bulk recipient file is uploaded to the envelope by using the PUT method. ' canSignOffline: type: string description: When set to **true**, specifies that the signer can perform the signing ceremony offline. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " creationReason: type: string description: The reason why the recipient was created (for example, `sender`). Read only. customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. defaultRecipient: type: string description: When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "The recipient's email address. The system sends notification of the documents to sign to this email address. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote 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. \n" lastName: type: string description: The recipient's last name. name: type: string description: 'The full legal name of the recipient. Maximum Length: 100 characters. **Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.' note: type: string description: '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. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: 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.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' recipientSuppliesTabs: type: string description: When set to **true**, specifies that the recipient creates the tabs. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' requireSignerCertificate: type: string description: "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.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate." requireSignOnPaper: type: string description: When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signatureInfo: $ref: '#/components/schemas/recipientSignatureInformation' signedDateTime: type: string description: Reserved for DocuSign. signInEachLocation: type: string description: 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). signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Specifies the status of the recipient at the time of the request. Read only. Possible values are: - `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status). - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope. - `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed. - `declined`: The recipient declined to sign the documents in the envelope. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step. - `autoresponded`: The recipient''s email system auto-responded to the email from DocuSign. This status is used by the DocuSign webapp (also known as the DocuSign console) to inform senders about the auto-responded email.' tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. x-ds-definition-name: signer x-ms-summary: A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. socialAuthentication: type: object properties: authentication: type: string description: 'Reserved: TBD' description: '' x-ds-definition-name: socialAuthentication x-ms-summary: '' notaryHost: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: 'The notary''s email address. Maximum Length: 100 characters. ' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' faxNumber: type: string description: Reserved for DocuSign. hostRecipientId: type: string description: '' idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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. ' name: type: string description: 'The notary''s full legal name. Maximum Length: 100 characters. ' note: type: string description: 'A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later." tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '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. ' x-ds-definition-name: notaryHost x-ms-summary: '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. ' listItem: type: object properties: selected: type: string description: "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default." text: type: string description: 'Specifies the text that is shown in the dropdown list. ' value: type: string description: Specifies the value that is used when the list item is selected. description: 'One of the selectable items in the `listItems` property of a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab.' x-ds-definition-name: listItem x-ms-summary: 'One of the selectable items in the `listItems` property of a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab.' lastName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: '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. ' x-ds-definition-name: lastName x-ms-summary: '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. ' recipientsUpdateSummary: type: object properties: recipientUpdateResults: type: array description: '' items: $ref: '#/components/schemas/recipientUpdateResponse' description: '' x-ds-definition-name: recipientsUpdateSummary x-ms-summary: '' documentVisibility: type: object properties: documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. rights: type: string description: '' visible: type: string description: '' description: '' x-ds-definition-name: documentVisibility x-ms-summary: '' emailAddress: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that displays the recipient''s email as entered in the recipient information. ' x-ds-definition-name: emailAddress x-ms-summary: 'A tab that displays the recipient''s email as entered in the recipient information. ' inPersonSigner: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: When set to **true**, autonavigation is set for the recipient. canSignOffline: type: string description: When set to **true**, specifies that the signer can perform the signing ceremony offline. clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " creationReason: type: string description: The reason why the recipient was created (for example, `sender`). Read only. customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. defaultRecipient: type: string description: 'When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. ' deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: 'The signer''s email address in an eNotary flow. Use only when `inPersonSigningType` is `notary`. For regular in-person-signer flow, use `signerEmail` instead. ' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. hostEmail: type: string description: '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. ' hostName: type: string description: '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. ' idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: '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. ' name: type: string description: '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. ' notaryHost: $ref: '#/components/schemas/notaryHost' note: type: string description: 'A note sent to the in-person signer in the signing email. This note is visible only to this recipient. Maximum Length: 1000 characters. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: 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.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures) items: $ref: '#/components/schemas/recipientSignatureProvider' recipientSuppliesTabs: type: string description: When set to **true**, specifies that the recipient creates the tabs. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' requireSignerCertificate: type: string description: "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.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate." requireSignOnPaper: type: string description: When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign. roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signatureInfo: $ref: '#/components/schemas/recipientSignatureInformation' signedDateTime: type: string description: Reserved for DocuSign. signerEmail: type: string description: 'The in-person signer''s email address. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. ' signerName: type: string description: 'The in-person signer''s full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. ' signInEachLocation: type: string description: 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). signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '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][enveloperecipientsInPerson]. [enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient ' x-ds-definition-name: inPersonSigner x-ms-summary: '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][enveloperecipientsInPerson]. [enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient ' signerAttachment: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: '' format: float status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) ' description: 'A tab that allows the recipient to attach supporting documents to an envelope. ' x-ds-definition-name: signerAttachment x-ms-summary: 'A tab that allows the recipient to attach supporting documents to an envelope. ' number: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' formula: type: string description: '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][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields ' isPaymentAmount: type: string description: '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. ' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter numbers and decimal (.) points. ' x-ds-definition-name: number x-ms-summary: 'A tab that allows the recipient to enter numbers and decimal (.) points. ' recipientSMSAuthentication: type: object properties: senderProvidedNumbers: type: array description: 'An Array containing a list of phone numbers the recipient may use for SMS text authentication. ' items: type: string description: Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. x-ds-definition-name: recipientSMSAuthentication x-ms-summary: Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. mergeField: type: object properties: allowSenderToEdit: type: string description: When set to **true**, the sender can modify the value of the custom tab during the sending process. configurationType: type: string description: If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. path: type: string description: Sets the object associated with the custom tab. Currently this is the Salesforce Object. row: type: string description: Specifies the row number in a Salesforce table that the merge field value corresponds to. writeBack: type: string description: When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. description: Contains information for transfering values between Salesforce data fields and DocuSign Tabs. x-ds-definition-name: mergeField x-ms-summary: Contains information for transfering values between Salesforce data fields and DocuSign Tabs. zip: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. useDash4: type: string description: '' validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. ' x-ds-definition-name: zip x-ms-summary: 'A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. ' agent: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: '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. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: Contains information about agent recipients. x-ds-definition-name: agent x-ms-summary: Contains information about agent recipients. recipientPhoneAuthentication: type: object properties: recipMayProvideNumber: type: string description: Boolean. When set to **true**, the recipient can supply a phone number their choice. recordVoicePrint: type: string description: Reserved. senderProvidedNumbers: type: array description: 'An Array containing a list of phone numbers the recipient may use for SMS text authentication. ' items: type: string validateRecipProvidedNumber: type: string description: ' Reserved.' description: '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.' x-ds-definition-name: recipientPhoneAuthentication x-ms-summary: '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.' checkbox: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: This property does not apply to `checkbox` tabs. Check boxes are always optional. requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. selected: type: string description: When set to **true**, the checkbox is selected. shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) ' description: 'A tab that allows the recipient to select a yes/no (on/off) option. ' x-ds-definition-name: checkbox x-ms-summary: 'A tab that allows the recipient to select a yes/no (on/off) option. ' signHere: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: '' format: float stampType: type: string description: '' stampTypeMetadata: $ref: '#/components/schemas/propertyMetadata' status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -27) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -27) ' description: 'A tab that allows the recipient to sign a document. May be optional. ' x-ds-definition-name: signHere x-ms-summary: 'A tab that allows the recipient to sign a document. May be optional. ' text: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' formula: type: string description: '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][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields ' height: type: integer description: Height of the tab in pixels. format: int32 isPaymentAmount: type: string description: '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. ' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to enter any type of text. ' x-ds-definition-name: text x-ms-summary: 'A tab that allows the recipient to enter any type of text. ' recipientIdentityPhoneNumber: type: object properties: countryCode: type: string description: '' extension: type: string description: '' number: type: string description: '' description: '' x-ds-definition-name: recipientIdentityPhoneNumber x-ms-summary: '' paymentDetails: type: object properties: allowedPaymentMethods: type: array description: '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. ' items: type: string chargeId: type: string description: 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: type: string description: 'Specifies the three-letter [ISO 4217][ISO4217] 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. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 ' customerId: type: string description: '' customMetadata: type: string description: '' customMetadataRequired: type: boolean description: '' gatewayAccountId: type: string description: '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. [paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways ' gatewayDisplayName: type: string description: 'Display name of the gateway connected to sender''s Docusign account. Possible values are: Stripe, Braintree, Authorize.Net.' gatewayName: type: string description: 'Name of the gateway connected to sender''s DocuSign account. Possible values are: * `Stripe` * `Braintree` * `AuthorizeDotNet`' lineItems: type: array description: '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. ' items: $ref: '#/components/schemas/paymentLineItem' paymentOption: type: string description: '' paymentSourceId: type: string description: '' signerValues: $ref: '#/components/schemas/paymentSignerValues' status: type: string description: "This read-only property describes the status of a payment.\n\n* `new`
\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`
\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`
\n The recipient's card has been charged.\n\n* `payment_capture_failed`
\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n" total: $ref: '#/components/schemas/money' description: 'When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' x-ds-definition-name: paymentDetails x-ms-summary: 'When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' recipientIdentityInputOption: type: object properties: name: type: string description: '' phoneNumberList: type: array description: '' items: $ref: '#/components/schemas/recipientIdentityPhoneNumber' valueType: type: string description: '' description: '' x-ds-definition-name: recipientIdentityInputOption x-ms-summary: '' certifiedDelivery: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: '' agentCanEditName: type: string description: '' clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: '' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: The recipient's last name. name: type: string description: '' note: type: string description: '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. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: certifiedDelivery x-ms-summary: '' email: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: '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. ' x-ds-definition-name: email x-ms-summary: '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. ' authenticationStatus: type: object properties: accessCodeResult: $ref: '#/components/schemas/eventResult' ageVerifyResult: $ref: '#/components/schemas/eventResult' anySocialIDResult: $ref: '#/components/schemas/eventResult' facebookResult: $ref: '#/components/schemas/eventResult' googleResult: $ref: '#/components/schemas/eventResult' identityVerificationResult: $ref: '#/components/schemas/eventResult' idLookupResult: $ref: '#/components/schemas/eventResult' idQuestionsResult: $ref: '#/components/schemas/eventResult' linkedinResult: $ref: '#/components/schemas/eventResult' liveIDResult: $ref: '#/components/schemas/eventResult' ofacResult: $ref: '#/components/schemas/eventResult' openIDResult: $ref: '#/components/schemas/eventResult' phoneAuthResult: $ref: '#/components/schemas/eventResult' salesforceResult: $ref: '#/components/schemas/eventResult' signatureProviderResult: $ref: '#/components/schemas/eventResult' smsAuthResult: $ref: '#/components/schemas/eventResult' sTANPinResult: $ref: '#/components/schemas/eventResult' twitterResult: $ref: '#/components/schemas/eventResult' yahooResult: $ref: '#/components/schemas/eventResult' description: Contains information about the authentication status. x-ds-definition-name: authenticationStatus x-ms-summary: Contains information about the authentication status. radio: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' required: type: string description: When set to **true**, the signer is required to fill out this tab selected: type: string description: When set to **true**, the radio button is selected. tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: '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.' value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'One of the selectable radio buttons in the `radios` property of a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab. ' x-ds-definition-name: radio x-ms-summary: 'One of the selectable radio buttons in the `radios` property of a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab. ' sealSign: type: object properties: accessCode: type: string description: Not applicable addAccessCodeToEmail: type: string description: Not applicable clientUserId: type: string description: Not applicable customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: Not applicable declinedReason: type: string description: Not applicable deliveredDateTime: type: string description: Not applicable deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: Not applicable items: $ref: '#/components/schemas/documentVisibility' emailNotification: $ref: '#/components/schemas/recipientEmailNotification' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' faxNumber: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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. ' name: type: string description: '' note: type: string description: Not applicable phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' recipientAttachments: type: array description: Not applicable items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: (Required) The `recipientId` used when the envelope or template was created. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. recipientSignatureProviders: type: array description: (Required) Indicates which electronic seal to apply on documents when creating an envelope. items: $ref: '#/components/schemas/recipientSignatureProvider' requireIdLookup: type: string description: Not applicable roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: "(Optional, default: 1) \nSpecifies the routing order of the electronic seal in the envelope.\nThe routing order assigned to your electronic seal cannot be shared with another recipient.\nIt is recommended that you set a routing order for your electronic seals.\n" samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: Not applicable signedDateTime: type: string description: Not applicable smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: Item status. tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: Not applicable userId: type: string description: Not applicable description: "Specifies one or more electronic seals to apply on documents. \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-13be-42ca-a6fe-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n```\nFor more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals" x-ds-definition-name: sealSign x-ms-summary: "Specifies one or more electronic seals to apply on documents. \n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-13be-42ca-a6fe-4682bc45c106\"\n }\n \t]\n \t}\n \t]\n\t},\n```\nFor more information on Electronic Seals , see https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals" carbonCopy: type: object properties: accessCode: type: string description: "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required." addAccessCodeToEmail: type: string description: 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: type: string description: '' agentCanEditName: type: string description: '' clientUserId: type: string description: "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. " customFields: type: array description: 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. items: type: string declinedDateTime: type: string description: The date and time the recipient declined the document. Read only. declinedReason: type: string description: The reason the recipient declined the document. Read only. deliveredDateTime: type: string description: 'Reserved: For DocuSign use only.' deliveryMethod: type: string description: 'Reserved: For DocuSign use only.' documentVisibility: type: array description: A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true**. items: $ref: '#/components/schemas/documentVisibility' email: type: string description: "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. " emailNotification: $ref: '#/components/schemas/recipientEmailNotification' emailRecipientPostSigningURL: type: string description: '' embeddedRecipientStartURL: type: string description: "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` " errorDetails: $ref: '#/components/schemas/errorDetails' excludedDocuments: type: array description: '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.' items: type: string faxNumber: type: string description: Reserved for DocuSign. firstName: type: string description: "The user's first name. \nMaximum Length: 50 characters." fullName: type: string description: Reserved for DocuSign. idCheckConfigurationName: type: string description: "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node." idCheckInformationInput: $ref: '#/components/schemas/idCheckInformationInput' identityVerification: $ref: '#/components/schemas/recipientIdentityVerification' inheritEmailNotificationConfiguration: type: string description: '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: type: string description: The recipient's last name. name: type: string description: 'legal name of the recipient. Maximum Length: 100 characters.' note: type: string description: '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. ' phoneAuthentication: $ref: '#/components/schemas/recipientPhoneAuthentication' proofFile: $ref: '#/components/schemas/recipientProofFile' recipientAttachments: type: array description: Reserved for DocuSign. items: $ref: '#/components/schemas/recipientAttachment' recipientAuthenticationStatus: $ref: '#/components/schemas/authenticationStatus' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. recipientIdGuid: type: string description: The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. requireIdLookup: type: string description: 'When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ' roleName: type: string description: Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. routingOrder: type: string description: 'Specifies the routing order of the recipient in the envelope. ' samlAuthentication: $ref: '#/components/schemas/recipientSAMLAuthentication' sentDateTime: type: string description: The UTC DateTime when the envelope was sent. Read only. signedDateTime: type: string description: Reserved for DocuSign. signingGroupId: type: string description: 'Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). **Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ' signingGroupName: type: string description: "The display name for the signing group. \n\nMaximum Length: 100 characters. " signingGroupUsers: type: array description: A complex type that contains information about users in the signing group. items: $ref: '#/components/schemas/userInfo' smsAuthentication: $ref: '#/components/schemas/recipientSMSAuthentication' socialAuthentications: type: array description: ' Lists the social ID type that can be used for recipient authentication.' items: $ref: '#/components/schemas/socialAuthentication' status: type: string description: 'Recipient status. ' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. totalTabCount: type: string description: The total number of tabs in the documents. Read only. userId: type: string description: '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 Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.' description: '' x-ds-definition-name: carbonCopy x-ms-summary: '' smartSection: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' caseSensitive: type: boolean description: '' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: '' displaySettings: $ref: '#/components/schemas/smartSectionDisplaySettings' documentId: type: string description: The ID of the document being accessed. endAnchor: type: string description: '' endPosition: $ref: '#/components/schemas/smartSectionAnchorPosition' errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: The page number being accessed. recipientId: type: string description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. removeEndAnchor: type: boolean description: '' removeStartAnchor: type: boolean description: '' startAnchor: type: string description: '' startPosition: $ref: '#/components/schemas/smartSectionAnchorPosition' status: type: string description: Item status. tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: '' x-ds-definition-name: smartSection x-ms-summary: '' smartSectionCollapsibleDisplaySettings: type: object properties: arrowClosed: type: string description: '' arrowColor: type: string description: '' arrowLocation: type: string description: '' arrowOpen: type: string description: '' arrowSize: type: string description: '' arrowStyle: type: string description: '' containerStyle: type: string description: '' labelStyle: type: string description: '' onlyArrowIsClickable: type: boolean description: '' outerLabelAndArrowStyle: type: string description: '' description: '' x-ds-definition-name: smartSectionCollapsibleDisplaySettings x-ms-summary: '' recipientIdentityVerification: type: object properties: inputOptions: type: array description: '' items: $ref: '#/components/schemas/recipientIdentityInputOption' workflowId: type: string description: '' description: '' x-ds-definition-name: recipientIdentityVerification x-ms-summary: '' formulaTab: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. disableAutoSize: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' formula: type: string description: '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][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields ' hidden: type: string description: '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. ' isPaymentAmount: type: string description: '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. ' italic: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' paymentDetails: $ref: '#/components/schemas/paymentDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. roundDecimalPlaces: type: string description: '' senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) ' description: '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][calculatedfields] 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][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' x-ds-definition-name: formulaTab x-ms-summary: '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][calculatedfields] 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][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures ' approve: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: ' Specifies the approval text displayed in the tab. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab''s position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ' description: 'A tab that allows the recipient to approve documents without placing a signature or initials on the document. ' x-ds-definition-name: approve x-ms-summary: 'A tab that allows the recipient to approve documents without placing a signature or initials on the document. ' recipientUpdateResponse: type: object properties: errorDetails: $ref: '#/components/schemas/errorDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. tabs: $ref: '#/components/schemas/EnvelopeRecipientTabs' description: '' x-ds-definition-name: recipientUpdateResponse x-ms-summary: '' view: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: '' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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. ' customTabId: type: string description: 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. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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' height: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab requiredRead: type: string description: '' status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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.' templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'This tab is used with the Approve tab to handle supplemental documents.' x-ds-definition-name: view x-ms-summary: 'This tab is used with the Approve tab to handle supplemental documents.' eventResult: type: object properties: eventTimestamp: type: string description: '' failureDescription: type: string description: '' status: type: string description: Event status. vendorFailureStatusCode: type: string description: '' description: '' x-ds-definition-name: eventResult x-ms-summary: '' paymentSignerValues: type: object properties: paymentOption: type: string description: '' description: '' x-ds-definition-name: paymentSignerValues x-ms-summary: '' smartSectionAnchorPosition: type: object properties: pageNumber: type: integer description: The page number being accessed. format: int32 xPosition: type: number description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: double yPosition: type: number description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: double description: '' x-ds-definition-name: smartSectionAnchorPosition x-ms-summary: '' securitySchemes: accessCode: type: oauth2 description: OAuth2 Access code Grant flows: authorizationCode: authorizationUrl: https://account.docusign.com/oauth/auth tokenUrl: https://account.docusign.com/oauth/auth scopes: organization_read: '' permission_read: '' group_read: '' user_read: '' account_read: '' account_write: '' user_write: '' identity_provider_read: '' domain_read: '' x-ds-categories: - name: UserManagement summary: Methods to manage users in an account. description: Methods to manage users in an account. - name: BulkOperations summary: Methods to import and export users and accounts. description: Methods to import and export users and accounts. - name: IdentityProviders summary: Methods to get a list of identity providers. description: Methods to get a list of identity providers. - name: ReservedDomains summary: Methods to get a list of reserved domains. description: Methods to get a list of reserved domains. - name: Organization summary: Methods for working with organizations. description: Methods for working with organizations. x-original-swagger-version: '2.0'