> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# Update template document

PUT https://demo.docusign.net/restapi/v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}
Content-Type: application/json

Adds the specified document to an existing template document.

Reference: https://developers.docusign.com/docs/esign-rest-api/v2/reference/templates/templatedocuments/update

## Authentication

- `Authorization` header (required) — OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer \<token>.

## Servers

- `https://demo.docusign.net/restapi` (Demo, default)
- `https://www.docusign.net/restapi` (Production)

## Request

### Path parameters

- `accountId` (string, required) — The external account number (int) or account id GUID.
- `documentId` (string, required) — The ID of the document being accessed.
- `templateId` (string, required) — The ID of the template being accessed.

### Query parameters

- `apply_document_fields` (string, optional) — When **true**, document fields can be added or modified while adding or modifying envelope documents.
- `is_envelope_definition` (string, optional)

### Body (application/json)

This endpoint expects an envelopeDefinition.

- `accessibility` (string, optional) — Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.
- `allowMarkup` (string, optional) — When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
- `allowReassign` (string, optional) — When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
- `allowRecipientRecursion` (string, optional) — When set to **true**, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
- `allowViewHistory` (string, optional)
- `asynchronous` (string, optional) — When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. **Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.
- `attachments` (list of attachment, optional)
- `attachmentsUri` (string, optional)
- `authoritativeCopy` (string, optional) — Specifies whether all documents in this envelope are authoritative copies. A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document.
- `authoritativeCopyDefault` (string, optional) — The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`.
- `autoNavigation` (string, optional) — When set to **true**, autonavigation is set for the recipient.
- `brandId` (string, optional) — This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.
- `brandLock` (string, optional)
- `certificateUri` (string, optional) — Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.
- `completedDateTime` (string, optional) — Specifies the date and time this item was completed.
- `compositeTemplates` (list of compositeTemplate, optional) — A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.
- `copyRecipientData` (string, optional)
- `createdDateTime` (string, optional) — Indicates the date and time the item was created.
- `customFields` (AccountCustomFields, optional) — Custom Fields
- `customFieldsUri` (string, optional) — Contains a URI for an endpoint to retrieve the custom fields.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `deletedDateTime` (string, optional) — Specifies the data and time the item was deleted.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `disableResponsiveDocument` (string, optional)
- `documents` (list of document, optional) — Complex element contains the details on the documents in the envelope.
- `documentsCombinedUri` (string, optional)
- `documentsUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the documents.
- `emailBlurb` (string, optional) — Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters
- `emailSettings` (emailSettings, optional)
- `emailSubject` (string, optional) — Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
- `enableWetSign` (string, optional) — When set to **true**, the signer is allowed to print the document and sign it on paper.
- `enforceSignerVisibility` (string, optional) — When 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. ###### Note: Your account must have Document Visibility enabled to use this.
- `envelopeId` (string, optional) — The envelope ID of the envelope status that failed to post.
- `envelopeIdStamping` (string, optional) — When set to **true**, Envelope ID Stamping is enabled.
- `envelopeUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
- `eventNotification` (eventNotification, optional) — Register a Connect webhook for a specific envelope
- `initialSentDateTime` (string, optional)
- `is21CFRPart11` (string, optional) — When set to **true**, indicates that this module is enabled on the account.
- `isSignatureProviderEnvelope` (string, optional)
- `lastModifiedDateTime` (string, optional) — The date and time the item was last modified.
- `lockInformation` (EnvelopeLocks, optional) — Envelope locks
- `messageLock` (string, optional) — When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
- `notification` (notification, optional) — A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to **true**, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. * expireAfter - An integer that sets the number of days the envelope is active. * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.
- `notificationUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the notifications.
- `password` (string, optional)
- `purgeState` (string, optional) — Initiates a purge request. Valid values are: * documents_queued - Places envelope documents in the purge queue. * documents_and_metadata_queued - Places envelope documents and metadata in the purge queue.
- `recipients` (EnvelopeRecipients, optional) — Envelope recipients
- `recipientsLock` (string, optional) — When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
- `recipientsUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the recipients.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signerCanSignOnMobile` (string, optional)
- `signingLocation` (string, optional) — Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
- `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
- `statusChangedDateTime` (string, optional) — The data and time the status changed.
- `templateId` (string, optional) — The unique identifier of the template. If this is not provided, DocuSign will generate a value.
- `templateRoles` (list of templateRole, optional) — Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up by the following elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role-specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template.
- `templatesUri` (string, optional) — Contains a URI for an endpoint which you can use to retrieve the templates.
- `transactionId` (string, optional) — Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
- `useDisclosure` (string, optional) — When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
- `voidedDateTime` (string, optional) — The date and time the envelope or template was voided.
- `voidedReason` (string, optional) — The reason the envelope or template was voided.

## Response

### 200

Successful response.

- `attachmentTabId` (string, optional)
- `authoritativeCopy` (string, optional) — Specifies whether all documents in this envelope are authoritative copies. A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document.
- `availableDocumentTypes` (list of signatureType, optional)
- `containsPdfFormFields` (string, optional)
- `display` (string, optional) — This string sets the display and behavior properties of the document during signing. The possible values are: * `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `download` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. * `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.
- `documentFields` (list of nameValue, optional)
- `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `includeInDownload` (string, optional) — When set to **true**, the document is included in the combined document download. The default value is **true**.
- `name` (string, optional)
- `order` (string, optional) — An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
- `pages` (string, optional)
- `signerMustAcknowledge` (string, optional) — Sets how the signer interacts with the supplemental document. The possible values are: * `no_interaction` No recipient action is required. * `view` The recipient is required to view the document. * `accept` The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. * `view_accept` The recipient is required to view and accept the document.
- `sizeBytes` (string, optional)
- `type` (string, optional) — Type of the user. Valid values: type_owner, type_participant.
- `uri` (string, optional)

## Errors

### 400 Bad Request Error

Error encountered.

- `errorCode` (string, optional) — An error code associated with the error.
- `message` (string, optional) — A short error message.

## Types

### attachment

Contains information about an attachment.

