> 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 # Add documents to envelope PUT https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents Content-Type: application/json Adds one or more documents to an existing envelope. The tabs of the original document will be applied to the new document. **Important**: The `updateList` endpoint supports batch updates to envelope documents. A successful HTTP status does not guarantee that all documents were processed correctly. You must check the response for each `envelopeDocument`. If a document failed to update or add, its corresponding object will include an `errorDetails` indicating the reason for failure. **Note:** When adding or modifying documents for an in-process envelope, Docusign recommends [locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) prior to making any changes. If the file name of a document contains Unicode characters, you need to include a `Content-Disposition` header. Example: **Header:** `Content-Disposition` **Value:** `file; filename=\"name\";fileExtension=ext;documentId=1` **Note:** This method works on documents only. To add recipient or document tabs, use methods from the [EnvelopeRecipientTabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) resource. If HTML document files contain `` elements with the `src` attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this: ` Base64 encoded image

` ### Related topics * [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/) Reference: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/updatelist ## Authentication - `Authorization` header (required) (prefixed with ` Bearer `) — OAuth 2.0 access token (JWT or auth-code grant). Sent as `Authorization: Bearer ` on every request except `GET /v2.1` and `GET /service_information`, which are public discovery endpoints. ## 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. - `envelopeId` (string, required) — The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` ### Body (application/json) This endpoint expects an envelopeDefinition. - `accessControlListBase64` (string, optional) — Reserved for Docusign. - `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. - `allowComments` (string, optional) — When **true,** comments are allowed on the envelope. - `allowMarkup` (string, optional) — When **true,** the Document Markup feature is enabled. **Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level. - `allowReassign` (string, optional) — When **true,** the recipient can redirect an envelope to a more appropriate recipient. - `allowRecipientRecursion` (string, optional) — When **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. - `allowViewHistory` (string, optional) — When **true,** users can view the history of the envelope. - `anySigner` (string, optional) — Deprecated. This feature has been replaced by signing groups. - `asynchronous` (string, optional) — When **true,** the envelope is queued for processing and the value of the `status` property is set to `Processing`. Additionally, GET status calls return `Processing` until completed. **Note:** A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the [transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the Connect notification. - `attachments` (list of attachment, optional) — An array of attachment objects containing details about any envelope attachments. - `attachmentsUri` (string, optional) — The URI for retrieving the envelope attachments. - `authoritativeCopy` (string, optional) — When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** - `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 **true,** autonavigation is set for the recipient. - `brandId` (string, optional) — The ID of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account. **Note:** When creating an envelope using a branded template, include this value to ensure that the brand is applied. - `brandLock` (string, optional) — When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. - `burnDefaultTabData` (string, optional) - `certificateUri` (string, optional) — The URI for retrieving certificate information. - `completedDateTime` (string, optional) — The date and time that the envelope 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) — This value is only applicable when copying an existing envelope. Provide the ID of the envelope to clone in `envelopeId`. When **true,** the recipient field values of the existing envelope are included. Only values from data entry fields, like checkboxes and radio buttons, will be copied. Fields that require an action, like signatures and initials, will not be included. - `createdDateTime` (string, optional) — The date and time that the envelope was created. - `customFields` (customFields, optional) — Contains information about custom fields. - `customFieldsUri` (string, optional) — The URI for retrieving custom fields. - `declinedDateTime` (string, optional) — The date and time that the recipient declined the envelope. - `deletedDateTime` (string, optional) — The date and time that the envelope was deleted. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `disableResponsiveDocument` (string, optional) — When **true,** the responsive document feature is turned off for the envelope. - `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. - `documents` (list of document, optional) — A complex element that contains details about the documents associated with the envelope. - `documentsCombinedUri` (string, optional) — The URI for retrieving all of the documents associated with the envelope as a single PDF file. - `documentsUri` (string, optional) — The URI for retrieving all of the documents associated with the envelope as separate files. - `emailBlurb` (string, optional) — This optional element holds the body of the email message that is sent to all envelope recipients. Maximum Length: 10000 characters. - `emailSettings` (emailSettings, optional) — A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. 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 Length: 100 characters. *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. - `emailSubject` (string, optional) — The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. - `enableWetSign` (string, optional) — When **true,** the signer is allowed to print the document and sign it on paper. - `enforceSignerVisibility` (string, optional) — When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings](https://admindemo.docusign.com/authenticate?goTo=sending) will be enforced for the envelope. See [Fields and Properties](https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html) for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting. **Note:** To use this functionality, [document visibility](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/) must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/en/contactSupport#) or your account manager to find out whether document visibility is available for your production account plan. - `envelopeAttachments` (list of attachment, optional) — An array of attachment objects that provide information about the attachments that are associated with the envelope. - `envelopeClassification` (string, optional) - `envelopeCustomMetadata` (envelopeCustomMetadata, optional) - `envelopeDocuments` (list of envelopeDocument, optional) — An array containing information about the documents that are included in the envelope. - `envelopeId` (string, optional) — The envelope ID. When used as a request body in [Envelopes: create](/docs/esign-rest-api/reference/envelopes/envelopes/create/), this is the ID of the envelope to clone. - `envelopeIdStamping` (string, optional) — When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed. - `envelopeLocation` (string, optional) — Reserved for Docusign. - `envelopeMetadata` (envelopeMetadata, optional) - `envelopeUri` (string, optional) — The URI for retrieving the envelope or envelopes. - `eventNotification` (eventNotification, optional) — Use this object to configure a [Docusign Connect webhook](/platform/webhooks/connect/). - `eventNotifications` (list of eventNotification, optional) - `expireAfter` (string, optional) — Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. - `expireDateTime` (string, optional) — Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. - `expireEnabled` (string, optional) — Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. - `externalEnvelopeId` (string, optional) — May contain an external identifier for the envelope. - `folders` (list of folder, optional) — An array of folders that the envelope belongs to. - `hasComments` (string, optional) — When **true,** indicates that users have added comments to the envelope. - `hasFormDataChanged` (string, optional) — When **true,** indicates that the form data associated with the envelope has changed since it was sent. When **false,** this property does not appear in the response. - `hasWavFile` (string, optional) — When **true,** indicates that a wave file (voice recording) is part of the envelope. - `holder` (string, optional) — Reserved for Docusign. - `initialSentDateTime` (string, optional) — The date and time that the envelope was first sent. - `is21CFRPart11` (string, optional) — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `isDynamicEnvelope` (string, optional) — When **true,** indicates that the envelope is a dynamic envelope. - `isSignatureProviderEnvelope` (string, optional) — When **true,** indicates that the envelope is a signature-provided envelope. - `isTicketRelatedEnvelope` (string, optional) - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `location` (string, optional) — Reserved for Docusign. - `lockInformation` (lockInformation, optional) - `messageLock` (string, optional) — When **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 settings for the envelope. - `notificationUri` (string, optional) — The URI for retrieving notifications. - `password` (string, optional) — The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. - `powerForm` (powerForm, optional) — Contains details about a PowerForm. - `purgeCompletedDate` (string, optional) — The date that a purge was completed. - `purgeRequestDate` (string, optional) — The date that a purge was requested. - `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. - `documents_and_metadata_and_redact_queued`: Places envelope documents and metadata in the purge queue and redacts personal information. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) - `recipients` (recipients, optional) — Specifies the envelope recipients. - `recipientsLock` (string, optional) — When **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. - `recipientViewRequest` (recipientViewRequest, optional) — The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and [EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods. - `sender` (userInfo, optional) - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signerCanSignOnMobile` (string, optional) — When **true,** recipients can sign on a mobile device. **Note:** Only Admin users can change this setting. - `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 when creating an envelope are: - `created`: The envelope is created as a draft. It can be modified and sent later. - `sent`: The envelope will be sent to the recipients after the envelope is created. You can query these additional statuses once the recipients have interacted with the envelope. - `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. - `declined`: The envelope has been declined by the recipients. - `delivered`: The envelope has been delivered to the recipients. - `signed`: The envelope has been signed by the recipients. - `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. - `statusChangedDateTime` (string, optional) — The data and time that the status changed. - `templateId` (string, optional) — The ID of the template. If a value is not provided, Docusign generates a value. - `templateRoles` (list of templateRole, optional) — This object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements: - `email`: The recipient's email address. - `name`: The recipient's name. - `roleName`: The template roleName associated with the recipient. - `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true,** an error is generated on sending. - `defaultRecipient`: Optional, When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient. - `routingOrder`: This specifies the routing order of the recipient in the envelope. - `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters. - `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters. - `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients. - `tabs`: This property enables the tab values to be specified for matching to tabs in the template. - `templatesUri` (string, optional) — The URI for retrieving any templates associated with the envelope. - `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. Docusign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned. - `useDisclosure` (string, optional) — When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **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. - `uSigState` (string, optional) - `voidedDateTime` (string, optional) — The date and time the envelope or template was voided. - `voidedReason` (string, optional) — The reason the envelope or template was voided. **Note:** The string is truncated to the first 200 characters. - `watermarkLanguage` (string, optional) — Gets or sets the watermark language used only for voided or copied envelopes. This feature does not affect the watermark for envelopes that are not complete. The list of supported languages is the same as the languages Docusign supports for signing. - `workflow` (workflow, optional) — Describes the workflow for an envelope. ## Response ### 200 Successful response. - `envelopeDocuments` (list of envelopeDocument, optional) — An array containing information about the documents that are included in the envelope. - `envelopeId` (string, optional) — The envelope ID. ## Errors ### 400 Bad Request Error Error encountered. - `errorCode` (string, optional) — The code associated with the error condition. - `message` (string, optional) — A brief message describing the error condition. ## Types ### attachment Contains information about an attachment. - `accessControl` (string, optional) — Valid values are `sender` and `senderAndAllRecipients`. - `attachmentId` (string, optional) — The unique identifier for the attachment. - `attachmentType` (string, optional) — Specifies the type of the attachment for the recipient. - `data` (string, optional) — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` (string, optional) — A label for the attachment. Potential values include: - `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. - `name` (string, optional) — The name of the attachment. - `remoteUrl` (string, optional) — The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. ### compositeTemplate This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/ - `compositeTemplateId` (string, optional) — The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. - `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) — A number representing the sequence in which to apply the template that contains the PDF metadata. Example: `4` - `serverTemplates` (list of serverTemplate, optional) — Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. ### customFields Contains information about 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. - `assignTabsToRecipientId` (string, optional) - `authoritativeCopy` (boolean, optional) — When **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. When **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. Valid values: - `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. - `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. - `docGenDocumentStatus` (string, optional) - `docGenFormFields` (list of docGenFormField, optional) - `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) — The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: - `name`: A string that can be a maximum of 50 characters. - `value`: A string that can be a maximum of 200 characters. If you are using XML, the name/value pair is contained in a `nameValue` element. - `documentId` (string, optional) — Specifies the document ID of this document. This value is used by tabs to determine which document they appear in. - `documentTemplateId` (string, optional) - `encryptedWithKeyManager` (string, optional) — When **true,** the document has been 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) — Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). - `includeInDownload` (string, optional) — When **true,** the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/). The default value is **true.** - `isDocGenDocument` (string, optional) - `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. - `name` (string, optional) — The name of the document. - `order` (string, optional) — A string value consisting of an integer index of the document's position within the list of documents attached to the envelope. - `pages` (string, optional) — The number of pages in the document. This property is read-only. - `password` (string, optional) — The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. - `pdfFormFieldOption` (string, optional) - `remoteUrl` (string, optional) — The file ID from the cloud storage service where the document is located. This information is returned using [CloudStorage: listFolders](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders/) or [CloudStorage: list](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/list/). - `signerMustAcknowledge` (string, optional) — Sets how the signer interacts with the supplemental document. Valid values: - `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. **Note:** The `view` value is used for both View and Accept and Read and Accept. Visit the [Supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/) page for more information. - `signerMustAcknowledgeUseAccountDefault` (boolean, optional) — When **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa). - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `transformPdfFields` (string, optional) — When **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. - `uri` (string, optional) — A URI containing the user ID. ### emailSettings A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. 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 Length: 100 characters. *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. - `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. While this property is an array, note that it takes only a single email address. **Note:** Only users with the `canManageAccount` setting set to **true** can use this option. Docusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. **Example:** if your account has BCC for Email Archive set up for the email address [archive@mycompany.com](mailto:archive@mycompany.com) and you send an envelope using the BCC Email Override to send a BCC email to [salesarchive@mycompany.com](mailto:salesarchive@mycompany.com), then a copy of the envelope is only sent to the [salesarchive@mycompany.com](mailto:salesarchive@mycompany.com) email address. - `replyEmailAddressOverride` (string, optional) — The Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters. - `replyEmailNameOverride` (string, optional) — The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters. ### envelopeCustomMetadata - `envelopeCustomMetadataDetails` (list of nameValue, optional) ### envelopeDocument This object contains details about the envelope document. - `addedRecipientIds` (list of string, optional) — If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only. - `agreementType` (string, optional) - `agreementTypeSource` (string, optional) - `attachmentTabId` (string, optional) — If this document is an attachment to another document in the envelope, this is the ID of the attachment tab it is associated with on the other document. - `authoritativeCopy` (string, optional) — When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** - `authoritativeCopyMetadata` (propertyMetadata, optional) — Metadata about a property. - `availableDocumentTypes` (list of signatureType, optional) - `containsPdfFormFields` (string, optional) — When **true,** the document has editable form fields that are made available through a PDF format. - `display` (string, optional) — This string sets the display and behavior properties of the document during signing. Valid values: - `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. - `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. - `displayMetadata` (propertyMetadata, optional) — Metadata about a property. - `docGenDocumentStatus` (string, optional) - `docGenErrors` (list of docGenSyntaxError, optional) - `docGenFormFields` (list of docGenFormField, optional) - `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) — An object containing information about the custom fields on the document. - `documentId` (string, optional) — The ID of the document that the tab is placed on. This value must refer to the ID of an existing document. - `documentIdGuid` (string, optional) — The GUID of the document. - `documentTemplateId` (string, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `hasDigitalSignature` (string, optional) - `includeInDownload` (string, optional) — When **true,** the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/). The default value is **true.** - `includeInDownloadMetadata` (propertyMetadata, optional) — Metadata about a property. - `isAceGenDocument` (string, optional) - `isDocGenDocument` (string, optional) - `isEdited` (string, optional) - `isExternallyAvailable` (string, optional) - `isFlattened` (string, optional) - `name` (string, optional) — The document's file name. Example: `Q1-Report.docx` - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `order` (string, optional) — The order in which to sort the results. Valid values are: - `asc`: Ascending order. - `desc`: Descending order. - `pages` (list of page, optional) — An array of page objects that contain information about the pages in the document. - `signerMustAcknowledge` (string, optional) — Sets how the signer interacts with the supplemental document. Valid values: - `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. - `signerMustAcknowledgeMetadata` (propertyMetadata, optional) — Metadata about a property. - `sizeBytes` (string, optional) - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `type` (string, optional) — The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` - `uri` (string, optional) — The URI for retrieving the document. ### envelopeMetadata - `allowAdvancedCorrect` (string, optional) — Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature. - `allowCorrect` (string, optional) — Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information. - `enableSignWithNotary` (string, optional) — Specifies if Docusign eNotary service is enabled for the envelope. ### eventNotification Use this object to configure a [Docusign Connect webhook](/platform/webhooks/connect/). - `deliveryMode` (string, optional) - `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. - `eventData` (connectEventData, optional) — This object lets you choose the data format of your Connect response. - `events` (list of string, optional) — A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property. Set this property when you are using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property. The [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) are: - `envelope-created` - `envelope-sent` - `envelope-resent` - `envelope-delivered` - `envelope-completed` - `envelope-declined` - `envelope-voided` - `recipient-authenticationfailed` - `recipient-autoresponded` - `recipient-declined` - `recipient-delivered` - `recipient-completed` - `recipient-sent` - `recipient-resent` - `template-created` - `template-modified` - `template-deleted` - `envelope-corrected` - `envelope-purge` - `envelope-deleted` - `envelope-discard` - `recipient-reassign` - `recipient-delegate` - `recipient-finish-later` - `click-agreed` - `click-declined` - `includeCertificateOfCompletion` (string, optional) — When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. - `includeCertificateWithSoap` (string, optional) — When **true,** the Connect service will digitally sign the data. The signature will be included in the message. - `includeDocumentFields` (string, optional) — When **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 **true,** the Connect webhook messages will include the envelope's PDF documents. Including the PDF documents greatly increases the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. - `includeEnvelopeVoidReason` (string, optional) — When **true,** this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. - `includeHMAC` (string, optional) — When **true,** HMAC headers will be included with the webhook notifications. **Note:** [HMAC must enabled](/platform/webhooks/connect/hmac/) at the account level with [one or more HMAC secrets](/platform/webhooks/connect/setting-up-hmac/). - `includeOAuth` (string, optional) - `includeSenderAccountAsCustomField` (string, optional) — When **true,** Connect will include the sender account as Custom Field in the data. - `includeTimeZone` (string, optional) — When **true,** the envelope's time zone information is included in the webhook messages. - `integratorManaged` (string, optional) — When **true**, enables partners and integrators use their HMAC keys for their clients’ event messages. If enabled, Connect will use the partner’s or integrator’s HMAC key's while sending event notifications. You can use this parameter for account-level and envelope-level configurations. While enabled, this setting this will cause the **x-docusign-accountid** value to match the partner or integrator’s account ID. When **false**, or when not set, the **x-docusign-accountid** returns the Account ID of the user who created the envelope. - `loggingEnabled` (string, optional) — When **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](/docs/esign-rest-api/reference/connect/connectevents/). - `recipientEvents` (list of recipientEvent, optional) — A list of recipient 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. - `requireAcknowledgment` (string, optional) — When **true,** the Docusign Connect service checks that the message was received and retries on failures. - `signMessageWithX509Cert` (string, optional) — When **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 Connect should send webhook notification messages 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 acceptable, but you can use free certificates from Let's Encrypt. The maximum length of this property is 4096 bytes. - `useSoapInterface` (string, optional) — When **true,** this tells the Connect service that the user's endpoint has implemented a SOAP interface. ### folder This object contains details about a folder. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `filter` (filter, optional) — Use this object to create a filtered view of the items in a folder. - `folderId` (string, optional) — The ID of the folder. - `folderItems` (list of folderItem_v2, optional) — A list of envelopes and templates that the folder contains. - `folders` (list of folder, optional) — A collection of folder objects returned in a response. - `hasAccess` (string, optional) — When **true,** the current user has access to the folder. - `hasSubFolders` (string, optional) — When **true,** the folder has subfolders. - `itemCount` (string, optional) — The number of items in the folder. - `name` (string, optional) — The name of the folder. - `owner` (userInfo, optional) - `parentFolderId` (string, optional) — The ID of the parent folder, or the special value `root` for the root folder. - `parentFolderUri` (string, optional) — The URI of the parent folder. - `subFolderCount` (string, optional) — The number of subfolders. - `type` (string, optional) — The type of folder. Possible values include: - `draft` - `inbox` - `normal` (a system-generated folder) - `recyclebin` - `sentitems` - `custom` (a custom folder created by a user) - `uri` (string, optional) — The URI for the folder. ### lockInformation - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `lockDurationInSeconds` (string, optional) — The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds. - `lockedByApp` (string, optional) — The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur. - `lockedByUser` (userInfo, optional) - `lockedUntilDateTime` (string, optional) — The date and time that the lock expires. - `lockToken` (string, optional) — A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. - `lockType` (string, optional) — The type of lock. Currently `edit` is the only supported type. - `useScratchPad` (string, optional) — When **true,** a scratchpad is used to edit information. ### notification A complex element that specifies the notification settings for the envelope. - `expirations` (expirations, optional) — A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided. - `reminders` (reminders, optional) — A complex element that specifies reminder settings for the envelope - `useAccountDefaults` (string, optional) — When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.** ### powerForm Contains details about a PowerForm. - `createdBy` (string, optional) — The ID of the user who created the PowerForm. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `emailBody` (string, optional) — The body of the email message sent to the recipients. Maximum length: 10000 characters. - `emailSubject` (string, optional) — The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. - `envelopes` (list of envelope, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `instructions` (string, optional) — The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters. - `isActive` (string, optional) — When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value. When **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. If a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender. - `lastUsed` (string, optional) — The UTC DateTime when the PowerForm was last used. - `limitUseInterval` (string, optional) — The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property. - `limitUseIntervalEnabled` (string, optional) — When **true,** the `limitUseInterval` is enabled. - `limitUseIntervalUnits` (string, optional) — The units associated with the `limitUseInterval`. Valid values are: - `minutes` - `hours - `days` - `weeks` - `months` For example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`. - `maxUseEnabled` (string, optional) — When **true,** you can set a maximum number of uses for the PowerForm. - `name` (string, optional) — The name of the PowerForm. - `powerFormId` (string, optional) — The ID of the PowerForm. - `powerFormUrl` (string, optional) — The URL for the PowerForm. - `recipients` (list of powerFormRecipient, optional) — An array of recipient objects that provides details about the recipients of the envelope. - `senderName` (string, optional) — The sender's name. - `senderUserId` (string, optional) — The ID of the sender. - `signingMode` (string, optional) — The signing mode to use. Valid values are: - `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. - `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. - `templateId` (string, optional) — The ID of the template used to create the PowerForm. - `templateName` (string, optional) — The name of the template used to create the PowerForm. - `timesUsed` (string, optional) — The number of times the PowerForm has been used. - `uri` (string, optional) — The URI for the PowerForm. - `usesRemaining` (string, optional) — The number of times the PowerForm can still be used. ### recipients Specifies the envelope recipients. - `agents` (list of agent, optional) — A list of agent recipients assigned to the documents. - `authorizedSignatories` (list of authorizedSignatory, optional) - `carbonCopies` (list of carbonCopy, optional) — A list of carbon copy recipients assigned to the documents. - `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) — The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions. - `editors` (list of editor, optional) — A list of users who can edit the envelope. - `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). - `notaries` (list of notaryRecipient, optional) — A list of notary recipients on the envelope. - `notaryWitnesses` (list of notaryWitness, optional) - `participants` (list of participant, optional) - `recipientCount` (string, optional) — The number of recipients in the envelope. - `seals` (list of sealSign, optional) — A list of electronic seals to apply to documents. - `signers` (list of signer, optional) — A list of signers on the envelope. - `witnesses` (list of witness, optional) — A list of signers who act as witnesses on the envelope. ### recipientViewRequest The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and [EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods. - `assertionId` (string, optional) — A unique identifier of the authentication event executed by the client application. - `authenticationInstant` (string, optional) — A sender-generated value that indicates the date and time that the signer was authenticated. - `authenticationMethod` (string, optional) — Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. Choose a value from this list: - Biometric - Email - HTTPBasicAuth - Kerberos - KnowledgeBasedAuth - None - PaperDocuments - Password - RSASecureID - SingleSignOn_CASiteminder - SingleSignOn_InfoCard - SingleSignOn_MicrosoftActiveDirectory - SingleSignOn_Other - SingleSignOn_Passport - SingleSignOn_SAML - Smartcard - SSLMutualAuth - X509Certificate This information is included in the Certificate of Completion. - `clientURLs` (recipientTokenClientURLs, optional) - `clientUserId` (string, optional) — A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer. Use your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated. Maximum length: 100 characters. - `displayFormat` (string, optional) — This value determines whether the display will show an embedded or focused view experience. If set to `focused`, the display will use the focused view experience. If set to `default`, or if not set, the display will use the embedded experience. - `email` (string, optional) — (Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient. - `frameAncestors` (list of string, optional) — An array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/). In the demo environment, include your site URL and `https://apps-d.docusign.com`. You can use `http://localhost` for local development and testing. Example: `["https://my.site.com", "https://apps-d.docusign.com"]` In the production environment, include your site URL and `https://apps.docusign.com`. HTTPS must be enabled on your site. Example: `["https://my.site.com", "https://apps.docusign.com"]` - `messageOrigins` (list of string, optional) — The originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/). In the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`. - `pingFrequency` (string, optional) — Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds. - `pingUrl` (string, optional) — The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `returnUrl` (string, optional) — (Required) The URL to which the user should be redirected after the signing session has ended. Maximum Length: 470 characters. If the `returnUrl` exceeds this limit, the user is redirected to a truncated URL Be sure to include `https://` in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an `event` query parameter that your app can use: - `access_code_failed`: Recipient used incorrect access code. - `cancel`: Recipient canceled the signing operation, possibly by using the **Finish Later** option. - `decline`: Recipient declined to sign. - `exception`: A system error occurred during the signing process. - `fax_pending`: Recipient has a fax pending. - `id_check_failed`: Recipient failed an ID check. - `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option. - `signing_complete`: The recipient completed the signing ceremony. - `ttl_expired`: The Time To Live token for the envelope has expired. After being successfully invoked, these tokens expire after five minutes. - `viewing_complete`: The recipient completed viewing an envelope that is in a read-only/terminal state, such as completed, declined, or voided. - `securityDomain` (string, optional) — The domain in which the user authenticated. - `userId` (string, optional) — The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. If `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. If a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user. - `userName` (string, optional) — The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient. - `xFrameOptions` (string, optional) — Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: - `deny`: The page cannot be displayed in a frame. - `same_origin`: The page can only be displayed in a frame on the same origin as the page itself. - `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property. - `xFrameOptionsAllowFromUrl` (string, optional) — When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property. ### userInfo - `accountId` (string, optional) — The account ID associated with the envelope. - `accountName` (string, optional) — The name on the account. - `activationAccessCode` (string, optional) — Access code provided to the user to activate the account. - `email` (string, optional) — The user's email address. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `ipAddress` (string, optional) - `loginStatus` (string, optional) — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` (string, optional) — The user's membership ID. - `sendActivationEmail` (string, optional) — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` (string, optional) — A URI containing the user ID. - `userId` (string, optional) — The ID of the user to access. - `userName` (string, optional) — The name of the user. - `userStatus` (string, optional) — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` (string, optional) — The type of user, for example `CompanyUser`. ### templateRole Information about a specific role. - `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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `email` (string, optional) — The email address of the person associated with a role name. It is the email address of the person specified in the `name` property. For an in-person signer, this is the email address of the host. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `inPersonSignerName` (string, optional) — The full legal name of the in-person signer. Maximum Length: 100 characters. - `name` (string, optional) — Specifies the recipient's name. For an in-person signer, this is the name of the host. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupName` (string, optional) — The display name for the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. ### workflow Describes the workflow for an envelope. - `currentWorkflowStepId` (string, optional) — The `workflowStepId` of the current step. This is not an index into the `workflowSteps` array in this object. See the `workflowStep` object. - `overwriteUpdateMode` (string, optional) - `resumeDate` (string, optional) — The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the `resumeDate` property on `scheduledSending` and the `resumeDate` property on the current `workflowStep`. This property is read-only. - `scheduledSending` (scheduledSending, optional) — A complex element that specifies the scheduled sending settings for the envelope. - `workflowStatus` (string, optional) — The status of the workflow: - `paused` if the workflow is paused - `in_progress` if the workflow is in progress - `workflowSteps` (list of workflowStep, optional) — An array of workflow steps. ### inlineTemplate - `customFields` (customFields, optional) — Contains information about custom fields. - `documents` (list of document, optional) — A complex element that contains details about the documents associated with the envelope. - `envelope` (envelope, optional) - `recipients` (recipients, optional) — Specifies the envelope recipients. - `sequence` (string, optional) — Specifies the order in which templates are overlaid. ### serverTemplate - `sequence` (string, optional) — Specifies the order in which templates are overlaid. - `templateId` (string, optional) — The unique identifier of the template. If this is not provided, DocuSign will generate a value. ### listCustomField This object represents a list custom field from which envelope creators and senders can select custom data. - `configurationType` (string, optional) — If you are using merge fields, this property 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) — The ID of the custom field. - `listItems` (list of string, optional) — An array of strings that represents the options in a list. Maximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters. - `name` (string, optional) — The name of the custom field. - `required` (string, optional) — When **true,** senders are required to select an option from the list before they can send the envelope. - `show` (string, optional) — When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. - `value` (string, optional) — The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list. ### textCustomField This object represents a free text custom field where envelope creators and senders can enter custom data. - `configurationType` (string, optional) — If you are using merge fields, this property 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) — The ID of the custom field. - `name` (string, optional) — The name of the custom field. - `required` (string, optional) — When **true,** senders are required to enter or select information for the field before they can send the envelope. - `show` (string, optional) — When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. - `value` (string, optional) — The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters. ### docGenFormField The document fields available for document generation. This object is used in reponses (GET) and requests (PUT). When used with [DocumentGeneration: updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) (PUT), the `name` and `value` / `rowValues` properties are required and any other values are ignored. - `children` (list of docGenFormField, optional) - `connectedObjectDetails` (connectedObjectDetails, optional) - `defaultValue` (string, optional) - `description` (string, optional) — A description of the field. Displayed with the label. - `filter` (DocGenFormFieldFilter, optional) - `format` (docGenFormat, optional) - `fullyQualifiedPath` (string, optional) — Reserved for Docusign use. This value is returned in the `getEnvelopeDocGenFormFields` response but should not be included in `updateEnvelopeDocGenFormFields` requests. - `hidden` (boolean, optional) - `label` (string, optional) — A label displayed near the field. - `name` (string, optional) — The name of the sender field. Required for PUT requests. - `options` (list of docGenFormFieldOption, optional) — When `type` is `Select`, this array describes the available options. - `order` (string, optional) — Not currently used. - `predefinedValidation` (string, optional) — Reserved for Docusign. - `readOnly` (boolean, optional) - `required` (string, optional) — When **true,** the field is required. - `rowValues` (list of docGenFormFieldRowValue, optional) — For fields of type `TableRow`, this property represents the sender fields in the row. For GET requests, this array contains a single `docGenFormFieldRowValue` object. That object contains a list of sender fields that will appear in each row. For PUT requests, you must supply a `docGenFormFieldRowValue` object for each row in the table. This populates the data in the table. - `type` (string, optional) — The kind of data the sender field holds. Valid values: - `TextBox` - `Date` - `Number` - `Select` - `TableRow` - `validation` (docGenFormFieldValidation, optional) — Describes how values are validated. - `value` (string, optional) — The value of the sender field. For PUT requests, you must supply either this property (for all fields except `TableRow` types) or `rowValues` (for `TableRow` fields). ### nameValue A name-value pair that describes an item and provides a value for the item. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `name` (string, optional) — The name of the item. - `originalValue` (string, optional) — The initial value of the item. - `value` (string, optional) — The current value of the item. ### documentHtmlDefinition Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). - `displayAnchorPrefix` (string, optional) — Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance. - `displayAnchors` (list of documentHtmlDisplayAnchor, optional) — An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the [`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings) - `displayOrder` (string, optional) — The position on the page where the display section appears. - `displayPageNumber` (string, optional) — The number of the page on which the display section appears. - `documentGuid` (string, optional) — The GUID of 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. - `headerLabel` (string, optional) — Header text or an HTML tag to place above the responsive HTML block. - `maxScreenWidth` (string, optional) — If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level. - `removeEmptyTags` (string, optional) — Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes). - `showMobileOptimizedToggle` (string, optional) — When **true** (the default), the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. When **false,** the toggle will not be displayed. the **Mobile-Friendly** toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing. - `source` (string, optional) — Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980\&topicId=qlx1578456478178.html) is enabled, the HTML code is used to display the signing page: ```text source: " ...