- `accessControl` (string, optional)
- `attachmentId` (string, optional)
- `attachmentType` (string, optional) — Specifies the type of the attachment for the recipient.
- `data` (string, optional)
- `label` (string, optional)
- `name` (string, optional)
- `remoteUrl` (string, optional)

### compositeTemplate

- `compositeTemplateId` (string, optional) — The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.
- `document` (document, optional) — A document object.
- `inlineTemplates` (list of inlineTemplate, optional) — Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.
- `pdfMetaDataTemplateSequence` (string, optional)
- `serverTemplates` (list of serverTemplate, optional) — 0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value

### AccountCustomFields

Custom Fields

- `listCustomFields` (list of listCustomField, optional) — An array of list custom fields.
- `textCustomFields` (list of textCustomField, optional) — An array of text custom fields.

### document

A document object.

- `applyAnchorTabs` (string, optional) — Reserved for DocuSign
- `authoritativeCopy` (boolean, optional) — If **true**, this document is considered an authoritative copy. If this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property. If **false**, this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property.
- `display` (string, optional) — This string sets the display and behavior properties of the document during signing. The possible values are: * `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `download` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. * `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.
- `documentBase64` (string, optional) — The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
- `documentFields` (list of nameValue, optional)
- `documentId` (string, optional) — Specifies the document ID of this document. This value is used by tabs to determine which document they appear in.
- `encryptedWithKeyManager` (string, optional) — When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.
- `fileExtension` (string, optional) — The file extension type of the document. Non-PDF documents are converted to PDF. If the document is not a PDF, `fileExtension` is required. If you try to upload a non-PDF document without a `fileExtension`, you will receive an "unable to load document" error message.
- `fileFormatHint` (string, optional)
- `htmlDefinition` (documentHtmlDefinition, optional)
- `includeInDownload` (string, optional) — When set to **true**, the document is included in the combined document download. The default value is **true**.
- `matchBoxes` (list of matchBox, optional) — Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.
- `name` (string, optional)
- `order` (string, optional) — An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
- `pages` (string, optional)
- `password` (string, optional)
- `remoteUrl` (string, optional) — The file id from the cloud storage service where the document is located. This information is returned using \[ML:GET /folders] or \[ML:/folders/\{folderid}].
- `signerMustAcknowledge` (string, optional) — Sets how the signer interacts with the supplemental document. The possible values are: * `no_interaction` No recipient action is required. * `view` The recipient is required to view the document. * `accept` The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. * `view_accept` The recipient is required to view and accept the document.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `transformPdfFields` (string, optional) — When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.
- `uri` (string, optional)

### emailSettings

- `bccEmailAddresses` (list of bccEmailAddress, optional) — An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters. **Note**: While this property is an array, it takes only a single email address.
- `replyEmailAddressOverride` (string, optional)
- `replyEmailNameOverride` (string, optional)

### eventNotification

Register a Connect webhook for a specific envelope

- `envelopeEvents` (list of envelopeEvent, optional) — A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
- `includeCertificateOfCompletion` (string, optional) — When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes.
- `includeCertificateWithSoap` (string, optional) — When set to **true**, the Connect service will digitally sign the XML data. The signature will be included in the XML message.
- `includeDocumentFields` (string, optional) — When set to **true**, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.
- `includeDocuments` (string, optional) — When set to **true**, the XML webhook messages will include the envelope's PDF documents. Including the PDF documents will greatly increase the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger.
- `includeEnvelopeVoidReason` (string, optional) — When set to **true**, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.
- `includeHMAC` (string, optional)
- `includeSenderAccountAsCustomField` (string, optional) — When set to **true**, Connect will include the sender account as Custom Field in the data.
- `includeTimeZone` (string, optional) — When set to **true**, the envelope's time zone information is included in the webhook messages.
- `loggingEnabled` (string, optional) — When set to **true**, the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://developers.docusign.com/esign-rest-api/reference/Connect/ConnectEvents).
- `recipientEvents` (list of recipientEvent, optional) — An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the `url` property. To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
- `requireAcknowledgment` (string, optional) — When set to **true**, the DocuSign Connect service checks that the message was received and retries on failures.
- `signMessageWithX509Cert` (string, optional) — When set to **true**, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol.
- `soapNameSpace` (string, optional) — The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.
- `url` (string, optional) — The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used.
- `useSoapInterface` (string, optional) — When set to **true**, the notifications are sent to your endpoint as SOAP requests.

### EnvelopeLocks

Envelope locks

- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `lockDurationInSeconds` (string, optional) — Sets the time, in seconds, until the lock expires when there is no activity on the envelope. If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds. The lock duration can be extended.
- `lockedByApp` (string, optional) — Specifies the friendly name of the application that is locking the envelope.
- `lockedByUser` (userInfo, optional)
- `lockedUntilDateTime` (string, optional) — The datetime until the envelope lock expires.
- `lockToken` (string, optional) — A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.
- `lockType` (string, optional) — The type of envelope lock. Currently "edit" is the only supported type.
- `useScratchPad` (string, optional) — Reserved for future use. Indicates whether a scratchpad is used for editing information.

### notification

A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to **true**, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. * expireAfter - An integer that sets the number of days the envelope is active. * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

- `expirations` (expirations, optional) — A complex element that specifies the expiration settings for the envelope.
- `reminders` (reminders, optional) — A complex element that specifies reminder settings for the envelope
- `useAccountDefaults` (string, optional) — When set to **true**, the account default notification settings are used for the envelope.

### EnvelopeRecipients

Envelope recipients

- `agents` (list of agent, optional) — A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.
- `carbonCopies` (list of carbonCopy, optional) — A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.
- `certifiedDeliveries` (list of certifiedDelivery, optional) — 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.
- `currentRoutingOrder` (string, optional)
- `editors` (list of editor, optional) — A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `inPersonSigners` (list of inPersonSigner, optional) — 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.
- `intermediaries` (list of intermediary, optional) — 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).
- `recipientCount` (string, optional) — 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` (list of sealSign, optional)
- `signers` (list of signer, optional) — A complex type containing information about the Signer recipient.
- `witnesses` (list of witness, optional)

### templateRole

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `defaultRecipient` (string, optional) — When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
- `email` (string, optional) — Specifies the email associated with a role name.
- `emailNotification` (recipientEmailNotification, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `inPersonSignerName` (string, optional) — Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters.
- `name` (string, optional) — Specifies the recipient's name.
- `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — 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)
- `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `signingGroupId` (string, optional) — 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.
- `tabs` (EnvelopeRecipientTabs, optional) — All of the tabs associated with a recipient. Each property is a list of a type of tab.

### signatureType

- `isDefault` (string, optional)
- `type` (string, optional) — Type of the user. Valid values: type_owner, type_participant.

### nameValue

- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `name` (string, optional) — The name or key of a name/value pair.
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `value` (string, optional) — The value field of a name/value pair.

### errorDetails

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

- `errorCode` (string, optional) — An error code associated with the error.
- `message` (string, optional) — A short error message.

### inlineTemplate

- `customFields` (AccountCustomFields, optional) — Custom Fields
- `documents` (list of document, optional) — Complex element contains the details on the documents in the envelope.
- `envelope` (envelope, optional)
- `recipients` (EnvelopeRecipients, optional) — Envelope recipients
- `sequence` (string, optional) — Specifies the order in which templates are overlaid.

### serverTemplate

- `sequence` (string, optional)
- `templateId` (string, optional) — The unique identifier of the template. If this is not provided, DocuSign will generate a value.

### listCustomField

- `configurationType` (string, optional) — If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `fieldId` (string, optional) — An ID used to specify a custom field.
- `listItems` (list of string, optional)
- `name` (string, optional) — The name of the custom field.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `show` (string, optional) — A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion.
- `value` (string, optional) — The value of the custom field. Maximum Length: 100 characters.

### textCustomField

- `configurationType` (string, optional) — If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `fieldId` (string, optional) — An ID used to specify a custom field.
- `name` (string, optional) — The name of the custom field.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `show` (string, optional) — A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion.
- `value` (string, optional) — The value of the custom field.

### documentHtmlDefinition

- `displayAnchorPrefix` (string, optional)
- `displayAnchors` (list of documentHtmlDisplayAnchor, optional)
- `displayOrder` (string, optional)
- `displayPageNumber` (string, optional)
- `documentGuid` (string, optional)
- `documentId` (string, optional) — The ID of the document being accessed.
- `headerLabel` (string, optional)
- `maxScreenWidth` (string, optional)
- `removeEmptyTags` (string, optional)
- `showMobileOptimizedToggle` (string, optional)
- `source` (string, optional)

### matchBox

- `height` (integer, optional) — Height of the tab in pixels.
- `pageNumber` (integer, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (integer, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
- `yPosition` (integer, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

### bccEmailAddress

Contains information about the BCC email address.

- `bccEmailAddressId` (string, optional) — Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. Example: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.
- `email` (string, optional) — Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope. Maximum of length: 100 characters.

### envelopeEvent

For which envelope events should your webhook be called?

- `envelopeEventStatusCode` (string, optional) — An envelope status for which your webhook should be called. Values: Draft, Sent, Delivered, Completed, Declined, or Voided.
- `includeDocuments` (string, optional) — reserved

### recipientEvent

- `includeDocuments` (string, optional) — reserved
- `recipientEventStatusCode` (string, optional) — Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.

### userInfo

- `activationAccessCode` (string, optional)
- `email` (string, optional)
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `loginStatus` (string, optional)
- `sendActivationEmail` (string, optional)
- `uri` (string, optional)
- `userId` (string, optional) — 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` (string, optional)
- `userStatus` (string, optional) — Status of the user's account. One of: * ActivationRequired * ActivationSent * Active * Closed * Disabled
- `userType` (string, optional)

### expirations

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

- `expireAfter` (string, optional) — An integer that sets the number of days the envelope is active.
- `expireEnabled` (string, optional) — When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.
- `expireWarn` (string, optional) — An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

### reminders

A complex element that specifies reminder settings for the envelope

- `reminderDelay` (string, optional) — An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.
- `reminderEnabled` (string, optional) — When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.
- `reminderFrequency` (string, optional) — An interger that sets the interval, in days, between reminder emails.

### agent

Contains information about agent recipients.

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional)
- `note` (string, optional) — 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` (recipientPhoneAuthentication, optional) — A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (string, optional) — 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` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signingGroupId` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Recipient status.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### carbonCopy

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `agentCanEditEmail` (string, optional)
- `agentCanEditName` (string, optional)
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional) — legal name of the recipient. Maximum Length: 100 characters.
- `note` (string, optional) — 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` (recipientPhoneAuthentication, optional) — 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.
- `proofFile` (recipientProofFile, optional)
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (string, optional) — 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` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signingGroupId` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Recipient status.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### certifiedDelivery

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `agentCanEditEmail` (string, optional)
- `agentCanEditName` (string, optional)
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional)
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional)
- `note` (string, optional) — 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` (recipientPhoneAuthentication, optional) — 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.
- `proofFile` (recipientProofFile, optional)
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (string, optional) — 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` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signingGroupId` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Recipient status.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### editor

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional) — legal name of the recipient. Maximum Length: 100 characters.
- `note` (string, optional) — 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` (recipientPhoneAuthentication, optional) — A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (string, optional) — 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` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signingGroupId` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Recipient status.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### inPersonSigner