hello world

" ``` If the value of this property is the string `document`, the HTML signing page is generated from the provided document. ```text source: "document" ``` **Related topics** * [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/) * [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) * [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) ### matchBox - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. 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. Must be an integer. May be zero. ### tabs Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `approveTabs` (list of approve, optional) — A list of [Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Approve tab enables 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. The value of an approve tab can't be set. - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `commentThreadTabs` (list of commentThread, optional) — An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. - `commissionCountyTabs` (list of commissionCounty, optional) — A list of [Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionExpirationTabs` (list of commissionExpiration, optional) — A list of [Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionNumberTabs` (list of commissionNumber, optional) — A list of [Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionStateTabs` (list of commissionState, optional) — A list of [Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `companyTabs` (list of company, optional) — A list of [Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company). A Company tab displays a field for the name of the recipient's company. This value can't be set. - `dateSignedTabs` (list of dateSigned, optional) — A list of [Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date Signed tab displays the date that the recipient signed the document. This value can't be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `declineTabs` (list of decline, optional) — A list of [Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. - `drawTabs` (list of draw, optional) — A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. - `emailAddressTabs` (list of emailAddress, optional) — A list of [Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables 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. This value can be set. 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. - `envelopeIdTabs` (list of envelopeId, optional) — A list of [Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid). An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. - `firstNameTabs` (list of firstName, optional) — A list of [First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname). A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `formulaTabs` (list of formulaTab, optional) — A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). 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. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html). If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html). - `fullNameTabs` (list of fullName, optional) — A list of [Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Full Name tab displays the recipient's full name. This value can't be set. - `initialHereTabs` (list of initialHere, optional) — A list of [Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to initial the document. May be optional. This value can't be set. - `lastNameTabs` (list of lastName, optional) — A list of [Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `listTabs` (list of list, optional) — An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `notarizeTabs` (list of notarize, optional) — A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. - `notarySealTabs` (list of notarySeal, optional) — A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `noteTabs` (list of note, optional) — A list of [Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Note tab displays additional information to the recipient in the form of a note. This value can be set. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `numericalTabs` (list of numerical, optional) — A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). - `phoneNumberTabs` (list of phoneNumber, optional) — A list of [Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `polyLineOverlayTabs` (list of polyLineOverlay, optional) — This type of tab enables the recipient to strike through document text. This value can't be set. - `prefillTabs` (prefillTabs, optional) — Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of 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. This value can be set. - `signerAttachmentTabs` (list of signerAttachment, optional) — A list of [Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. - `signHereTabs` (list of signHere, optional) — A list of [Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to sign a document. May be optional. This value can't be set. - `smartSectionTabs` (list of smartSection, optional) — A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `titleTabs` (list of title, optional) — A list of [Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Title tab displays the recipient's title. This value can't be set. - `viewTabs` (list of view, optional) — A list of [View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A View tab is used with an Approve tab to handle supplemental documents. This value can be set. - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ### 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. ### propertyMetadata Metadata about a property. - `options` (list of string, optional) — An array of option strings supported by this setting. - `rights` (string, optional) — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` ### signatureType This object contains information about the type of signature. - `isDefault` (string, optional) — When **true,** the signature type is the default type. - `type` (string, optional) — The type of signature. Valid values are: - `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that Docusign uses. - `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [Docusign Signature Appliance](/docs/dsa-api/). For more information, see [Standards Based Signatures](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). ### docGenSyntaxError Describes document generation errors. - `errorCode` (string, optional) — A code associated with the error condition. - `message` (string, optional) — The error message. - `tagIdentifier` (string, optional) — The tag that caused the syntax error. See [Document Generation Syntax](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ftc1679700030026.html) to learn more about document generation syntax rules. ### errorDetails This object describes errors that occur. It is only valid for responses, and ignored in requests. - `errorCode` (string, optional) — The code associated with the error condition. - `message` (string, optional) — A brief message describing the error condition. ### page Description of a page of a document. - `dpi` (string, optional) — The number of dots per inch used for the page image. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `height` (string, optional) — The height of the page in pixels. Must be an integer. - `imageBytes` (string, optional) — The number of image bytes. - `mimeType` (string, optional) — The MIME type. - `pageId` (string, optional) — The ID of the page. - `sequence` (string, optional) — The sequence of the page in the document, or page number. - `width` (string, optional) — The width of the page in pixels. Must be an integer. ### envelopeEvent For which envelope events should your webhook be called? - `envelopeEventStatusCode` (string, optional) — An envelope status for which your webhook should be called. Valid values: - `Sent` - `Delivered` - `Completed` - `Declined` - `Voided` - `includeDocuments` (string, optional) — When **true,** the Connect webhook messages will include the envelope's PDF documents. Including the PDF documents greatly increases the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. ### connectEventData This object lets you choose the data format of your Connect response. - `format` (string, optional) — Reserved for Docusign. - `includeData` (list of string, optional) — A string array of the data to be included. The default is the empty array `[]`. - `attachments`: Include attachments associated with the envelope. - `custom_fields`: Include the custom fields associated with the envelope. - `documents`: Include the documents associated with the envelope. - `extensions`: Include information about the email settings associated with the envelope. - `folders`: Include the folder where the envelope exists. - `payment_tabs`: Include the payment tabs associated with the envelope. - `powerform`: Include the PowerForms associated with the envelope. - `prefill_tabs`: Include the [pre-filled tabs](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope. - `recipients`: Include the recipients associated with the envelope. - `tabs`: Include the tabs associated with the envelope. - `version` (string, optional) — Set this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default. ### recipientEvent - `includeDocuments` (string, optional) — When **true,** the Connect webhook messages will include the envelope's PDF documents. Including the PDF documents greatly increases the size of the notification messages. Ensure that your listener can handle incoming messages that are 25MB or larger. - `recipientEventStatusCode` (string, optional) — Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. ### filter Use this object to create a filtered view of the items in a folder. - `actionRequired` (string, optional) — When **true,** the current user needs to take action on the item. - `expires` (string, optional) — The number of days a sent envelope remains active before it expires. - `folderIds` (string, optional) — Filters for any combination of folder IDs and folder types. The possible folder types are: - `awaiting_my_signature` - `completed` - `draft` - `drafts` - `expiring_soon` - `inbox` - `out_for_signature` - `recyclebin` - `sentitems` - `waiting_for_others` - `fromDateTime` (string, optional) — The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days. - `isTemplate` (string, optional) — When **true,** the item is a template. - `order` (string, optional) — The order in which to sort the results. Valid values are: - `asc`: Ascending order. - `desc`: Descending order. - `orderBy` (string, optional) — The field used to sort the results. Example: `Created` - `searchTarget` (string, optional) — Reserved for Docusign. - `searchText` (string, optional) — A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject. - `status` (string, optional) — The status of the envelope. By default, all statuses are returned. For details, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/). - `toDateTime` (string, optional) — The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date. ### folderItem_v2 Information about folder item results. - `completedDateTime` (string, optional) — If the item is an envelope, this is the UTC DateTime when the envelope was completed. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `envelopeId` (string, optional) — If the item is an envelope, this is the ID of the envelope. - `envelopeUri` (string, optional) — If the item is an envelope, this is the URI for retrieving it. - `expireDateTime` (string, optional) — The date and time the envelope is set to expire. - `folderId` (string, optional) — The ID of the folder. - `folderUri` (string, optional) — If the item is a subfolder, this is the URI for retrieving it. - `is21CFRPart11` (string, optional) — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `ownerName` (string, optional) — The name of the user who owns the folder. - `recipients` (recipients, optional) — Specifies the envelope recipients. - `recipientsUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the recipients. - `senderCompany` (string, optional) — The name of the sender's company. - `senderEmail` (string, optional) — The sender's email address. - `senderName` (string, optional) — The sender's name. - `senderUserId` (string, optional) — The sender's id. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `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. - `subject` (string, optional) — The subject of the envelope. - `templateId` (string, optional) — The unique identifier of the template. If this is not provided, DocuSign will generate a value. - `templateUri` (string, optional) — The URI for retrieving the template. ### expirations A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided. - `expireAfter` (string, optional) — An integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.** - `expireEnabled` (string, optional) — When **true,** the envelope expires in the number of days set by `expireAfter`. When **false** or not set, the envelope expires in the number of days specified by the [default expiration account setting](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html). If you have not modified these settings, envelopes will expire after 120 days by default. - `expireWarn` (string, optional) — An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent. ### reminders A complex element that specifies reminder settings for the envelope - `maximumReminderCount` (string, optional) - `reminderDelay` (string, optional) — An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0. - `reminderEnabled` (string, optional) — When **true,** reminders are enabled. The default value is **false.** - `reminderFrequency` (string, optional) — An integer specifying the interval in days between reminder emails. The default value is 0. - `smartReminderEnabled` (string, optional) ### envelope - `accessControlListBase64` (string, optional) — Reserved for Docusign. - `allowComments` (string, optional) — When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document. - `allowMarkup` (string, optional) — When **true,** the Document Markup feature is enabled. **Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level. - `allowReassign` (string, optional) — When **true,** the recipient can redirect an envelope to a more appropriate recipient. - `allowViewHistory` (string, optional) — When **true,** recipients can view the history of the envelope. - `anySigner` (string, optional) — Deprecated. This feature has been replaced by signing groups. - `asynchronous` (string, optional) — When **true,** the envelope is queued for processing and the value of the `status` property is set to `Processing`. Additionally, GET status calls return `Processing` until completed. **Note:** A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the [transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the Connect notification. - `attachmentsUri` (string, optional) — Contains a URL for retrieving the attachments that are associated with the envelope. - `authoritativeCopy` (string, optional) — When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** - `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 **true,** autonavigation is set for the recipient. - `brandId` (string, optional) — The ID of the brand. - `brandLock` (string, optional) — When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. - `burnDefaultTabData` (string, optional) - `certificateUri` (string, optional) — The URI for retrieving certificate information. - `completedDateTime` (string, optional) — Specifies the date and time this item was completed. - `copyRecipientData` (string, optional) - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `customFields` (customFields, optional) — Contains information about custom fields. - `customFieldsUri` (string, optional) — The URI for retrieving custom fields. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `deletedDateTime` (string, optional) — Reserved for Docusign. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `disableResponsiveDocument` (string, optional) — When **true,** responsive documents are disabled for the envelope. - `documentBase64` (string, optional) — Reserved for Docusign. - `documentsCombinedUri` (string, optional) — The URI for retrieving all of the documents associated with the envelope as a single PDF file. - `documentsUri` (string, optional) — The URI for retrieving all of the documents associated with the envelope as separate files. - `emailBlurb` (string, optional) — This is the same as the email body. If specified it is included in email body for all envelope recipients. - `emailSettings` (emailSettings, optional) — A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. **IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. 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 Length: 100 characters. *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. - `emailSubject` (string, optional) — The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. - `enableWetSign` (string, optional) — When **true,** the signer is allowed to print the document and sign it on paper. - `enforceSignerVisibility` (string, optional) — When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings](https://admindemo.docusign.com/authenticate?goTo=sending) will be enforced for the envelope. See [Fields and Properties](https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html) for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting. **Note:** To use this functionality, [document visibility](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/) must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/en/contactSupport#) or your account manager to find out whether document visibility is available for your production account plan. - `envelopeAttachments` (list of attachment, optional) — An array of attachment objects that provide information about the attachments that are associated with the envelope. - `envelopeClassification` (string, optional) - `envelopeCustomMetadata` (envelopeCustomMetadata, optional) - `envelopeDocuments` (list of envelopeDocument, optional) — An array containing information about the documents that are included in the envelope. - `envelopeId` (string, optional) — The envelope ID of the envelope status that failed to post. - `envelopeIdStamping` (string, optional) — When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed. - `envelopeLocation` (string, optional) — Reserved for Docusign. - `envelopeMetadata` (envelopeMetadata, optional) - `envelopeUri` (string, optional) — The URI for retrieving the envelope or envelopes. - `expireAfter` (string, optional) — Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. - `expireDateTime` (string, optional) — The date and time that the envelope is set to expire. This value is determined by the `InitialSentDateTime` of the envelope and the `expireAfter` property of the `notification` object. (Note that the `expireAfter` property of the envelope itself is not used.) - `expireEnabled` (string, optional) — Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. - `externalEnvelopeId` (string, optional) — May contain an external identifier for the envelope. - `folders` (list of folder, optional) — A list of folder objects. - `hasComments` (string, optional) — When **true,** indicates that users have added comments to the envelope. - `hasFormDataChanged` (string, optional) — When **true,** indicates that the data collected through form fields on a document has changed. - `hasWavFile` (string, optional) — When **true,** indicates that a .wav file used for voice authentication is included in the envelope. - `holder` (string, optional) — Reserved for Docusign. - `initialSentDateTime` (string, optional) — The date and time the envelope was initially sent. - `is21CFRPart11` (string, optional) — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `isDynamicEnvelope` (string, optional) — When **true,** indicates that the envelope is a dynamic envelope. - `isSignatureProviderEnvelope` (string, optional) — When **true,** indicates that the envelope is a signature-provided envelope. - `isTicketRelatedEnvelope` (string, optional) - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `location` (string, optional) — Reserved for Docusign. - `lockInformation` (lockInformation, optional) - `messageLock` (string, optional) — When **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 settings for the envelope. - `notificationUri` (string, optional) — The URI for retrieving notifications. - `powerForm` (powerForm, optional) — Contains details about a PowerForm. - `purgeCompletedDate` (string, optional) — The date that a purge was completed. - `purgeRequestDate` (string, optional) — The date that a purge was requested. - `purgeState` (string, optional) — Shows the current purge state for the envelope. Valid values: - `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_purged`: The envelope documents have been successfully purged. - `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. - `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted. - `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) - `recipients` (recipients, optional) — Specifies the envelope recipients. - `recipientsLock` (string, optional) — When **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. - `sender` (userInfo, optional) - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signerCanSignOnMobile` (string, optional) — When **true,** recipients can sign on a mobile device. **Note:** Only Admin users can change this setting. - `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. See [Envelope status code descriptions](/docs/esign-rest-api/esign101/concepts/envelopes/status-codes/#envelope-status-code-descriptions) for a list of valid values. - `statusChangedDateTime` (string, optional) — The date and time when the status last changed. - `templatesUri` (string, optional) — The URI for retrieving 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 **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **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. - `uSigState` (string, optional) — A property that is only used internally by Docusign. - `voidedDateTime` (string, optional) — The date and time the envelope or template was voided. - `voidedReason` (string, optional) — The reason the envelope or template was voided. **Note:** The string is truncated to the first 200 characters. - `watermarkLanguage` (string, optional) - `workflow` (workflow, optional) — Describes the workflow for an envelope. ### powerFormRecipient **Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. - `accessCode` (string, optional) — (Optional) The access code that the recipient must enter to access the PowerForm. Maximum Length: 50 characters. The code must also 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. - `accessCodeLocked` (string, optional) — When **true,** the `accessCode` property is locked and cannot be edited. - `accessCodeRequired` (string, optional) — When **true,** the recipient must enter the `accessCode` to access the PowerForm. - `email` (string, optional) — The email address of the recipient. **Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. - `emailLocked` (string, optional) — When **true,** the recipient's email address is locked and cannot be edited. - `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. - `idCheckRequired` (string, optional) — Indicates if authentication is configured for the account. Valid values are: - `always`: Authentication checks are performed on every envelope. - `never`: Authentication checks are not performed on any envelopes. - `optional:` Authentication is configurable per envelope. - `name` (string, optional) — The name of the PowerForm recipient. **Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `roleName` (string, optional) — The role associated with the recipient (for example, `Member`). This property is required when you are working with template recipients and PowerForm recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `templateRequiresIdLookup` (string, optional) — When **true,** the template used to create the PowerForm requires ID lookup for the recipient. - `userNameLocked` (string, optional) — When **true,** the `userName` property for the recipient is locked and cannot be edited. ### agent Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order. - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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 email ID of the agent. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### authorizedSignatory - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) - `agentCanEditEmail` (string, optional) - `agentCanEditName` (string, optional) - `allowSystemOverrideForLockedRecipient` (string, optional) - `autoNavigation` (string, optional) - `autoRespondedReason` (string, optional) - `bulkRecipientsUri` (string, optional) — Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. - `bulkSendV2Recipient` (string, optional) - `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. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. - `completedCount` (string, optional) - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) - `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. - `declinedReason` (string, optional) — The reason the recipient declined the document. - `defaultRecipient` (string, optional) - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethod` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) - `designatorIdGuid` (string, optional) - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) - `email` (string, optional) - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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: - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `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) - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) - `lockedRecipientSmsEditable` (string, optional) - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) - `notarySignerEmailSent` (string, optional) - `note` (string, optional) — Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved: - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) - `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) - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) - `recipientSuppliesTabs` (string, optional) - `recipientType` (string, optional) - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) - `requireSignOnPaper` (string, optional) - `requireUploadSignature` (string, optional) - `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. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The date and time the envelope was sent. - `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 use only. - `signInEachLocation` (string, optional) — When set to **true**, specifies that the signer must sign in all locations. - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `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). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — The display name for the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusCode` (string, optional) - `suppressEmails` (string, optional) - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `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) - `userId` (string, optional) - `webFormRecipientViewId` (string, optional) ### carbonCopy Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Not applicable for Carbon Copy recipients. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `linkedAccountConfigurationId` (string, optional) - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### certifiedDelivery Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — The status of the recipient. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### editor A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients. - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### inPersonSigner Contains information about an in-person recipient. This is a Docusign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [EnvelopeRecipients resource](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When **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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion. If this number is greater than `0` for a signing group, only the user who previously completed may sign again. - `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). This property is 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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this is the default recipient for the envelope. This option is used when creating an envelope from a template. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `hostEmailMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `hostNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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. - `inPersonSigningTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The signer's full legal name in an eNotary flow. Required when `inPersonSigningType` is `notary`. For a regular in-person-signer flow, use `signerName` instead. Maximum Length: 100 characters. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `notaryId` (string, optional) - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is 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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is 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. - `signerEmailMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerFirstName` (string, optional) — The signer's first name. - `signerFirstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerLastName` (string, optional) — The signer's last name. - `signerLastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerName` (string, optional) — Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters. - `signerNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signInEachLocation` (string, optional) — When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — Not applicable. You cannot use a signing group for an in-person signer. - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Not applicable. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, 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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### intermediary Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipientÃ¢ÂÂs email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### notaryRecipient - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkRecipientsUri` (string, optional) — Reserved for Docusign. - `bulkSendV2Recipient` (string, optional) - `canNotaryCorrectEnvelope` (string, optional) - `canSignOffline` (string, optional) — When **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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) — The reason why the item was created. - `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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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) — Reserved for Docusign. - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) — The user's last name. Maximum Length: 50 characters. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `liveOakStartURL` (string, optional) — URL that directs the recipient to LiveOak to complete the remote online notarization process. This property is read-only. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) — Not applicable to Notary tab. - `notarySignerEmailSent` (string, optional) - `notarySigners` (list of string, optional) — An array of strings that correspond to the `recipientId` of each signer in the notary group. This property is read-only. - `notarySourceType` (string, optional) — Valid values: - `firstparty`: Set this value if using the [remote online notary](/docs/notary-api/how-to/send-signature-request-notary-group/) (RON) feature. - `thirdparty`: Set this value if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature. - `notaryThirdPartyPartner` (string, optional) — Set this value to `onenotary` if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature. - `notaryType` (string, optional) — Set this value to `remote` if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is 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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is 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 **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `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. - `statusCode` (string, optional) — Reserved for Docusign. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### notaryWitness - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) - `agentCanEditEmail` (string, optional) - `agentCanEditName` (string, optional) - `allowSystemOverrideForLockedRecipient` (string, optional) - `autoNavigation` (string, optional) - `autoRespondedReason` (string, optional) - `bulkRecipientsUri` (string, optional) — Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. - `bulkSendV2Recipient` (string, optional) - `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. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. - `completedCount` (string, optional) - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) - `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. - `declinedReason` (string, optional) — The reason the recipient declined the document. - `defaultRecipient` (string, optional) - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethod` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) - `designatorIdGuid` (string, optional) - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) - `email` (string, optional) - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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: - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `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) - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) - `lockedRecipientSmsEditable` (string, optional) - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) - `notarySignerEmailSent` (string, optional) - `note` (string, optional) — Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved: - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) - `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) - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) - `recipientSuppliesTabs` (string, optional) - `recipientType` (string, optional) - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) - `requireSignOnPaper` (string, optional) - `requireUploadSignature` (string, optional) - `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. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The date and time the envelope was sent. - `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 use only. - `signInEachLocation` (string, optional) — When set to **true**, specifies that the signer must sign in all locations. - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `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). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — The display name for the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusCode` (string, optional) - `suppressEmails` (string, optional) - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `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) - `type` (string, optional) - `userId` (string, optional) - `webFormRecipientViewId` (string, optional) - `witnessFor` (string, optional) - `witnessForGuid` (string, optional) ### participant - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `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 string can be a maximum of 100 characters. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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) - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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 user's last name. Maximum Length: 50 characters. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `participateFor` (string, optional) - `participateForGuid` (string, optional) - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `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. - `statusCode` (string, optional) — Reserved for Docusign. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### sealSign Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: ```text "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProviders": [ { "sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106" } ] } ] }, . . . ``` For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908\&topicId=isl1578456577247.html). - `accessCode` (string, optional) — Not applicable. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Not applicable. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Not applicable. - `completedCount` (string, optional) — Not applicable. - `customFields` (list of string, optional) — Not applicable. - `declinedDateTime` (string, optional) — Not applicable. - `declinedReason` (string, optional) — Not applicable. - `deliveredDateTime` (string, optional) — Not applicable. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — Not applicable. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `embeddedRecipientStartURL` (string, optional) — Not applicable. - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — Not applicable. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — Not applicable. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — Not applicable. - `note` (string, optional) — Not applicable. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Not applicable. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `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. This property is read-only. - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — (Required) Indicates which electronic seal to apply on documents when creating an envelope. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — Not applicable. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are 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. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — Not applicable. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. - `webFormRecipientViewId` (string, optional) ### 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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **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 **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. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkRecipientsUri` (string, optional) — Reserved for Docusign. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When **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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) — The reason why the item was created. - `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 recipient may be assigned a maximum of 3 custom fields, and each customField string can be a maximum of 100 characters. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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 notifications about the documents to sign to this address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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 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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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 **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](mailto:bulk@recipient.com) and "Bulk Recipient". These fields can not be changed for the bulk recipient. - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) — The `recipientId` of the notary for this signer. - `notarySignerEmailSent` (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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is 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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) — Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. Valid values: - `docusign_express`: Requires a Docusign Express certificate. - `safe`: Requires a SAFE-BioPharma certificate. - `open_trust`: Requires an OpenTrust certificate. **Important:** There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. - `requireSignOnPaper` (string, optional) — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is 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 **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — Specifies the status of the recipient at the time of the request. This property is 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. - `statusCode` (string, optional) — Reserved for Docusign. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### witness A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkRecipientsUri` (string, optional) — Reserved for Docusign. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When **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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). This property is 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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **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) — Reserved for Docusign. - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `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. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) - `notarySignerEmailSent` (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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `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. This property is 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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is 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 **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) - `witnessFor` (string, optional) — The `recipientId` of the person or party for whom the recipient is a witness. - `witnessForGuid` (string, optional) — Not used. Use the `witnessFor` property instead. ### recipientTokenClientURLs - `onAccessCodeFailed` (string, optional) - `onCancel` (string, optional) - `onDecline` (string, optional) - `onException` (string, optional) - `onFaxPending` (string, optional) - `onIdCheckFailed` (string, optional) - `onSessionTimeout` (string, optional) - `onSigningComplete` (string, optional) - `onTTLExpired` (string, optional) - `onViewingComplete` (string, optional) ### recipientAdditionalNotification Describes an additional notification method. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `secondaryDeliveryMethod` (string, optional) — The secondary delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `secondaryDeliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `secondaryDeliveryStatus` (string, optional) — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` ### recipientEmailNotification Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` (string, optional) — The body of the email message. - `emailBodyMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailSubject` (string, optional) — The subject line for the email notification. - `emailSubjectMetadata` (propertyMetadata, optional) — Metadata about a property. - `supportedLanguage` (string, optional) — The language to use for the standard email format and signing view for a recipient. For example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** This setting affects only Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. To retrieve the possible values, use the [Accounts::listSupportedLanguages](/docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/) method. - `supportedLanguageMetadata` (propertyMetadata, optional) — Metadata about a property. ### recipientPhoneNumber Describes the recipient phone number. - `countryCode` (string, optional) — The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`, Do not include the `+` symbol. - `countryCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `number` (string, optional) — The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters. Do not include the `countryCode`. For US, Canada, and other [North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`. - `numberMetadata` (propertyMetadata, optional) — Metadata about a property. ### recipientSignatureProvider An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/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. If using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature, set this value to `false` for the notary recipient, and set it to `false` or omit it for the signer recipient. - `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. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method. Example: `universalsignaturepen_default` If using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature, set this value to `ds_authority_idv` for the notary recipient, and set it to `universalsignaturepen_imageonly` or omit it for the signer recipient. - `signatureProviderNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) ### scheduledSending A complex element that specifies the scheduled sending settings for the envelope. - `bulkListId` (string, optional) — The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation. - `resumeDate` (string, optional) — The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only. - `rules` (list of envelopeDelayRule, optional) — User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified. - `status` (string, optional) — Status of the scheduled sending job. Valid values: - `pending`: The envelope has not yet been sent and the scheduled sending delay has not been initiated. - `started`: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient. - `completed`: The delay has elapsed and the envelope has been sent to the first recipient. This property is read-only. ### workflowStep Describes a single step in a workflow. - `action` (string, optional) — Indicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached. - `completedDate` (string, optional) — The timestamp of when the workflow step transitioned to `completed` status. This property is read-only. - `delayedRouting` (delayedRouting, optional) — A complex element that specifies the delayed routing settings for the workflow step. - `itemId` (string, optional) — The unique ID of the item being triggered. - `recipientRouting` (recipientRouting, optional) — Describes the recipient routing rules. - `status` (string, optional) — The status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only. - `triggeredDate` (string, optional) — The timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only. - `triggerOnItem` (string, optional) — The type of item that triggers this workflow step. Valid values: - `routing_order` - `workflowStepId` (string, optional) — A unique identifier for this workflow step. This property is read-only. ### connectedObjectDetails - `recordId` (string, optional) ### DocGenFormFieldFilter ### docGenFormat - `expression` (string, optional) - `locale` (string, optional) ### docGenFormFieldOption Specifies an individual option setting when type is `Select`. - `description` (string, optional) — Description of the selectable option. - `label` (string, optional) — The label for the selectable option. - `selected` (string, optional) — When **true,** the option is selected. - `value` (string, optional) — Specifies the value of the option. This is the value of the form field when this option is selected. ### docGenFormFieldRowValue An object representing a row of a dynamic table. - `docGenFormFieldList` (list of docGenFormField, optional) — The sender fields in each row of the table. For GET requests, the `label`, `type`, `required`, and `name` properties will be returned. For POST requests, supply the `name` and `value` for each child object. These correspond to the values in each column. ### docGenFormFieldValidation Describes how values are validated. - `errorMessage` (string, optional) — The error message when validation fails. - `expression` (string, optional) — The expression used to validate values. ### documentHtmlDisplayAnchor - `caseSensitive` (boolean, optional) — When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content. - `displaySettings` (documentHtmlDisplaySettings, optional) — This object defines how to display the HTML between the `startAnchor` and `endAnchor`. - `endAnchor` (string, optional) — Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `removeEndAnchor` (boolean, optional) — When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. - `removeStartAnchor` (boolean, optional) — When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. - `startAnchor` (string, optional) — Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. ### approve A tab that allows the recipient to approve documents without placing a signature or initials on the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — Specifies the approval text that displays in the tab. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The Docusign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Approve tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### checkbox A tab that allows the recipient to select a yes/no (on/off) option. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The Docusign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — This property does not apply to `checkbox` tabs. To require users to check at least one, or at most some number of checkboxes, associate the checkbox tabs with a [`tabGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups). Then set the following `tabGroup` properties: - [`maximumAllowed`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed) - [`minimumRequired`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired) - [`groupRule`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule) specifies how the other two properties are interpreted. You can find an example at [Stack Overflow](https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277). - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `selected` (string, optional) — When **true,** the checkbox is selected. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `selectedOriginal` (string, optional) - `selectedOriginalMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commentThread - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `comments` (list of comment, optional) — An array of comment tabs that contain information about users' comments on documents. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `threadId` (string, optional) — The unique identifier for the comment thread. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionCounty A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionExpiration A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionNumber A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionState A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### company A tab that displays the recipient's company name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### dateSigned A tab that displays the date that the recipient signed the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `timestampStandardized` (string, optional) - `tooltip` (string, optional) — **Note:** Date Signed tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### date A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### decline A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — Specifies the decline text displayed in the tab. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `declineReason` (string, optional) — The reason the recipient declined the document. - `declineReasonMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Decline tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### draw A tab that allows the recipient to add a free-form drawing to the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `allowSignerUpload` (string, optional) — When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.** - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `useBackgroundAsCanvas` (string, optional) - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### emailAddress A tab that displays the recipient's email as entered in the recipient information. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The Docusign-generated custom tab ID for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Email Address tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### envelopeId A tab that displays the envelope ID. **Note:** The eSignature API uses the name `envelopeId` two ways: - As a _property_ of type `string` used to identify an envelope by its GUID. - As an _object_ used to represent an envelope tab that displays the envelope's GUID. - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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 - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extendPaymentConfiguration` (extendPaymentConfiguration, optional) - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `hiddenMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `roundDecimalPlaces` (string, optional) — The number of decimal places to round to. - `roundDecimalPlacesMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### fullName A tab that displays the recipient's full name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### initialHere A tab that allows the recipient to initial the document. May be optional. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — When set to `true`, requires a hand-drawn initial by the signer. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, 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. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -7) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -7) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### list This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) objects to specify the selectable options. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `listSelectedValue` (string, optional) — The value in the list that is selected by default. - `listSelectedValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — The value to use when the item is selected. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### notarize A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### notarySeal A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### note A tab that displays additional information, in the form of a note, for the recipient. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Note tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### number Number tabs validate that the entered value is a number. They do not support advanced validation or display options. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### numerical Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This ID must refer to an existing document. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxNumericalValue` (string, optional) — The maximum value that the numerical tab can take on. The largest value allowed, and the default if not specified, is `999999999.99` - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `minNumericalValue` (string, optional) — The minimum value that the numerical tab can take on. The smallest value allowed, and the default if not specified, is `-999999999.99` - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `numericalValue` (string, optional) — The raw numerical value of the tab. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, the `value` property will contain the string `"($ 1,234.56)"`. - `originalNumericalValue` (string, optional) — The original value of the tab. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationType` (string, optional) — Specifies how numerical data is validated. Valid values: - `number` - `currency` - `value` (string, optional) — The `numericalValue` of the tab displayed according to its locale policy. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, this property will contain the string `"($ 1,234.56)"`. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### phoneNumber A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### polyLineOverlay This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `graphicsContext` (graphicsContext, optional) - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `overlayType` (string, optional) — The type of overlay to use. The API currently supports only the `outline` overlay type. - `overlayTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `polyLines` (list of polyLine, optional) — An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** indicates that the tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### prefillTabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables 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. This value can be set. 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. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of 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. This value can be set. - `senderCompanyTabs` (list of senderCompany, optional) - `senderNameTabs` (list of senderName, optional) - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ### radioGroup This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) 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. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupName` (string, optional) — The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. - `groupNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `radios` (list of radio, optional) — Specifies the locations and status for radio buttons that are grouped together. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `source` (string, optional) - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `tooltipMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. ### signerAttachment A tab that allows the recipient to attach supporting documents to an envelope. - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — Reserved for Docusign. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### signHere A tab that allows the recipient to sign a document. May be optional. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — When set to `true`, requires a hand-drawn signature by the signer. - `height` (string, optional) — Not applicable to Sign Here tab. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isSealSignTab` (string, optional) — When **true,** the tab contains a visual representation for an electronic seal in a document. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `stamp` (stamp, optional) - `stampType` (string, optional) — The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null - `stampTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — Not applicable to Sign Here tab. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### smartSection - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `caseSensitive` (boolean, optional) — When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `displaySettings` (smartSectionDisplaySettings, optional) — These properties define how a Smart Section displays. A Smart Section is a type of display section. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `endAnchor` (string, optional) — Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `endPosition` (smartSectionAnchorPosition, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `overlayType` (string, optional) — The type of overlay to draw on the document. The following overlay types are supported: - `line` - `outline` - `overlayTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `removeEndAnchor` (boolean, optional) — When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. - `removeStartAnchor` (boolean, optional) — When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `startAnchor` (string, optional) — Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `startPosition` (smartSectionAnchorPosition, optional) - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### tabGroup - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupLabel` (string, optional) — A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array. - `groupLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupRule` (string, optional) — Specifies how `maximumAllowed` and `minimumRequired` are interpreted when selecting tabs in a `tabGroup`. Possible values are: - `SelectAtLeast` - `SelectAtMost` - `SelectExactly` - `SelectARange` - `groupRuleMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `maximumAllowed` (string, optional) — The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. - `maximumAllowedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `minimumRequired` (string, optional) — The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. - `minimumRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab group will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabScope` (string, optional) — The scope of the tab group. Possible values are: - `document` - `envelope` (default) - `tabScopeMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### text A tab that allows the recipient to enter any type of text. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) — A description of the tab that can match the original document caption or describe its intent. When a Web Form is generated from a template this value will be used as the caption of the field shown on the form. - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — The `shared` and `shareToRecipients` properties work together to define signing behavior. If `"shared": "true"`, it overrides `shareToRecipients`, and the tab is shared with all recipients. In mixed cases, the API prioritizes `"shared": "true"` for all recipients, or `"shared": "false"` for specified recipients. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — The value of the text tab. Maximum length: 4000 bytes. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### title A tab that displays the recipient's title. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### view This tab is used with the Approve tab to handle supplemental documents. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — The text to display on the button. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requiredRead` (string, optional) — When **true,** the recipient must read through the document. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### 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. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. 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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `useDash4` (string, optional) — When **true,** ZIP+4 format is used. - `useDash4Metadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### consentDetails - `consentKey` (string, optional) - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `signerConsentStatus` (string, optional) ### documentVisibility This object configures a recipient's read/write access to a 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. - `recipientId` (string, optional) — The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object. - `rights` (string, optional) — Indicates whether the document is editable: - `editable` - `read_only` - `visible` (string, optional) — When **true,** the document is visible to the recipient. ### idCheckInformationInput A complex element that contains input information related to a recipient ID check. - `addressInformationInput` (addressInformationInput, optional) — Contains address input information. - `dobInformationInput` (dobInformationInput, optional) — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - `ssn4InformationInput` (ssn4InformationInput, optional) - `ssn9InformationInput` (ssn9InformationInput, optional) ### recipientIdentityVerification Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `hasAutoAttachedRiskAssessment` (string, optional) - `inputOptions` (list of recipientIdentityInputOption, optional) - `workflowId` (string, optional) — ID of the Identity Verification worklow used to verify recipients' identity. This ID must match one of the [workflowId](/docs/esign-rest-api/reference/accounts/identityverifications/list/) available to your account. - `workflowIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `workflowLabel` (string, optional) ### recipientPhoneAuthentication A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `recipMayProvideNumber` (string, optional) — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recordVoicePrint` (string, optional) — Reserved for Docusign. - `recordVoicePrintMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderProvidedNumbers` (list of string, optional) — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` (propertyMetadata, optional) — Metadata about a property. - `validateRecipProvidedNumber` (string, optional) — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` (propertyMetadata, optional) — Metadata about a property. ### recipientProofFile The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `hasIdentityAttempts` (string, optional) - `isInProofFile` (string, optional) — Indicates whether a proof file is available for this recipient. ### recipientAttachment - `attachmentId` (string, optional) — The unique identifier for the attachment. - `attachmentType` (string, optional) — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` (string, optional) — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` (string, optional) — An optional label for the attachment. - `name` (string, optional) — The name of the attachment. - `remoteUrl` (string, optional) — The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. ### authenticationStatus A complex element that contains information about a user's authentication status. - `accessCodeResult` (eventResult, optional) — Information about the result of an event. - `ageVerifyResult` (eventResult, optional) — Information about the result of an event. - `anySocialIDResult` (eventResult, optional) — Information about the result of an event. - `facebookResult` (eventResult, optional) — Information about the result of an event. - `googleResult` (eventResult, optional) — Information about the result of an event. - `identityVerificationResult` (eventResult, optional) — Information about the result of an event. - `idLookupResult` (eventResult, optional) — Information about the result of an event. - `idQuestionsResult` (eventResult, optional) — Information about the result of an event. - `linkedinResult` (eventResult, optional) — Information about the result of an event. - `liveIDResult` (eventResult, optional) — Information about the result of an event. - `ofacResult` (eventResult, optional) — Information about the result of an event. - `openIDResult` (eventResult, optional) — Information about the result of an event. - `phoneAuthResult` (eventResult, optional) — Information about the result of an event. - `salesforceResult` (eventResult, optional) — Information about the result of an event. - `signatureProviderResult` (eventResult, optional) — Information about the result of an event. - `smsAuthResult` (eventResult, optional) — Information about the result of an event. - `sTANPinResult` (eventResult, optional) — Information about the result of an event. - `twitterResult` (eventResult, optional) — Information about the result of an event. - `yahooResult` (eventResult, optional) — Information about the result of an event. ### featureAvailableMetadata - `availabilty` (string, optional) - `featureName` (string, 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 that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` (propertyMetadata, optional) — Metadata about a property. ### socialAuthentication - `authentication` (string, optional) — Reserved for Docusign. ### delegationInfo - `email` (string, optional) - `name` (string, optional) - `userAuthorizationId` (string, optional) - `userId` (string, optional) ### offlineAttributes Reserved for Docusign. - `accountEsignId` (string, optional) — Reserved for Docusign. - `deviceModel` (string, optional) — Reserved for Docusign. - `deviceName` (string, optional) — Reserved for Docusign. - `gpsLatitude` (string, optional) — Reserved for Docusign. - `gpsLongitude` (string, optional) — Reserved for Docusign. - `offlineSigningHash` (string, optional) — Reserved for Docusign. ### 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) — The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. - `"1_DocuSign"` - `"2_DocuSign"` - `"3_DocuSign"` - `"4_DocuSign"` - `"5_DocuSign"` - `"6_DocuSign"` - `"7_DocuSign"` - `"8_DocuSign"` - `"Mistral"` - `"Rage Italic"` - `signatureInitials` (string, optional) — Specifies the user's signature in initials format. - `signatureName` (string, optional) — Specifies the user's signature name. ### 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. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. - `bulkSendV2Recipient` (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. 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is 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. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `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. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `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. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `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. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `hostRecipientId` (string, optional) — The host recipient ID. - `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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When **true** and the envelope recipient creates a Docusign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The notary's full legal name. Maximum Length: 100 characters. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `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. This property is read-only. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of 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) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **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. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### recipientSignatureProviderOptions Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `cpfNumber` (string, optional) — Reserved for Docusign. - `cpfNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `oneTimePasswordMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerRole` (string, optional) — The role or capacity of the signing recipient. Examples: Manager, Approver, etc. - `signerRoleMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `smsMetadata` (propertyMetadata, optional) — Metadata about a property. ### envelopeDelayRule A user-specified object that describes the envelope delay. To indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used. - `delay` (string, optional) — A string timespan representing the duration of the sending delay. The timespan is in the format `d.hh:mm:ss` where `d` is the number of days, `hh` is the number of hours (measured on a 24-hour clock), `mm` is minutes, and `ss` is seconds. The maximum delay is 30 days. - `resumeDate` (string, optional) — An ISO 8601 formatted datetime string indicating the date and time that the envelope will be sent. The specified datetime must occur in the future. It must not exceed 30 days from the time that the request is made. ### delayedRouting A complex element that specifies the delayed routing settings for the workflow step. - `resumeDate` (string, optional) — The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is `null` if the workflow step has not been initiated. This property is read-only. - `rules` (list of envelopeDelayRule, optional) — User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified. - `status` (string, optional) — Status of the delayed routing step. Valid values: - `pending`: The workflow step has not been reached and the delay has not been initiated. - `started`: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients. - `completed`: The delay has elapsed and the envelope has been sent to the workflow step's recipients. This property is read-only. ### recipientRouting Describes the recipient routing rules. - `rules` (recipientRules, optional) ### documentHtmlDisplaySettings This object defines how to display the HTML between the `startAnchor` and `endAnchor`. - `cellStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. - `collapsibleSettings` (documentHtmlCollapsibleDisplaySettings, optional) — Display settings for collapsible section. - `display` (string, optional) — Sets the display and behavior properties. Possible values are: - `inline`: Leaves the HTML where it is in the document. This property lets you add a label or present on a separate page. - `collapsible`: The HTML in this section may be expanded or collapsed. Initially this section is expanded. - `collapsed`: The HTML in this section may be expanded or collapsed. Initially this section is collapsed. - `continue_button`: Creates a stop point in the document to draw the reader's attention before proceeding to the next section. - `responsive_table`: Turns this section into a responsive table. Note that this is only used on HTML tables that fall within the anchor start and end positions. - `responsive_table_single_column`: Turns this section into a responsive single-column table. Note this is only used on HTML tables that fall within the anchor start and end positions. The table will be converted to one single column where each current column will become a row, then stacked. - `print_only`: Do not show this portion of the HTML in the responsive signing view. - `displayLabel` (string, optional) — The label to add to this display section in the signing page. - `displayOrder` (integer, optional) — The position on the page where the display section appears. - `displayPageNumber` (integer, optional) — The number of the page on which the display section appears. - `hideLabelWhenOpened` (boolean, optional) — When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. - `inlineOuterStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. - `labelWhenOpened` (string, optional) — The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. - `preLabel` (string, optional) — Enables you to add descriptive text that appears before a collapsed section or continue button. - `scrollToTopWhenOpened` (boolean, optional) — When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. - `tableStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. ### extensionData - `actionContract` (string, optional) — The template that defines the action in an extension app. - `actionInputKey` (string, optional) — A key that represents the input data required for verification. The value of this property determines the actual data type to be verified. The supported values are: - `countryCode` - `phoneNumber` - `street1` - `locality` - `subdivision` - `email` - `firstName` - `lastName` - `vin` - `ssn` - `countryOrRegion` - `fein` - `businessName` - `postalCode` - `accountNumber` - `accountType` - `routingNumber` - `dateOfBirth` - `stateOfRegistration` - `countryOfRegistration` - `actionName` (string, optional) — The name of an action used in an extension app. - `applicationId` (string, optional) — The unique ID of an extension app. - `applicationName` (string, optional) — The name of an extension app. - `connectedFieldsData` (connectedData, optional) - `connectionInstances` (list of connectionInstance, optional) — An object containing data that identifies an extension app's connection to the connected field. - `extensionContract` (string, optional) — The template that defines the extension in an extension app. This corresponds to the extension template value in the extension app's manifest file. - `extensionGroupId` (string, optional) — The unique ID of the group of extensions within an extension app. - `extensionName` (string, optional) — The name of the extension used in an extension app. - `extensionPolicy` (string, optional) — An envelope or account-level configuration that determines a document's signing policy. Set this to property value to `mustVerifyToSign` to require that this text tab must be validated by an extension app before the envelope can be completed. - `publisherName` (string, optional) — The name of the extension app publisher. - `requiredForExtension` (string, optional) — A boolean value that indicates whether a field must pass verification before a signer can sign a document. ### localePolicyTab Allows you to customize locale settings. - `addressFormat` (string, optional) — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` - `calendarType` (string, optional) — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` - `cultureName` (string, optional) — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. - `currencyCode` (string, optional) — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL` - `currencyNegativeFormat` (string, optional) — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar` `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89` `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89` `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89` `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym` `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar` `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym` `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89` `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89` `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567` `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89` `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar` `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89` `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89` `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89` `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89` `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89` `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym` `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym` `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar` `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar` `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym` `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89` `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar` `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar` `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar` `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar` `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar` `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar` `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar` `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar` `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar` `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar` `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar` `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567` `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89` `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89` `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567` `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567` `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89` `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89` `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89` `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym` `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89` `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym` `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus` `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89` `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar` `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89` `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89` `-$123 456 789,00` - `currencyPositiveFormat` (string, optional) — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89` `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89` `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym` `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym` `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89` `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567` `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89` `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89` `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89` `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym` `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89` `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89` `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym` `1 234 567,89$` - `CSym_1_Period_234_Period_567` `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym` `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89` `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89` `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym` `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89` `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym` `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89` `$123 456 789,00` (en-ZA, es-CR) - `customDateFormat` (string, optional) - `customTimeFormat` (string, optional) - `dateFormat` (string, optional) — Specifies the date format. Valid values: - `default` used the UI's - `longformat` use the UI's long format - `dd_mm_yy` dd-MM-yy - `dd_mmm_yy` dd-MMM-yy - `dd_mm_yyyy` dd-MM-yyyy - `dd_mmm_yyyy` dd-MMM-yyyy - `ddmmmmyyyy` dd MMMM yyyy - `ddmmyyyy` dd/MM/yyyy - `ddmmyyyy_de` dd.MM.yyyy - `dmyyyy` d/M/yyyy - `d_m_yyyy` d-M-yyyy - `mmmd_yyyy` MMM d, yyyy - `mmm_dd_yyyy` MMM-dd-yyyy - `mmmmd_yyyy` MMMM d, yyyy - `mm_dd_yyyy` MM-dd-yyyy - `mdyyyy` M/d/yyyy - `yyyy_mmm_dd` yyyy-MMM-dd - `yyyy_mm_dd` yyyy-MM-dd - `yyyymmdd` yyyy/MM/dd - `yyyymd` yyyy/M/d - `custom` Customer set own value - `mmddyyyy` MM/dd/yyyy - `mmddyy` MM/dd/yy - `yyyy_mmmm_d` yyyy MMMM d - `initialFormat` (string, optional) — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1` "WG" - `last2` "GA" - `first2` "WI" - `last2_cjk` first two characters from last name in CJK characters. - `nameFormat` (string, optional) — Describes how names are displayed. Valid values: - `first_middle_last` William Henry Gates - `full` Mr William Henry Gates III - `last_first` Gates William - `lastfirst` GatesWilliam - `last_first_cjk` Gates William only with CJK characters - `lastfirst_cjk` GatesWilliam only with CJK characters - `timeFormat` (string, optional) — Specifies the time format. Valid values: - `none` None - `hh_mm` hh:mm - `hhmm` HH:mm - `hhmmss` HH:mm:ss - `hhmmsstt` HH:mm:ss tt - `hhmmtt` HH:mm tt - `hmm` h:mm - `hmmss` h:mm:ss - `hmmsstt` h:mm:ss tt - `hmmtt` h:mm tt - `custom` Customer-set format - `timeZone` (string, optional) — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime` - `useLongCurrencyFormat` (string, optional) — When **true,** use the long currency format for the locale. ### mergeField Contains information for transferring values between Salesforce data fields and Docusign tabs. - `allowSenderToEdit` (string, optional) — When **true,** the sender can modify the value of the `mergeField` tab during the sending process. - `allowSenderToEditMetadata` (propertyMetadata, optional) — Metadata about a property. - `configurationType` (string, optional) — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `configurationTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `path` (string, optional) — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `pathExtended` (list of pathExtendedElement, optional) — Reserved for Docusign. - `pathExtendedMetadata` (propertyMetadata, optional) — Metadata about a property. - `pathMetadata` (propertyMetadata, optional) — Metadata about a property. - `row` (string, optional) — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `rowMetadata` (propertyMetadata, optional) — Metadata about a property. - `writeBack` (string, optional) — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. - `writeBackMetadata` (propertyMetadata, optional) — Metadata about a property. ### smartContractInformation - `code` (string, optional) — Reserved for Docusign. - `uri` (string, optional) — Reserved for Docusign. ### comment - `envelopeId` (string, optional) — The Guid of the envelope the comment thread belongs to. - `hmac` (string, optional) — Reserved for Docusign. - `id` (string, optional) — The unique identifier for the comment. - `mentions` (list of string, optional) — An array of userIds that are mentioned directly in the body of a comment. - `read` (boolean, optional) — When **true,** indicates that the comment was read. - `sentByEmail` (string, optional) — The email address of the user who created the comment. - `sentByFullName` (string, optional) — The full name of the user who created the comment. - `sentByImageId` (string, optional) — Reserved for Docusign. - `sentByInitials` (string, optional) — The initials of the user who created the comment. - `sentByRecipientId` (string, optional) — The recipient ID of the user who created the comment. - `sentByUserId` (string, optional) — The user ID of the user who created the comment. - `signingGroupId` (string, optional) — The ID of the signing group that can view the comment or that created the comment. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `subject` (string, optional) — The subject of the envelope. - `tabId` (string, optional) — The unique identifier for the tab that represents the comment thread. - `text` (string, optional) — The content of the comment, as UTF-8 text. Maximum Length: 500 characters. **Note:** The maximum size allowed for the entire message body is 32 KB. - `threadId` (string, optional) — The unique identifier for the comment thread. - `threadOriginatorId` (string, optional) — The userId of the user who created the thread. - `timestamp` (string, optional) — The time the comment was created. - `timeStampFormatted` (string, optional) — The time the comment was created, formatted according to the format of the user who created the comment. - `visibleTo` (list of string, optional) — The user IDs of the users that the comment is visible to. ### extendPaymentConfiguration - `appId` (string, optional) - `connectionInstanceId` (string, optional) - `currency` (string, optional) - `durationEnd` (string, optional) - `durationStart` (string, optional) - `lineItems` (list of extendPaymentLineItem, optional) - `paymentDueDays` (string, optional) - `paymentMethods` (list of string, optional) - `paymentMode` (string, optional) - `tabRole` (string, optional) ### 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](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment. Supported currencies are: - AUD: Australian dollar - CAD: Canadian dollar - EUR: Euro - GBP: Great Britain pound - USD: United States dollar Specifying any other ISO 4217 code for payments is an error. - `currencyCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `customerId` (string, optional) — The customer ID. - `customMetadata` (string, optional) — This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. The following example shows what the **Description** field of the transaction will look like: `, ` - `customMetadataRequired` (boolean, optional) — A sender-defined field that specifies whether custom metadata is required for the transaction. When **true,** custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account. - `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. - `gatewayAccountIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `gatewayDisplayName` (string, optional) — Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net, CyberSource, Zuora, Elavon. - `gatewayName` (string, optional) — Name of the gateway connected to sender's Docusign account. Possible values are: - `Stripe` - `Braintree` - `AuthorizeDotNet` - `CyberSource` - `Zuora` - `Elavon` - `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) — This property specifies how the signer's collected payment details will be used. Valid values: - `authorize`: The payment details will be used to collect payment. This is the default value. - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. - `paymentSourceId` (string, optional) — The payment source ID. - `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. - `future_payment_saved` The recipient's payment method has been saved to the sender's payment gateway. - `subGatewayName` (string, optional) - `total` (money, optional) — Describes information about the `total` of a payment. ### listItem One of the selectable items in the `listItems` property of a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab. - `selected` (string, optional) — When **true,** indicates that this item is the default selection shown to a signer. Only one selection can be set as the default. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `text` (string, optional) — Specifies the text that is shown in the dropdown list. - `textMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value that is used when the list item is selected. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. ### graphicsContext - `fillColor` (string, optional) — The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - `lineColor` (string, optional) — The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - `lineWeight` (string, optional) — The line weight or thickness to use for the overlay. ### polyLine - `x1` (string, optional) - `x2` (string, optional) - `y1` (string, optional) - `y2` (string, optional) ### senderCompany - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### senderName - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `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. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### radio One of the selectable radio buttons in the `radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `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 to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `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 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `selected` (string, optional) — When **true,** the radio button is selected. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `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. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### stamp - `adoptedDateTime` (string, optional) — The UTC date and time when the user adopted the signature. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `customField` (string, optional) - `dateStampProperties` (dateStampProperties, optional) — Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. - `disallowUserResizeStamp` (string, optional) — When **true,** users may not resize the stamp. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `externalID` (string, optional) — Optionally specify an external identifier for the user's signature. - `imageBase64` (string, optional) - `imageType` (string, optional) — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `phoneticName` (string, optional) — The phonetic spelling of the `signatureName`. - `signatureName` (string, optional) — Specifies the user's signature name. - `stampFormat` (string, optional) — The format of a stamp. Valid values are: - `NameHanko`: The stamp represents only the signer's name. - `NameDateHanko`: The stamp represents the signer's name and the date. - `stampImageUri` (string, optional) — The URI for retrieving the image of the user's stamp. - `stampSizeMM` (string, optional) — The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. - `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. ### smartSectionDisplaySettings These properties define how a Smart Section displays. A Smart Section is a type of display section. - `cellStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. - `collapsibleSettings` (smartSectionCollapsibleDisplaySettings, optional) - `display` (string, optional) — Indicates the display type. Must be one of the following enum values: - **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page. - **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded. - **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed. - **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. - **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked. - **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view. - `displayLabel` (string, optional) — The label to add to this display section in the signing page. - `displayOrder` (integer, optional) — The position on the page where the display section appears. - `displayPageNumber` (integer, optional) — The number of the page on which the display section appears. - `hideLabelWhenOpened` (boolean, optional) — When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. - `inlineOuterStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. - `labelWhenOpened` (string, optional) — The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. - `preLabel` (string, optional) — Enables you to add descriptive text that appears before a collapsed section or continue button. - `scrollToTopWhenOpened` (boolean, optional) — When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. - `tableStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. ### smartSectionAnchorPosition - `pageNumber` (integer, optional) — Specifies the page number on which the tab is located. - `xPosition` (double, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. 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. Must be an integer. May be zero. ### 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) — A Boolean value that specifies whether the information must 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) — A Boolean value that specifies whether the information must 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) — A Boolean value that specifies whether the information must 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 full Social Security Number (SSN). ### recipientIdentityInputOption - `name` (string, optional) - `phoneNumberList` (list of recipientIdentityPhoneNumber, optional) - `stringValue` (string, optional) - `valueType` (string, optional) ### eventResult Information about the result of an event. - `eventTimestamp` (string, optional) — Date/time of the event. - `failureDescription` (string, optional) — Reason for failure, if the event failed. - `status` (string, optional) — Event status. - `vendorFailureStatusCode` (string, optional) — Failure status code, if the event failed. ### recipientRules - `conditionalRecipients` (list of conditionalRecipientRule, optional) ### documentHtmlCollapsibleDisplaySettings Display settings for collapsible section. - `arrowClosed` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the closed state. One of the following: - `up`: In the closed state, the disclosure arrow points up. - `down`: In the closed state, the disclosure arrow points down. - `left`: In the closed state, the disclosure arrow points left. - `right`: In the closed state, the disclosure arrow points right. - `arrowColor` (string, optional) — A CSS color value (such as `#DCF851`) that indicates the color of the arrow. - `arrowLocation` (string, optional) — The location of the arrow relative to the collapsible section's label. Possible values are: - `right` (default) - `left` - `arrowOpen` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the open state. One of the following: - `up`: In the open state, the disclosure arrow points up. - `down`: In the open state, the disclosure arrow points down. - `left`: In the open state, the disclosure arrow points left. - `right`: In the open state, the disclosure arrow points right. - `arrowSize` (string, optional) — Indicates the size of the collapsible arrows. Possible values are: - `small` - `large` (default) - `arrowStyle` (string, optional) — The name of the CSS style to be used on collapsible arrow section. - `containerStyle` (string, optional) — The name of the CSS style to be used for the collapsible container. - `labelStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's label. - `onlyArrowIsClickable` (boolean, optional) — When **true,** only the arrow is clickable to expand or collapse the section. When **false** (the default), both the label and the arrow are clickable. If no arrow is used, this setting is ignored. - `outerLabelAndArrowStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's outer label and arrow style. ### connectedData - `propertyName` (string, optional) — An identifier describing input data for a connected field. - `supportedOperation` (string, optional) — The type of operation used to verify a connected field. - `supportedUri` (string, optional) — The URI used to verify a connected field. - `typeName` (string, optional) — The name of the verification type used in a connected field. - `typeSystemNamespace` (string, optional) — The type of operation used during verification. ### connectionInstance - `connectionKey` (string, optional) — A key used to identify the connection instance of an extension app. - `connectionValue` (string, optional) — The GUID value that identifies the connection instance of an extension app. ### pathExtendedElement - `name` (string, optional) - `type` (string, optional) — The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` - `typeName` (string, optional) ### extendPaymentLineItem - `amountReference` (string, optional) - `description` (string, optional) - `name` (string, optional) - `priceId` (string, optional) - `productId` (string, optional) - `quantity` (string, optional) - `type` (string, optional) - `unitAmount` (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) — This property specifies how the signer's collected payment details will be used. Valid values: - `authorize`: The payment details will be used to collect payment. This is the default value. - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. ### 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](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment. For example: - AUD Australian dollar - CAD Canadian dollar - EUR Euro - GBP Great Britain pound - USD United States dollar This is a read-only property. - `displayAmount` (string, 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. ### dateStampProperties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. - `dateAreaHeight` (string, optional) — The height of the rectangle. - `dateAreaWidth` (string, optional) — The width of the rectangle. - `dateAreaX` (string, optional) — The X axis position of the top-left corner. - `dateAreaY` (string, optional) — The Y axis position of the top-left corner. ### smartSectionCollapsibleDisplaySettings - `arrowClosed` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the closed state. One of the following: - `up`: In the closed state, the disclosure arrow points up. - `down`: In the closed state, the disclosure arrow points down. - `left`: In the closed state, the disclosure arrow points left. - `right`: In the closed state, the disclosure arrow points right. - `arrowColor` (string, optional) — A CSS color value (such as `#DCF851`) that indicates the color of the arrow. - `arrowLocation` (string, optional) — The location of the arrow relative to the collapsible section's label. Possible values are: - `right` (default) - `left` - `arrowOpen` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the open state. One of the following: - `up`: In the open state, the disclosure arrow points up. - `down`: In the open state, the disclosure arrow points down. - `left`: In the open state, the disclosure arrow points left. - `right`: In the open state, the disclosure arrow points right. - `arrowSize` (string, optional) — Indicates the size of the collapsible arrows. Possible values are: - `small` - `large` (default) - `arrowStyle` (string, optional) — The name of the CSS style to be used on collapsible arrow section. - `containerStyle` (string, optional) — The name of the CSS style to be used for the collapsible container. - `labelStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's label. - `onlyArrowIsClickable` (boolean, optional) — When **true,** only the arrow is clickable to expand or collapse the section. When **false** (the default), both the label and the arrow are clickable. If no arrow is used, this setting is ignored. - `outerLabelAndArrowStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's outer label and arrow style. ### addressInformation Contains address information. - `address1` (string, optional) — The first line of the user's address. Maximum length: 100 characters. - `address2` (string, optional) — The second line of the user's address. Maximum length: 100 characters. - `city` (string, optional) — The user's city. Maximum length: 40 characters. - `country` (string, optional) — The user's country. Maximum length: 50 characters. - `fax` (string, optional) — A Fax number associated with the address if one is available. - `phone` (string, optional) — A phone number associated with the address. - `postalCode` (string, optional) — The user's postal code. Maximum length: 20 characters. - `stateOrProvince` (string, optional) — The user's state or province. Maximum length: 40 characters. - `zipPlus4` (string, optional) ### recipientIdentityPhoneNumber - `countryCode` (string, optional) — The numeric country calling code for the phone number. For example, the country calling code for the US and Canada is 1. For the UK, the country calling code is 44. Do not include the + symbol. - `countryCodeLock` (string, optional) - `countryCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `extension` (string, optional) — The telephone extension, if any. - `extensionMetadata` (propertyMetadata, optional) — Metadata about a property. - `number` (string, optional) — The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters. Do not include the `countryCode`. For US, Canada, and other [North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`. - `numberMetadata` (propertyMetadata, optional) — Metadata about a property. ### conditionalRecipientRule A rule that defines a set of recipients and the conditions under which they will be used for the envelope. - `conditions` (list of conditionalRecipientRuleCondition, optional) — An array of conditions that define when the recipients will be used. - `order` (string, optional) — An integer that specifies the order in which rules are processed. Lower values are processed before higher values. - `recipientGroup` (recipientGroup, optional) — Describes a group of recipients. - `recipientId` (string, optional) — The ID of the recipient to whom the condition will be applied. This value should match the `recipientId` defined in the recipient object. ### conditionalRecipientRuleCondition - `filters` (list of conditionalRecipientRuleFilter, optional) - `order` (string, optional) — An integer that specifies the order in which rules are processed. Lower values are processed before higher values. - `recipientLabel` (string, optional) — An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/). ### recipientGroup Describes a group of recipients. - `groupMessage` (string, optional) — The group message, typically a description of the group. - `groupName` (string, optional) — The name of the group. - `recipients` (list of recipientOption, optional) — An array of recipient objects that provides details about the recipients of the envelope. ### conditionalRecipientRuleFilter - `operator` (string, optional) — How the tab value is compared to the `value` property. Valid values: - `equals` - `greaterThan` - `greaterThanEquals` - `lessThan` - `lessThanEquals` - `filled` - `selected` - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `scope` (string, optional) — The scope under which the condition is evaluated. Valid values: - `tabs` - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `value` (string, optional) — A set value to which the tab's actual value is compared. ### recipientOption Describes a recipient who is a member of a conditional group. - `email` (string, optional) — The email ID of the agent. This property is required. Maximum length: 100 characters. - `name` (string, optional) — The full legal name of the recipient. Maximum length: 100 characters. - `recipientLabel` (string, optional) — An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/). - `roleName` (string, optional) — Specifies the signing group role of the recipient. This property is required. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). ## Examples **Request** ```json { "accessControlListBase64": "sample string 1", "accessibility": "sample string 2", "allowComments": "sample string 3", "allowMarkup": "sample string 4", "allowReassign": "sample string 5", "allowRecipientRecursion": "sample string 6", "allowViewHistory": "sample string 7", "anySigner": "sample string 8", "asynchronous": "sample string 9", "attachments": [ { "accessControl": "sample string 1", "attachmentId": "sample string 2", "attachmentType": "sample string 3", "data": "sample string 4", "label": "sample string 5", "name": "sample string 6", "remoteUrl": "sample string 7" } ], "attachmentsUri": "sample string 10", "authoritativeCopy": "sample string 11", "authoritativeCopyDefault": "sample string 12", "autoNavigation": "sample string 13", "brandId": "sample string 14", "brandLock": "sample string 15", "burnDefaultTabData": "sample string 16", "certificateUri": "sample string 17", "completedDateTime": "sample string 18", "compositeTemplates": [ { "compositeTemplateId": "sample string 1", "document": { "applyAnchorTabs": "sample string 1", "assignTabsToRecipientId": "sample string 2", "authoritativeCopy": true, "display": "sample string 3", "docGenDocumentStatus": "sample string 4", "docGenFormFields": [ { "children": [ {} ], "defaultValue": "sample string 1", "description": "sample string 2", "fullyQualifiedPath": "sample string 3", "hidden": true, "label": "sample string 4", "name": "sample string 5", "options": [ {} ], "order": "sample string 6", "predefinedValidation": "sample string 7", "readOnly": true, "required": "sample string 8", "rowValues": [ {} ], "type": "sample string 9", "value": "sample string 10" } ], "documentBase64": "sample string 5", "documentFields": [ { "name": "sample string 1", "originalValue": "sample string 2", "value": "sample string 3" } ], "documentId": "sample string 6", "documentTemplateId": "sample string 7", "encryptedWithKeyManager": "sample string 8", "fileExtension": "sample string 9", "fileFormatHint": "sample string 10", "htmlDefinition": { "displayAnchorPrefix": "sample string 1", "displayAnchors": [ {} ], "displayOrder": "sample string 2", "displayPageNumber": "sample string 3", "documentGuid": "sample string 4", "documentId": "sample string 5", "headerLabel": "sample string 6", "maxScreenWidth": "sample string 7", "removeEmptyTags": "sample string 8", "showMobileOptimizedToggle": "sample string 9", "source": "sample string 10" }, "includeInDownload": "sample string 11", "isDocGenDocument": "sample string 12", "matchBoxes": [ { "height": "sample string 1", "pageNumber": "sample string 2", "width": "sample string 3", "xPosition": "sample string 4", "yPosition": "sample string 5" } ], "name": "sample string 13", "order": "sample string 14", "pages": "sample string 15", "password": "sample string 16", "pdfFormFieldOption": "sample string 17", "remoteUrl": "sample string 18", "signerMustAcknowledge": "sample string 19", "signerMustAcknowledgeUseAccountDefault": true, "tabs": { "approveTabs": [ {} ], "checkboxTabs": [ {} ], "commentThreadTabs": [ {} ], "commissionCountyTabs": [ {} ], "commissionExpirationTabs": [ {} ], "commissionNumberTabs": [ {} ], "commissionStateTabs": [ {} ], "companyTabs": [ {} ], "dateSignedTabs": [ {} ], "dateTabs": [ {} ], "declineTabs": [ {} ], "drawTabs": [ {} ], "emailAddressTabs": [ {} ], "emailTabs": [ {} ], "envelopeIdTabs": [ {} ], "firstNameTabs": [ {} ], "formulaTabs": [ {} ], "fullNameTabs": [ {} ], "initialHereTabs": [ {} ], "lastNameTabs": [ {} ], "listTabs": [ {} ], "notarizeTabs": [ {} ], "notarySealTabs": [ {} ], "noteTabs": [ {} ], "numberTabs": [ {} ], "numericalTabs": [ {} ], "phoneNumberTabs": [ {} ], "polyLineOverlayTabs": [ {} ], "radioGroupTabs": [ {} ], "signerAttachmentTabs": [ {} ], "signHereTabs": [ {} ], "smartSectionTabs": [ {} ], "ssnTabs": [ {} ], "tabGroups": [ {} ], "textTabs": [ {} ], "titleTabs": [ {} ], "viewTabs": [ {} ], "zipTabs": [ {} ] }, "templateLocked": "sample string 20", "templateRequired": "sample string 21", "transformPdfFields": "sample string 22", "uri": "sample string 23" }, "inlineTemplates": [ { "customFields": { "listCustomFields": [ {} ], "textCustomFields": [ {} ] }, "documents": [ {} ], "envelope": { "accessControlListBase64": "sample string 1", "allowComments": "sample string 2", "allowMarkup": "sample string 3", "allowReassign": "sample string 4", "allowViewHistory": "sample string 5", "anySigner": "sample string 6", "asynchronous": "sample string 7", "attachmentsUri": "sample string 8", "authoritativeCopy": "sample string 9", "authoritativeCopyDefault": "sample string 10", "autoNavigation": "sample string 11", "brandId": "sample string 12", "brandLock": "sample string 13", "burnDefaultTabData": "sample string 14", "certificateUri": "sample string 15", "completedDateTime": "sample string 16", "copyRecipientData": "sample string 17", "createdDateTime": "sample string 18", "customFieldsUri": "sample string 19", "declinedDateTime": "sample string 20", "deletedDateTime": "sample string 21", "deliveredDateTime": "sample string 22", "disableResponsiveDocument": "sample string 23", "documentBase64": "sample string 24", "documentsCombinedUri": "sample string 25", "documentsUri": "sample string 26", "emailBlurb": "sample string 27", "emailSubject": "sample string 28", "enableWetSign": "sample string 29", "enforceSignerVisibility": "sample string 30", "envelopeAttachments": [ {} ], "envelopeClassification": "sample string 31", "envelopeDocuments": [ {} ], "envelopeId": "sample string 32", "envelopeIdStamping": "sample string 33", "envelopeLocation": "sample string 34", "envelopeUri": "sample string 35", "expireAfter": "sample string 36", "expireDateTime": "sample string 37", "expireEnabled": "sample string 38", "externalEnvelopeId": "sample string 39", "folders": [ {} ], "hasComments": "sample string 40", "hasFormDataChanged": "sample string 41", "hasWavFile": "sample string 42", "holder": "sample string 43", "initialSentDateTime": "sample string 44", "is21CFRPart11": "sample string 45", "isDynamicEnvelope": "sample string 46", "isSignatureProviderEnvelope": "sample string 47", "isTicketRelatedEnvelope": "sample string 48", "lastModifiedDateTime": "sample string 49", "location": "sample string 50", "messageLock": "sample string 51", "notificationUri": "sample string 52", "purgeCompletedDate": "sample string 53", "purgeRequestDate": "sample string 54", "purgeState": "sample string 55", "recipientsLock": "sample string 56", "recipientsUri": "sample string 57", "sentDateTime": "sample string 58", "signerCanSignOnMobile": "sample string 59", "signingLocation": "sample string 60", "status": "sample string 61", "statusChangedDateTime": "sample string 62", "templatesUri": "sample string 63", "transactionId": "sample string 64", "useDisclosure": "sample string 65", "uSigState": "sample string 66", "voidedDateTime": "sample string 67", "voidedReason": "sample string 68", "watermarkLanguage": "sample string 69" }, "recipients": { "agents": [ {} ], "authorizedSignatories": [ {} ], "carbonCopies": [ {} ], "certifiedDeliveries": [ {} ], "currentRoutingOrder": "sample string 1", "editors": [ {} ], "inPersonSigners": [ {} ], "intermediaries": [ {} ], "notaries": [ {} ], "notaryWitnesses": [ {} ], "participants": [ {} ], "recipientCount": "sample string 2", "seals": [ {} ], "signers": [ {} ], "witnesses": [ {} ] }, "sequence": "sample string 1" } ], "pdfMetaDataTemplateSequence": "sample string 2", "serverTemplates": [ { "sequence": "sample string 1", "templateId": "sample string 2" } ] } ], "copyRecipientData": "sample string 19", "createdDateTime": "sample string 20", "customFieldsUri": "sample string 21", "declinedDateTime": "sample string 22", "deletedDateTime": "sample string 23", "deliveredDateTime": "sample string 24", "disableResponsiveDocument": "sample string 25", "documentBase64": "sample string 26", "documents": [ {} ], "documentsCombinedUri": "sample string 27", "documentsUri": "sample string 28", "emailBlurb": "sample string 29", "emailSettings": { "bccEmailAddresses": [ { "bccEmailAddressId": "sample string 1", "email": "sample string 2" } ], "replyEmailAddressOverride": "sample string 1", "replyEmailNameOverride": "sample string 2" }, "emailSubject": "sample string 30", "enableWetSign": "sample string 31", "enforceSignerVisibility": "sample string 32", "envelopeAttachments": [ {} ], "envelopeClassification": "sample string 33", "envelopeCustomMetadata": { "envelopeCustomMetadataDetails": [ {} ] }, "envelopeDocuments": [ { "addedRecipientIds": [ "sample string 1" ], "agreementType": "sample string 1", "agreementTypeSource": "sample string 2", "attachmentTabId": "sample string 3", "authoritativeCopy": "sample string 4", "authoritativeCopyMetadata": { "options": [ "sample string 1" ], "rights": "sample string 1" }, "availableDocumentTypes": [ { "isDefault": "sample string 1", "type": "sample string 2" } ], "containsPdfFormFields": "sample string 5", "display": "sample string 6", "docGenDocumentStatus": "sample string 7", "docGenErrors": [ { "errorCode": "sample string 1", "message": "sample string 2", "tagIdentifier": "sample string 3" } ], "docGenFormFields": [ {} ], "documentBase64": "sample string 8", "documentFields": [ {} ], "documentId": "sample string 9", "documentIdGuid": "sample string 10", "documentTemplateId": "sample string 11", "errorDetails": { "errorCode": "sample string 1", "message": "sample string 2" }, "hasDigitalSignature": "sample string 12", "includeInDownload": "sample string 13", "isAceGenDocument": "sample string 14", "isDocGenDocument": "sample string 15", "isEdited": "sample string 16", "isExternallyAvailable": "sample string 17", "isFlattened": "sample string 18", "name": "sample string 19", "order": "sample string 20", "pages": [ { "dpi": "sample string 1", "height": "sample string 2", "imageBytes": "sample string 3", "mimeType": "sample string 4", "pageId": "sample string 5", "sequence": "sample string 6", "width": "sample string 7" } ], "signerMustAcknowledge": "sample string 21", "sizeBytes": "sample string 22", "templateLocked": "sample string 23", "templateRequired": "sample string 24", "type": "sample string 25", "uri": "sample string 26" } ], "envelopeIdStamping": "sample string 35", "envelopeLocation": "sample string 36", "envelopeMetadata": { "allowAdvancedCorrect": "sample string 1", "allowCorrect": "sample string 2", "enableSignWithNotary": "sample string 3" }, "envelopeUri": "sample string 37", "eventNotification": { "deliveryMode": "sample string 1", "envelopeEvents": [ { "envelopeEventStatusCode": "sample string 1", "includeDocuments": "sample string 2" } ], "eventData": { "format": "sample string 1", "includeData": [ "sample string 1" ], "version": "sample string 2" }, "events": [ "sample string 1" ], "includeCertificateOfCompletion": "sample string 2", "includeCertificateWithSoap": "sample string 3", "includeDocumentFields": "sample string 4", "includeDocuments": "sample string 5", "includeEnvelopeVoidReason": "sample string 6", "includeHMAC": "sample string 7", "includeOAuth": "sample string 8", "includeSenderAccountAsCustomField": "sample string 9", "includeTimeZone": "sample string 10", "integratorManaged": "sample string 11", "loggingEnabled": "sample string 12", "recipientEvents": [ { "includeDocuments": "sample string 1", "recipientEventStatusCode": "sample string 2" } ], "requireAcknowledgment": "sample string 13", "signMessageWithX509Cert": "sample string 14", "soapNameSpace": "sample string 15", "url": "sample string 16", "useSoapInterface": "sample string 17" }, "eventNotifications": [ {} ], "expireAfter": "sample string 38", "expireDateTime": "sample string 39", "expireEnabled": "sample string 40", "externalEnvelopeId": "sample string 41", "folders": [ { "filter": { "actionRequired": "sample string 1", "expires": "sample string 2", "folderIds": "sample string 3", "fromDateTime": "sample string 4", "isTemplate": "sample string 5", "order": "sample string 6", "orderBy": "sample string 7", "searchTarget": "sample string 8", "searchText": "sample string 9", "status": "sample string 10", "toDateTime": "sample string 11" }, "folderId": "sample string 1", "folderItems": [ { "completedDateTime": "sample string 1", "createdDateTime": "sample string 2", "envelopeId": "sample string 3", "envelopeUri": "sample string 4", "expireDateTime": "sample string 5", "folderId": "sample string 6", "folderUri": "sample string 7", "is21CFRPart11": "sample string 8", "lastModifiedDateTime": "sample string 9", "ownerName": "sample string 10", "recipientsUri": "sample string 11", "senderCompany": "sample string 12", "senderEmail": "sample string 13", "senderName": "sample string 14", "senderUserId": "sample string 15", "sentDateTime": "sample string 16", "status": "sample string 17", "subject": "sample string 18", "templateId": "sample string 19", "templateUri": "sample string 20" } ], "folders": [ {} ], "hasAccess": "sample string 2", "hasSubFolders": "sample string 3", "itemCount": "sample string 4", "name": "sample string 5", "owner": { "accountId": "sample string 1", "accountName": "sample string 2", "activationAccessCode": "sample string 3", "email": "sample string 4", "ipAddress": "sample string 5", "loginStatus": "sample string 6", "membershipId": "sample string 7", "sendActivationEmail": "sample string 8", "uri": "sample string 9", "userId": "sample string 10", "userName": "sample string 11", "userStatus": "sample string 12", "userType": "sample string 13" }, "parentFolderId": "sample string 6", "parentFolderUri": "sample string 7", "subFolderCount": "sample string 8", "type": "sample string 9", "uri": "sample string 10" } ], "hasComments": "sample string 42", "hasFormDataChanged": "sample string 43", "hasWavFile": "sample string 44", "holder": "sample string 45", "initialSentDateTime": "sample string 46", "is21CFRPart11": "sample string 47", "isDynamicEnvelope": "sample string 48", "isSignatureProviderEnvelope": "sample string 49", "isTicketRelatedEnvelope": "sample string 50", "lastModifiedDateTime": "sample string 51", "location": "sample string 52", "lockInformation": { "lockDurationInSeconds": "sample string 1", "lockedByApp": "sample string 2", "lockedUntilDateTime": "sample string 3", "lockToken": "sample string 4", "lockType": "sample string 5", "useScratchPad": "sample string 6" }, "messageLock": "sample string 53", "notification": { "expirations": { "expireAfter": "sample string 1", "expireEnabled": "sample string 2", "expireWarn": "sample string 3" }, "reminders": { "maximumReminderCount": "sample string 1", "reminderDelay": "sample string 2", "reminderEnabled": "sample string 3", "reminderFrequency": "sample string 4", "smartReminderEnabled": "sample string 5" }, "useAccountDefaults": "sample string 1" }, "notificationUri": "sample string 54", "password": "sample string 55", "powerForm": { "createdBy": "sample string 1", "createdDateTime": "sample string 2", "emailBody": "sample string 3", "emailSubject": "sample string 4", "envelopes": [ {} ], "instructions": "sample string 5", "isActive": "sample string 6", "lastUsed": "sample string 7", "limitUseInterval": "sample string 8", "limitUseIntervalEnabled": "sample string 9", "limitUseIntervalUnits": "sample string 10", "maxUseEnabled": "sample string 11", "name": "sample string 12", "powerFormId": "sample string 13", "powerFormUrl": "sample string 14", "recipients": [ { "accessCode": "sample string 1", "accessCodeLocked": "sample string 2", "accessCodeRequired": "sample string 3", "email": "sample string 4", "emailLocked": "sample string 5", "idCheckConfigurationName": "sample string 6", "idCheckRequired": "sample string 7", "name": "sample string 8", "recipientType": "sample string 9", "roleName": "sample string 10", "routingOrder": "sample string 11", "templateRequiresIdLookup": "sample string 12", "userNameLocked": "sample string 13" } ], "senderName": "sample string 15", "senderUserId": "sample string 16", "signingMode": "sample string 17", "templateId": "sample string 18", "templateName": "sample string 19", "timesUsed": "sample string 20", "uri": "sample string 21", "usesRemaining": "sample string 22" }, "purgeCompletedDate": "sample string 56", "purgeRequestDate": "sample string 57", "purgeState": "sample string 58", "recipientsLock": "sample string 59", "recipientsUri": "sample string 60", "recipientViewRequest": { "assertionId": "sample string 1", "authenticationInstant": "sample string 2", "authenticationMethod": "sample string 3", "clientURLs": { "onAccessCodeFailed": "sample string 1", "onCancel": "sample string 2", "onDecline": "sample string 3", "onException": "sample string 4", "onFaxPending": "sample string 5", "onIdCheckFailed": "sample string 6", "onSessionTimeout": "sample string 7", "onSigningComplete": "sample string 8", "onTTLExpired": "sample string 9", "onViewingComplete": "sample string 10" }, "clientUserId": "sample string 4", "displayFormat": "sample string 5", "email": "sample string 6", "frameAncestors": [ "sample string 1" ], "messageOrigins": [ "sample string 1" ], "pingFrequency": "sample string 7", "pingUrl": "sample string 8", "recipientId": "sample string 9", "returnUrl": "sample string 10", "securityDomain": "sample string 11", "userId": "sample string 12", "userName": "sample string 13", "xFrameOptions": "sample string 14", "xFrameOptionsAllowFromUrl": "sample string 15" }, "sentDateTime": "sample string 61", "signerCanSignOnMobile": "sample string 62", "signingLocation": "sample string 63", "status": "sample string 64", "statusChangedDateTime": "sample string 65", "templateId": "sample string 66", "templateRoles": [ { "accessCode": "sample string 1", "additionalNotifications": [ { "phoneNumber": { "countryCode": "sample string 1", "number": "sample string 2" }, "secondaryDeliveryMethod": "sample string 1", "secondaryDeliveryStatus": "sample string 2" } ], "clientUserId": "sample string 2", "defaultRecipient": "sample string 3", "deliveryMethod": "sample string 4", "email": "sample string 5", "emailNotification": { "emailBody": "sample string 1", "emailSubject": "sample string 2", "supportedLanguage": "sample string 3" }, "embeddedRecipientStartURL": "sample string 6", "inPersonSignerName": "sample string 7", "name": "sample string 8", "recipientSignatureProviders": [ { "sealDocumentsWithTabsOnly": "sample string 1", "sealName": "sample string 2", "signatureProviderName": "sample string 3", "signatureProviderOptions": { "cpfNumber": "sample string 1", "oneTimePassword": "sample string 2", "signerRole": "sample string 3", "sms": "sample string 4" } } ], "roleName": "sample string 9", "routingOrder": "sample string 10", "signingGroupId": "sample string 11", "signingGroupName": "sample string 12", "signingGroupType": "sample string 13", "signingGroupUsers": [ {} ] } ], "templatesUri": "sample string 67", "transactionId": "sample string 68", "useDisclosure": "sample string 69", "uSigState": "sample string 70", "voidedDateTime": "sample string 71", "voidedReason": "sample string 72", "watermarkLanguage": "sample string 73", "workflow": { "currentWorkflowStepId": "sample string 1", "overwriteUpdateMode": "sample string 2", "resumeDate": "sample string 3", "scheduledSending": { "bulkListId": "sample string 1", "resumeDate": "sample string 2", "rules": [ { "delay": "sample string 1", "resumeDate": "sample string 2" } ], "status": "sample string 3" }, "workflowStatus": "sample string 4", "workflowSteps": [ { "action": "sample string 1", "completedDate": "sample string 2", "delayedRouting": { "resumeDate": "sample string 1", "rules": [ {} ], "status": "sample string 2" }, "itemId": "sample string 3", "status": "sample string 4", "triggeredDate": "sample string 5", "triggerOnItem": "sample string 6", "workflowStepId": "sample string 7" } ] } } ``` **Response** ```json { "envelopeDocuments": [ { "addedRecipientIds": [ "sample string 1" ], "agreementType": "sample string 1", "agreementTypeSource": "sample string 2", "attachmentTabId": "sample string 3", "authoritativeCopy": "sample string 4", "authoritativeCopyMetadata": { "options": [ "sample string 1" ], "rights": "sample string 1" }, "availableDocumentTypes": [ { "isDefault": "sample string 1", "type": "sample string 2" } ], "containsPdfFormFields": "sample string 5", "display": "sample string 6", "docGenDocumentStatus": "sample string 7", "docGenErrors": [ { "errorCode": "sample string 1", "message": "sample string 2", "tagIdentifier": "sample string 3" } ], "docGenFormFields": [ { "children": [ {} ], "connectedObjectDetails": { "recordId": "sample string 1" }, "defaultValue": "sample string 1", "description": "sample string 2", "format": { "expression": "sample string 1", "locale": "sample string 2" }, "fullyQualifiedPath": "sample string 3", "hidden": true, "label": "sample string 4", "name": "sample string 5", "options": [ { "description": "sample string 1", "label": "sample string 2", "selected": "sample string 3", "value": "sample string 4" } ], "order": "sample string 6", "predefinedValidation": "sample string 7", "readOnly": true, "required": "sample string 8", "rowValues": [ { "docGenFormFieldList": [ {} ] } ], "type": "sample string 9", "validation": { "errorMessage": "sample string 1", "expression": "sample string 2" }, "value": "sample string 10" } ], "documentBase64": "sample string 8", "documentFields": [ { "errorDetails": { "errorCode": "sample string 1", "message": "sample string 2" }, "name": "sample string 1", "originalValue": "sample string 2", "value": "sample string 3" } ], "documentId": "sample string 9", "documentIdGuid": "sample string 10", "documentTemplateId": "sample string 11", "hasDigitalSignature": "sample string 12", "includeInDownload": "sample string 13", "isAceGenDocument": "sample string 14", "isDocGenDocument": "sample string 15", "isEdited": "sample string 16", "isExternallyAvailable": "sample string 17", "isFlattened": "sample string 18", "name": "sample string 19", "order": "sample string 20", "pages": [ { "dpi": "sample string 1", "height": "sample string 2", "imageBytes": "sample string 3", "mimeType": "sample string 4", "pageId": "sample string 5", "sequence": "sample string 6", "width": "sample string 7" } ], "signerMustAcknowledge": "sample string 21", "sizeBytes": "sample string 22", "templateLocked": "sample string 23", "templateRequired": "sample string 24", "type": "sample string 25", "uri": "sample string 26" } ], "envelopeId": "sample string 1" } ```