An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about fields used for eNotary feature, see the [EnvelopeRecipients resource][enveloperecipientsInPerson]. [enveloperecipientsInPerson]: /https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients/#in-person-signers-recipient

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `autoNavigation` (string, optional) — When set to **true**, autonavigation is set for the recipient.
- `canSignOffline` (string, optional) — When set to **true**, specifies that the signer can perform the signing ceremony offline.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). Read only.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `defaultRecipient` (string, optional) — When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — 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` (recipientEmailNotification, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `hostEmail` (string, optional) — 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` (string, optional) — 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` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `inPersonSigningType` (string, optional) — 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` (string, optional) — 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` (notaryHost, optional) — 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.
- `note` (string, optional) — 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` (recipientPhoneAuthentication, optional) — A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (list of recipientSignatureProvider, optional) — 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)
- `recipientSuppliesTabs` (string, optional) — When set to **true**, specifies that the recipient creates the tabs.
- `requireIdLookup` (string, optional) — 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` (string, optional) — By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate.
- `requireSignOnPaper` (string, optional) — When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.
- `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signerEmail` (string, optional) — The in-person signer's email address. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters.
- `signerName` (string, optional) — The in-person signer's full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters.
- `signInEachLocation` (string, optional) — 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` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Recipient status.
- `tabs` (EnvelopeRecipientTabs, optional) — All of the tabs associated with a recipient. Each property is a list of a type of tab.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### intermediary

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional)
- `note` (string, optional) — 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` (recipientPhoneAuthentication, optional) — A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (string, optional) — 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` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signingGroupId` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Recipient status.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### sealSign

Specifies one or more electronic seals to apply on documents. ```json "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProviders": [ { "sealName": "52e9d968-13be-42ca-a6fe-4682bc45c106" } ] } ] }, ``` For more information on Electronic Seals , see [https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals)

- `accessCode` (string, optional) — Not applicable
- `addAccessCodeToEmail` (string, optional) — Not applicable
- `clientUserId` (string, optional) — Not applicable
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — Not applicable
- `declinedReason` (string, optional) — Not applicable
- `deliveredDateTime` (string, optional) — Not applicable
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — Not applicable
- `emailNotification` (recipientEmailNotification, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — 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` (string, optional)
- `note` (string, optional) — Not applicable
- `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.
- `recipientAttachments` (list of recipientAttachment, optional) — Not applicable
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — (Required) The `recipientId` used when the envelope or template was created.
- `recipientIdGuid` (string, optional) — 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` (list of recipientSignatureProvider, optional) — (Required) Indicates which electronic seal to apply on documents when creating an envelope.
- `requireIdLookup` (string, optional) — Not applicable
- `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — (Optional, default: 1) Specifies the routing order of the electronic seal in the envelope. The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — Not applicable
- `signedDateTime` (string, optional) — Not applicable
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Item status.
- `tabs` (EnvelopeRecipientTabs, optional) — All of the tabs associated with a recipient. Each property is a list of a type of tab.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — Not applicable
- `userId` (string, optional) — Not applicable

### signer

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.

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `agentCanEditEmail` (string, optional) — 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` (string, optional) — 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` (string, optional) — When set to **true**, autonavigation is set for the recipient.
- `bulkRecipientsUri` (string, optional) — 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` (string, optional) — When set to **true**, specifies that the signer can perform the signing ceremony offline.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). Read only.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `defaultRecipient` (string, optional) — When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — The recipient's email address. The system sends notification of the documents to sign to this email address. Maximum length: 100 characters.
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `isBulkRecipient` (string, optional) — When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional) — 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` (string, optional) — 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` (recipientPhoneAuthentication, optional) — 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.
- `proofFile` (recipientProofFile, optional)
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — 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` (string, optional) — 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` (list of recipientSignatureProvider, optional) — 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)
- `recipientSuppliesTabs` (string, optional) — When set to **true**, specifies that the recipient creates the tabs.
- `requireIdLookup` (string, optional) — 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` (string, optional) — By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate.
- `requireSignOnPaper` (string, optional) — When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.
- `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signInEachLocation` (string, optional) — 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` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — 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` (EnvelopeRecipientTabs, optional) — All of the tabs associated with a recipient. Each property is a list of a type of tab.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### witness

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `agentCanEditEmail` (string, optional)
- `agentCanEditName` (string, optional)
- `autoNavigation` (string, optional) — When set to **true**, autonavigation is set for the recipient.
- `bulkRecipientsUri` (string, optional) — 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` (string, optional) — When set to **true**, specifies that the signer can perform the signing ceremony offline.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). Read only.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `defaultRecipient` (string, optional) — When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional)
- `emailNotification` (recipientEmailNotification, optional)
- `emailRecipientPostSigningURL` (string, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters.
- `fullName` (string, optional) — Reserved for DocuSign.
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
- `isBulkRecipient` (string, optional) — When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@recipient.com and "Bulk Recipient". These fields can not be changed for the bulk recipient.
- `lastName` (string, optional) — The recipient's last name.
- `name` (string, optional)
- `note` (string, optional) — 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` (offlineAttributes, optional) — Placeholder definition for offlineAttributes (missing from upstream spec).
- `phoneAuthentication` (recipientPhoneAuthentication, optional) — 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.
- `proofFile` (recipientProofFile, optional)
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — 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` (string, optional) — 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` (list of recipientSignatureProvider, optional) — 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)
- `recipientSuppliesTabs` (string, optional) — When set to **true**, specifies that the recipient creates the tabs.
- `requireIdLookup` (string, optional) — 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` (string, optional) — By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate.
- `requireSignOnPaper` (string, optional) — When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.
- `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `signInEachLocation` (string, optional) — 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` (string, optional) — 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` (string, optional) — The display name for the signing group. Maximum Length: 100 characters.
- `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Item status.
- `tabs` (EnvelopeRecipientTabs, optional) — All of the tabs associated with a recipient. Each property is a list of a type of tab.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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` (string, optional)
- `witnessForGuid` (string, optional)

### recipientEmailNotification

- `emailBody` (string, optional) — Not applicable
- `emailSubject` (string, optional) — Not applicable
- `supportedLanguage` (string, optional) — Specifies the language used to localize Electronic Seals UI texts such as "Sealed by", etc. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). This parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing.

### recipientSignatureProvider

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

- `sealDocumentsWithTabsOnly` (string, optional) — By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document. To apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed.
- `sealName` (string, optional) — Indicates the name of the electronic seal to apply on documents.
- `signatureProviderName` (string, optional) — 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` (recipientSignatureProviderOptions, optional) — 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)

### EnvelopeRecipientTabs

All of the tabs associated with a recipient. Each property is a list of a type of tab.

- `approveTabs` (list of approve, optional) — A list of [Approve tabs][approve]. This tab allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. [approve]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve
- `checkboxTabs` (list of checkbox, optional) — 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
- `companyTabs` (list of company, optional) — A list of [Company tabs][company]. This tab displays the recipient's company name. [company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company
- `dateSignedTabs` (list of dateSigned, optional) — A list of [Date Signed tabs][dateSigned] This tab displays the date that the recipient signed the document. [dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned
- `dateTabs` (list of date, optional) — A list of [Date tabs][date]. This tab 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. [date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date
- `declineTabs` (list of decline, optional) — A list of [Decline tabs][decline]. This tab allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. [decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline
- `emailAddressTabs` (list of emailAddress, optional) — A list of [Email Address tabs][emailAddress]. This tab displays the recipient's email as entered in the recipient information. [emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress
- `emailTabs` (list of email, optional) — A list of [Email tabs][email]. This tab 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. [email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email
- `envelopeIdTabs` (list of envelopeId, optional) — A list of [Envelope ID tabs][envelopeId]. This tab displays the envelope ID. Recipients cannot enter or change the information in this tab. [envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId
- `firstNameTabs` (list of firstName, optional) — A list of [First Name tabs][firstName]. This tab displays the recipient's first name. It 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. [firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName
- `formulaTabs` (list of formulaTab, optional) — A list of [Formula tabs][formulaTab]. The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][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 [formulaTab]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab
- `fullNameTabs` (list of fullName, optional) — A list of [Full Name tabs][fullName]. This tab displays the recipient's full name. [fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName
- `initialHereTabs` (list of initialHere, optional) — A list of [Initial Here tabs][initialHere]. This tab allows the recipient to initial the document. May be optional. [initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere
- `lastNameTabs` (list of lastName, optional) — A list of [Last Name tabs][lastName]. This tab displays the recipient's last name. It 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. [lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName
- `listTabs` (list of list, optional) — A list of [list tabs][list]. This tab offers a list of options to choose from. The `listItems` property is used to specify the selectable options. [list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list
- `notarizeTabs` (list of notarize, optional) — A list of [Notarize tabs][notarize]. A notarize tab is a tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. [notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize
- `noteTabs` (list of note, optional) — A list of [Note tabs][note]. This tab displays additional information, in the form of a note, for the recipient. [note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note
- `numberTabs` (list of number, optional) — A list of [Number tabs][number]. This tab allows the recipient to enter numbers and decimal (.) points. [number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number
- `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs][radioGroup]. This tab This group tab is used to place radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. [radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup
- `signerAttachmentTabs` (list of signerAttachment, optional) — A list of [Signer Attachment tabs][signerAttachment]. This tab allows the recipient to attach supporting documents to an envelope. [signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment
- `signHereTabs` (list of signHere, optional) — A list of [Sign Here tabs][signHere]. This tab allows the recipient to sign a document. May be optional. [signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere
- `smartSectionTabs` (list of smartSection, optional)
- `ssnTabs` (list of ssn, optional) — A list of [SSN tabs][ssn]. This tab is 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. [ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn
- `textTabs` (list of text, optional) — A list of [Text tabs][text]. This tab A tab that allows the recipient to enter any type of text. [text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text
- `titleTabs` (list of title, optional) — A list of [Title tabs][title]. This tab displays the recipient's title. [title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title
- `viewTabs` (list of view, optional) — A list of [View tabs][view]. This tab This tab is used with the Approve tab to handle supplemental documents. [view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view
- `zipTabs` (list of zip, optional) — A list of [Zip tabs][zip]. This tab 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. [zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip

### envelope

- `allowMarkup` (string, optional) — When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
- `allowReassign` (string, optional) — When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
- `allowViewHistory` (string, optional)
- `asynchronous` (string, optional) — When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. **Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.
- `attachmentsUri` (string, optional)
- `authoritativeCopy` (string, optional) — Specifies whether all documents in this envelope are authoritative copies. A document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document.
- `authoritativeCopyDefault` (string, optional) — The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`.
- `autoNavigation` (string, optional) — When set to **true**, autonavigation is set for the recipient.
- `brandId` (string, optional) — The unique identifier of a brand.
- `brandLock` (string, optional)
- `certificateUri` (string, optional) — Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.
- `completedDateTime` (string, optional) — Specifies the date and time this item was completed.
- `copyRecipientData` (string, optional)
- `createdDateTime` (string, optional) — Indicates the date and time the item was created.
- `customFields` (AccountCustomFields, optional) — Custom Fields
- `customFieldsUri` (string, optional) — Contains a URI for an endpoint to retrieve the custom fields.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `deletedDateTime` (string, optional) — Specifies the data and time the item was deleted.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `disableResponsiveDocument` (string, optional)
- `documentsCombinedUri` (string, optional)
- `documentsUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the documents.
- `emailBlurb` (string, optional)
- `emailSettings` (emailSettings, optional)
- `emailSubject` (string, optional) — Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
- `enableWetSign` (string, optional) — When set to **true**, the signer is allowed to print the document and sign it on paper.
- `enforceSignerVisibility` (string, optional) — When 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. ###### Note: Your account must have Document Visibility enabled to use this.
- `envelopeId` (string, optional) — The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
- `envelopeIdStamping` (string, optional) — When set to **true**, Envelope ID Stamping is enabled.
- `envelopeUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
- `initialSentDateTime` (string, optional)
- `is21CFRPart11` (string, optional) — When set to **true**, indicates that this module is enabled on the account.
- `isSignatureProviderEnvelope` (string, optional)
- `lastModifiedDateTime` (string, optional) — The date and time the item was last modified.
- `lockInformation` (EnvelopeLocks, optional) — Envelope locks
- `messageLock` (string, optional) — When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
- `notification` (notification, optional) — A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to **true**, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. * expireAfter - An integer that sets the number of days the envelope is active. * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.
- `notificationUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the notifications.
- `purgeState` (string, optional) — Shows the current purge state for the envelope. The possible values are: * `unpurged`: There has been no successful request to purge documents. * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. * `documents_dequeued`: The envelope documents have been taken out of the purge queue. * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. * `documents_purged`: The envelope documents have been successfully purged. * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.
- `recipients` (EnvelopeRecipients, optional) — Envelope recipients
- `recipientsLock` (string, optional) — When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
- `recipientsUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the recipients.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signerCanSignOnMobile` (string, optional)
- `signingLocation` (string, optional) — Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
- `status` (string, optional) — Item status.
- `statusChangedDateTime` (string, optional) — The data and time the status changed.
- `templatesUri` (string, optional) — Contains a URI for an endpoint which you can use to retrieve the templates.
- `transactionId` (string, optional) — Specifies the Transaction ID from the AppStore.
- `useDisclosure` (string, optional) — When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
- `voidedDateTime` (string, optional) — The date and time the envelope or template was voided.
- `voidedReason` (string, optional) — The reason the envelope or template was voided.

### documentHtmlDisplayAnchor

- `caseSensitive` (boolean, optional)
- `displaySettings` (documentHtmlDisplaySettings, optional)
- `endAnchor` (string, optional)
- `removeEndAnchor` (boolean, optional)
- `removeStartAnchor` (boolean, optional)
- `startAnchor` (string, optional)

### documentVisibility

- `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `rights` (string, optional)
- `visible` (string, optional)

### idCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

- `addressInformationInput` (addressInformationInput, optional) — Contains address input information.
- `dobInformationInput` (dobInformationInput, optional) — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse
- `ssn4InformationInput` (ssn4InformationInput, optional)
- `ssn9InformationInput` (ssn9InformationInput, optional)

### recipientIdentityVerification

- `inputOptions` (list of recipientIdentityInputOption, optional)
- `workflowId` (string, optional)

### recipientPhoneAuthentication

A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.

- `recipMayProvideNumber` (string, optional) — Boolean. When set to **true**, the recipient can supply a phone number their choice.
- `recordVoicePrint` (string, optional) — Reserved.
- `senderProvidedNumbers` (list of string, optional) — An Array containing a list of phone numbers the recipient may use for SMS text authentication.
- `validateRecipProvidedNumber` (string, optional) — Reserved.

### recipientAttachment

- `attachmentId` (string, optional)
- `attachmentType` (string, optional)
- `data` (string, optional)
- `label` (string, optional)
- `name` (string, optional)
- `remoteUrl` (string, optional)

### authenticationStatus

Contains information about the authentication status.

- `accessCodeResult` (eventResult, optional)
- `ageVerifyResult` (eventResult, optional)
- `anySocialIDResult` (eventResult, optional)
- `facebookResult` (eventResult, optional)
- `googleResult` (eventResult, optional)
- `identityVerificationResult` (eventResult, optional)
- `idLookupResult` (eventResult, optional)
- `idQuestionsResult` (eventResult, optional)
- `linkedinResult` (eventResult, optional)
- `liveIDResult` (eventResult, optional)
- `ofacResult` (eventResult, optional)
- `openIDResult` (eventResult, optional)
- `phoneAuthResult` (eventResult, optional)
- `salesforceResult` (eventResult, optional)
- `signatureProviderResult` (eventResult, optional)
- `smsAuthResult` (eventResult, optional)
- `sTANPinResult` (eventResult, optional)
- `twitterResult` (eventResult, optional)
- `yahooResult` (eventResult, optional)

### recipientSAMLAuthentication

Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.

- `samlAssertionAttributes` (list of samlAssertionAttribute, optional)

### recipientSMSAuthentication

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

- `senderProvidedNumbers` (list of string, optional) — An Array containing a list of phone numbers the recipient may use for SMS text authentication.

### socialAuthentication

- `authentication` (string, optional) — Reserved: TBD

### recipientProofFile

- `isInProofFile` (string, optional)

### notaryHost

This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host.

- `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
- `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
- `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: if the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. Maximum length: 100 characters.
- `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
- `declinedDateTime` (string, optional) — The date and time the recipient declined the document. Read only.
- `declinedReason` (string, optional) — The reason the recipient declined the document. Read only.
- `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only.
- `deliveryMethod` (string, optional) — Reserved: For DocuSign use only.
- `documentVisibility` (list of documentVisibility, optional) — 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**.
- `email` (string, optional) — The notary's email address. Maximum Length: 100 characters.
- `emailNotification` (recipientEmailNotification, optional)
- `embeddedRecipientStartURL` (string, optional) — Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `faxNumber` (string, optional) — Reserved for DocuSign.
- `hostRecipientId` (string, optional)
- `idCheckConfigurationName` (string, optional) — The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example**: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.
- `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
- `identityVerification` (recipientIdentityVerification, optional)
- `inheritEmailNotificationConfiguration` (string, optional) — 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` (string, optional) — The notary's full legal name. Maximum Length: 100 characters.
- `note` (string, optional) — A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters.
- `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to **true**, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.
- `recipientAttachments` (list of recipientAttachment, optional) — Reserved for DocuSign.
- `recipientAuthenticationStatus` (authenticationStatus, optional) — Contains information about the authentication status.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `recipientIdGuid` (string, optional) — 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` (string, optional) — 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` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients.
- `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope.
- `samlAuthentication` (recipientSAMLAuthentication, optional) — Contains the name/value pair information for the SAML assertion attributes: * name - The name of the SAML assertion attribute. * value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this.
- `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. Read only.
- `signedDateTime` (string, optional) — Reserved for DocuSign.
- `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
- `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication.
- `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
- `tabs` (EnvelopeRecipientTabs, optional) — All of the tabs associated with a recipient. Each property is a list of a type of tab.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `totalTabCount` (string, optional) — The total number of tabs in the documents. Read only.
- `userId` (string, optional) — 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.

### recipientSignatureInformation

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.

- `fontStyle` (string, optional)
- `signatureInitials` (string, optional)
- `signatureName` (string, optional) — Specifies the user signature name.

### offlineAttributes

Placeholder definition for offlineAttributes (missing from upstream spec).

### recipientSignatureProviderOptions

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)

- `cpfNumber` (string, optional) — Reserved for DocuSign
- `oneTimePassword` (string, optional) — 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` (string, optional) — The role or capacity of the signing recipient. Examples: Manager, Approver, etc.
- `sms` (string, optional) — 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.

### approve

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `buttonText` (string, optional) — Specifies the approval text displayed in the tab.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (integer, optional) — Height of the tab in pixels.
- `italic` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### checkbox

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `required` (string, optional) — This property does not apply to `checkbox` tabs. Check boxes are always optional.
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `selected` (string, optional) — When set to **true**, the checkbox is selected.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### company

A tab that displays the recipient's company name.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### dateSigned

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### date

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### decline

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `buttonText` (string, optional) — Specifies the decline text displayed in the tab.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — The reason the recipient declined the document.
- `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (integer, optional) — Height of the tab in pixels.
- `italic` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### emailAddress

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### email

A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### envelopeId

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
- `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

### firstName

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### formulaTab

The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `paymentDetails` (paymentDetails, optional) — 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
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `roundDecimalPlaces` (string, optional)
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### fullName

A tab that displays the recipient's full name.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### initialHere

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `optional` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `scaleValue` (float, optional) — 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.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### lastName

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### list

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.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `listItems` (list of listItem, optional) — The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — The value to use when the item is selected.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### notarize

A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional)
- `documentId` (string, optional) — The ID of the document being accessed.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `pageNumber` (string, optional) — The page number being accessed.
- `recipientId` (string, optional) — 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` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
- `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

### note

A tab that displays additional information, in the form of a note, for the recipient.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (integer, optional) — Height of the tab in pixels.
- `italic` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### number

A tab that allows the recipient to enter numbers and decimal (.) points.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### radioGroup

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.

- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `groupName` (string, optional) — The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.
- `radios` (list of radio, optional) — Specifies the locations and status for radio buttons that are grouped together.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)

### signerAttachment

A tab that allows the recipient to attach supporting documents to an envelope.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `optional` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `scaleValue` (float, optional)
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### signHere

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

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `optional` (string, optional)
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `scaleValue` (float, optional)
- `stampType` (string, optional)
- `stampTypeMetadata` (propertyMetadata, optional)
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### smartSection

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `caseSensitive` (boolean, optional)
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional)
- `displaySettings` (smartSectionDisplaySettings, optional)
- `documentId` (string, optional) — The ID of the document being accessed.
- `endAnchor` (string, optional)
- `endPosition` (smartSectionAnchorPosition, optional)
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `pageNumber` (string, optional) — The page number being accessed.
- `recipientId` (string, optional) — 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` (boolean, optional)
- `removeStartAnchor` (boolean, optional)
- `startAnchor` (string, optional)
- `startPosition` (smartSectionAnchorPosition, optional)
- `status` (string, optional) — Item status.
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
- `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

### ssn

A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### text

A tab that allows the recipient to enter any type of text.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — 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` (integer, optional) — Height of the tab in pixels.
- `isPaymentAmount` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional) — Specifies the tool tip text for the tab.
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### title

A tab that displays the recipient's title.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### view

This tab is used with the Approve tab to handle supplemental documents.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `buttonText` (string, optional)
- `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (integer, optional) — Height of the tab in pixels.
- `italic` (string, optional) — When set to **true**, the information in the tab is italic.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requiredRead` (string, optional)
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
- `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

### zip

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.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `bold` (string, optional) — When set to **true**, the information in the tab is bold.
- `concealValueOnDocument` (string, optional) — 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` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
- `conditionalParentValue` (string, optional) — 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` (string, optional) — 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` (string, optional) — 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` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
- `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
- `fontSize` (string, optional) — 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` (string, optional) — When set to **true**, the information in the tab is italic.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string.
- `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs.
- `name` (string, optional)
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
- `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
- `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
- `shared` (string, optional) — When set to **true**, this custom tab is shared.
- `status` (string, optional) — Tab status
- `tabGroupLabels` (list of string, optional)
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters.
- `tabOrder` (string, optional) — 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` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
- `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
- `tooltip` (string, optional)
- `underline` (string, optional) — When set to **true**, the information in the tab is underlined.
- `useDash4` (string, optional)
- `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded).
- `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab.
- `value` (string, optional) — Specifies the value of the tab.
- `width` (integer, optional) — Width of the tab in pixels.
- `xPosition` (string, optional) — 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` (string, optional) — 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)

### documentHtmlDisplaySettings

- `cellStyle` (string, optional)
- `collapsibleSettings` (documentHtmlCollapsibleDisplaySettings, optional)
- `display` (string, optional) — This string sets the display and behavior properties of the document during signing. The possible values are: * `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `download` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. * `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.
- `displayLabel` (string, optional)
- `displayOrder` (integer, optional)
- `displayPageNumber` (integer, optional)
- `hideLabelWhenOpened` (boolean, optional)
- `inlineOuterStyle` (string, optional)
- `labelWhenOpened` (string, optional)
- `preLabel` (string, optional)
- `scrollToTopWhenOpened` (boolean, optional)
- `tableStyle` (string, optional)

### addressInformationInput

Contains address input information.

- `addressInformation` (addressInformation, optional) — Contains address information.
- `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay
- `receiveInResponse` (string, optional) — When set to **true**, the information needs to be returned in the response.

### dobInformationInput

Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse

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

### ssn4InformationInput

- `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay
- `receiveInResponse` (string, optional) — When set to **true**, the information needs to be returned in the response.
- `ssn4` (string, optional) — The last four digits of the recipient's Social Security Number (SSN).

### ssn9InformationInput

- `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay
- `ssn9` (string, optional) — The recipient's Social Security Number(SSN).

### recipientIdentityInputOption

- `name` (string, optional)
- `phoneNumberList` (list of recipientIdentityPhoneNumber, optional)
- `valueType` (string, optional)

### eventResult

- `eventTimestamp` (string, optional)
- `failureDescription` (string, optional)
- `status` (string, optional) — Event status.
- `vendorFailureStatusCode` (string, optional)

### samlAssertionAttribute

- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `name` (string, optional)
- `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient.
- `value` (string, optional) — The value associated with the named SAML assertion attribute

### mergeField

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

- `allowSenderToEdit` (string, optional) — When set to **true**, the sender can modify the value of the custom tab during the sending process.
- `configurationType` (string, optional) — If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
- `path` (string, optional) — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
- `row` (string, optional) — Specifies the row number in a Salesforce table that the merge field value corresponds to.
- `writeBack` (string, optional) — When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.

### paymentDetails

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

- `allowedPaymentMethods` (list of string, optional) — An array of accepted payment methods: * `CreditCard` * `ApplePay` * `AndroidPay` * `BankAccount` For example, if you only accept credit cards and ACH transfers, you would set this property to: `'["BankAccount", "CreditCard"]'` Do not specify `BankAccount` (ACH) if you are also using in-person signing.
- `chargeId` (string, optional) — The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.
- `currencyCode` (string, optional) — 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` (string, optional)
- `customMetadata` (string, optional)
- `customMetadataRequired` (boolean, optional)
- `gatewayAccountId` (string, optional) — 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` (string, optional) — Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net.
- `gatewayName` (string, optional) — Name of the gateway connected to sender's DocuSign account. Possible values are: * `Stripe` * `Braintree` * `AuthorizeDotNet`
- `lineItems` (list of paymentLineItem, optional) — A payment formula can have one or more line items that provide detail about individual items in a payment request. The list of line items are returned as metadata to the payment gateway.
- `paymentOption` (string, optional)
- `paymentSourceId` (string, optional)
- `signerValues` (paymentSignerValues, optional)
- `status` (string, optional) — This read-only property describes the status of a payment. * `new` This is a new payment request. The envelope has been created, but no payment authorizations have been made. * `auth_complete` A recipient has entered their credit card information, but the envelope has not been completed. The card has not been charged. * `payment_complete` The recipient's card has been charged. * `payment_capture_failed` Final charge failed. This can happen when too much time passes between authorizing the payment and completing the document.
- `total` (money, optional) — Describes information about the `total` of a payment.

### listItem

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.

- `selected` (string, optional) — When set to **true**, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.
- `text` (string, optional) — Specifies the text that is shown in the dropdown list.
- `value` (string, optional) — Specifies the value that is used when the list item is selected.

### radio

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.

- `anchorCaseSensitive` (string, optional) — Reserved for DocuSign.
- `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign.
- `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document.
- `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign.
- `anchorString` (string, optional) — Specifies the anchor string.
- `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms`
- `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests.
- `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab.
- `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
- `required` (string, optional) — When set to **true**, the signer is required to fill out this tab
- `selected` (string, optional) — When set to **true**, the radio button is selected.
- `tabId` (string, optional) — The unique identifier for the tab.
- `tabOrder` (string, optional) — 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` (string, optional) — Specifies the value of the tab.
- `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.
- `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

### propertyMetadata

- `options` (list of string, optional)
- `rights` (string, optional)

### smartSectionDisplaySettings

- `cellStyle` (string, optional)
- `collapsibleSettings` (smartSectionCollapsibleDisplaySettings, optional)
- `display` (string, optional) — This string sets the display and behavior properties of the document during signing. The possible values are: * `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `download` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. * `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.
- `displayLabel` (string, optional)
- `displayOrder` (integer, optional)
- `displayPageNumber` (integer, optional)
- `hideLabelWhenOpened` (boolean, optional)
- `inlineOuterStyle` (string, optional)
- `labelWhenOpened` (string, optional)
- `preLabel` (string, optional)
- `scrollToTopWhenOpened` (boolean, optional)
- `tableStyle` (string, optional)

### smartSectionAnchorPosition

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

### documentHtmlCollapsibleDisplaySettings

- `arrowClosed` (string, optional)
- `arrowColor` (string, optional)
- `arrowLocation` (string, optional)
- `arrowOpen` (string, optional)
- `arrowSize` (string, optional)
- `arrowStyle` (string, optional)
- `containerStyle` (string, optional)
- `labelStyle` (string, optional)
- `onlyArrowIsClickable` (boolean, optional)
- `outerLabelAndArrowStyle` (string, optional)

### addressInformation

Contains address information.

- `city` (string, optional) — The city associated with the address.
- `country` (string, optional) — Specifies the country associated with the address.
- `fax` (string, optional) — A Fax number associated with the address if one is available.
- `phone` (string, optional) — A phone number associated with the address.
- `state` (string, optional) — The state or province associated with the address.
- `street1` (string, optional) — The first line of the address.
- `street2` (string, optional) — The second line of the address (optional).
- `zip` (string, optional) — The zip or postal code associated with the address.
- `zipPlus4` (string, optional)

### recipientIdentityPhoneNumber

- `countryCode` (string, optional)
- `extension` (string, optional)
- `number` (string, optional)

### paymentLineItem

A line item describes details about an individual line item in a payment request.

- `amountReference` (string, optional) — This is a the `tabLabel` that specifies the amount paid for the line items.
- `description` (string, optional) — A sender-defined description of the line item.
- `itemCode` (string, optional) — This is the sender-defined SKU, inventory number, or other item code for the line item.
- `name` (string, optional) — This is a sender-defined product name, service name, or other designation for the line item.

### paymentSignerValues

- `paymentOption` (string, optional)

### money

Describes information about the `total` of a payment.

- `amountInBaseUnit` (string, optional) — The total payment amount in the currency's base unit. For example, for USD the base currency is one cent.
- `currency` (string, optional) — 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` (string, optional) — 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.

### smartSectionCollapsibleDisplaySettings

- `arrowClosed` (string, optional)
- `arrowColor` (string, optional)
- `arrowLocation` (string, optional)
- `arrowOpen` (string, optional)
- `arrowSize` (string, optional)
- `arrowStyle` (string, optional)
- `containerStyle` (string, optional)
- `labelStyle` (string, optional)
- `onlyArrowIsClickable` (boolean, optional)
- `outerLabelAndArrowStyle` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "attachmentTabId": "string",
  "authoritativeCopy": "string",
  "availableDocumentTypes": [
    {
      "isDefault": "string",
      "type": "string"
    }
  ],
  "containsPdfFormFields": "string",
  "display": "string",
  "documentFields": [
    {
      "errorDetails": {
        "errorCode": "string",
        "message": "string"
      },
      "name": "string",
      "originalValue": "string",
      "value": "string"
    }
  ],
  "documentId": "string",
  "errorDetails": {
    "errorCode": "string",
    "message": "string"
  },
  "includeInDownload": "string",
  "name": "string",
  "order": "string",
  "pages": "string",
  "signerMustAcknowledge": "string",
  "sizeBytes": "string",
  "type": "string",
  "uri": "string"
}
```