--- title: "Deletes one or more PowerForms." method: DELETE path: "/v2.1/accounts/{accountId}/powerforms" tags: ["PowerForms"] --- # Deletes one or more PowerForms. `DELETE /v2.1/accounts/{accountId}/powerforms` This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`. ## Path parameters - `accountId` string, required ## Request body - PowerFormsRequest - `powerForms` PowerForm[] — An array of PowerForm objects. - `createdBy` string — The ID of the user who created the PowerForm. - `createdDateTime` string — The UTC DateTime when the item was created. - `emailBody` string — The body of the email message sent to the recipients. Maximum length: 10000 characters. - `emailSubject` string — 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` Envelope[] - `accessControlListBase64` string — Reserved for Docusign. - `allowComments` string — 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 — 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 — When **true,** the recipient can redirect an envelope to a more appropriate recipient. - `allowViewHistory` string — When **true,** recipients can view the history of the envelope. - `anySigner` string — Deprecated. This feature has been replaced by signing groups. - `asynchronous` string — 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 — Contains a URL for retrieving the attachments that are associated with the envelope. - `authoritativeCopy` string — 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 — 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 — When **true,** autonavigation is set for the recipient. - `brandId` string — The ID of the brand. - `brandLock` string — When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. - `burnDefaultTabData` string - `certificateUri` string — The URI for retrieving certificate information. - `completedDateTime` string — Specifies the date and time this item was completed. - `copyRecipientData` string - `createdDateTime` string — The UTC DateTime when the item was created. - `customFields` AccountCustomFields — An `accountCustomField` is an envelope custom field that you set at the account level. Applying custom fields enables account administrators to group and manage envelopes. - `listCustomFields` ListCustomField[] — An array of list custom fields. - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `fieldId` string — The ID of the custom field. - `listItems` string[] — 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 — The name of the custom field. - `required` string — When **true,** senders are required to select an option from the list before they can send the envelope. - `show` string — When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. - `value` string — The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list. - `textCustomFields` TextCustomField[] — An array of text custom fields. - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `fieldId` string — The ID of the custom field. - `name` string — The name of the custom field. - `required` string — When **true,** senders are required to enter or select information for the field before they can send the envelope. - `show` string — When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope. - `value` string — The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters. - `customFieldsUri` string — The URI for retrieving custom fields. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `deletedDateTime` string — Reserved for Docusign. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `disableResponsiveDocument` string — When **true,** responsive documents are disabled for the envelope. - `documentBase64` string — 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. - `documentsCombinedUri` string — The URI for retrieving all of the documents associated with the envelope as a single PDF file. - `documentsUri` string — The URI for retrieving all of the documents associated with the envelope as separate files. - `emailBlurb` string — This is the same as the email body. If specified it is included in email body for all envelope recipients. - `emailSettings` 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` BccEmailAddress[] — 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 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. - `bccEmailAddressId` string — 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 — 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. - `replyEmailAddressOverride` string — 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 — 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. - `emailSubject` string — 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 — When **true,** the signer is allowed to print the document and sign it on paper. - `enforceSignerVisibility` string — When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] 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][docviz] 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][support] or your account manager to find out whether document visibility is available for your production account plan. [docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/ [sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending [fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html [support]: https://support.docusign.com/en/contactSupport# - `envelopeAttachments` Attachment[] — An array of attachment objects that provide information about the attachments that are associated with the envelope. - `accessControl` string — Valid values are `sender` and `senderAndAllRecipients`. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` string — 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 — The name of the attachment. - `remoteUrl` string — 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. - `envelopeCustomMetadata` EnvelopeCustomMetadata - `envelopeCustomMetadataDetails` NameValue[] - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `name` string — The name of the item. - `originalValue` string — The initial value of the item. - `value` string — The current value of the item. - `envelopeDocuments` EnvelopeDocument[] — An array containing information about the documents that are included in the envelope. - `addedRecipientIds` string[] — If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only. - `agreementType` string - `agreementTypeSource` string - `attachmentTabId` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `availableDocumentTypes` SignatureType[] - `isDefault` string — When **true,** the signature type is the default type. - `type` string — 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/). - `containsPdfFormFields` string — When **true,** the document has editable form fields that are made available through a PDF format. - `display` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `docGenDocumentStatus` string - `docGenErrors` DocGenSyntaxError[] - `errorCode` string — A code associated with the error condition. - `message` string — The error message. - `tagIdentifier` string — 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. - `docGenFormFields` DocGenFormField[] - `connectedObjectDetails` ConnectedObjectDetails - `recordId` string - `defaultValue` string - `description` string — A description of the field. Displayed with the label. - `filter` string — An object used to present a filtered view of the items in a folder. - `format` DocGenFormat - `expression` string - `locale` string — The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es` - `fullyQualifiedPath` string - `hidden` string - `label` string — A label displayed near the field. - `name` string — The name of the sender field. Required for PUT requests. - `options` DocGenFormFieldOption[] — When `type` is `Select`, this array describes the available options. - `description` string — Description of the selectable option. - `label` string — The label for the selectable option. - `selected` string — When **true,** the option is selected. - `value` string — Specifies the value of the option. This is the value of the form field when this option is selected. - `order` string — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order. - `predefinedValidation` string — Reserved for Docusign. - `readOnly` string - `required` string — When **true,** the field is required. - `rowValues` DocGenFormFieldRowValue[] — 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. - `docGenFormFieldList` DocGenFormField[] — 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. - `type` string — The kind of data the sender field holds. Valid values: - `TextBox` - `Date` - `Number` - `Select` - `TableRow` - `validation` DocGenFormFieldValidation — Describes how values are validated. - `errorMessage` string — The error message when validation fails. - `expression` string — The expression used to validate values. - `value` string — 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). - `documentBase64` string — The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. - `documentFields` NameValue[] — An object containing information about the custom fields on the document. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `name` string — The name of the item. - `originalValue` string — The initial value of the item. - `value` string — The current value of the item. - `documentId` string — The ID of the document that the tab is placed on. This value must refer to the ID of an existing document. - `documentIdGuid` string — The GUID of the document. - `documentTemplateId` string - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `hasDigitalSignature` string - `includeInDownload` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `isAceGenDocument` string - `isDocGenDocument` string - `isEdited` string - `isExternallyAvailable` string - `isFlattened` string - `name` string — The document's file name. Example: `Q1-Report.docx` - `nameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `order` string — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order. - `pages` Page[] — An array of page objects that contain information about the pages in the document. - `dpi` string — The number of dots per inch used for the page image. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `height` string — The height of the page in pixels. Must be an integer. - `imageBytes` string — The number of image bytes. - `mimeType` string — The MIME type. - `pageId` string — The ID of the page. - `sequence` string — The sequence of the page in the document, or page number. - `width` string — The width of the page in pixels. Must be an integer. - `signerMustAcknowledge` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sizeBytes` string - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `type` string — 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 — The URI for retrieving the document. - `envelopeId` string — The envelope ID of the envelope status that failed to post. - `envelopeIdStamping` string — 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 — Reserved for Docusign. - `envelopeMetadata` EnvelopeMetadata - `allowAdvancedCorrect` string — 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 — 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 — Specifies if Docusign eNotary service is enabled for the envelope. - `envelopeUri` string — The URI for retrieving the envelope or envelopes. - `expireAfter` string — 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 — 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 — 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 — May contain an external identifier for the envelope. - `folders` Folder[] — A list of folder objects. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `filter` Filter — Use this object to create a filtered view of the items in a folder. - `actionRequired` string — When **true,** the current user needs to take action on the item. - `expires` string — The number of days a sent envelope remains active before it expires. - `folderIds` string — 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 — 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 — When **true,** the item is a template. - `order` string — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order. - `orderBy` string — The field used to sort the results. Example: `Created` - `searchTarget` string — Reserved for Docusign. - `searchText` string — 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 — 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 — The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date. - `folderId` string — The ID of the folder. - `folderItems` FolderItemV2[] — A list of envelopes and templates that the folder contains. - `completedDateTime` string — If the item is an envelope, this is the UTC DateTime when the envelope was completed. - `createdDateTime` string — The UTC DateTime when the item was created. - `envelopeId` string — If the item is an envelope, this is the ID of the envelope. - `envelopeUri` string — If the item is an envelope, this is the URI for retrieving it. - `expireDateTime` string — The date and time the envelope is set to expire. - `folderId` string — The ID of the folder. - `folderUri` string — If the item is a subfolder, this is the URI for retrieving it. - `is21CFRPart11` string — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `lastModifiedDateTime` string — The date and time that the item was last modified. - `ownerName` string — The name of the user who owns the folder. - `recipients` EnvelopeRecipients — Envelope recipients - `agents` Agent[] — A list of agent recipients assigned to the documents. - … - `authorizedSignatories` AuthorizedSignatory[] - … - `carbonCopies` CarbonCopy[] — A list of carbon copy recipients assigned to the documents. - … - `certifiedDeliveries` CertifiedDelivery[] — 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 — 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` Editor[] — A list of users who can edit the envelope. - … - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `inPersonSigners` InPersonSigner[] — 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` Intermediary[] — 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` NotaryRecipient[] — A list of notary recipients on the envelope. - … - `notaryWitnesses` NotaryWitness[] - … - `participants` Participant[] - … - `recipientCount` string — The number of recipients in the envelope. - `seals` SealSign[] — A list of electronic seals to apply to documents. - … - `signers` Signer[] — A list of signers on the envelope. - … - `witnesses` Witness[] — A list of signers who act as witnesses on the envelope. - … - `recipientsUri` string — Contains a URI for an endpoint that you can use to retrieve the recipients. - `senderCompany` string — The name of the sender's company. - `senderEmail` string — The sender's email address. - `senderName` string — The sender's name. - `senderUserId` string — The sender's id. - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `status` string — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `subject` string — The subject of the envelope. - `templateId` string — The unique identifier of the template. If this is not provided, Docusign will generate a value. - `templateUri` string — The URI for retrieving the template. - `folders` Folder[] — A collection of folder objects returned in a response. - `hasAccess` string — When **true,** the current user has access to the folder. - `hasSubFolders` string — When **true,** the folder has subfolders. - `itemCount` string — The number of items in the folder. - `name` string — The name of the folder. - `owner` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `parentFolderId` string — The ID of the parent folder, or the special value `root` for the root folder. - `parentFolderUri` string — The URI of the parent folder. - `subFolderCount` string — The number of subfolders. - `type` string — 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 — The URI for the folder. - `hasComments` string — When **true,** indicates that users have added comments to the envelope. - `hasFormDataChanged` string — When **true,** indicates that the data collected through form fields on a document has changed. - `hasWavFile` string — When **true,** indicates that a .wav file used for voice authentication is included in the envelope. - `holder` string — Reserved for Docusign. - `initialSentDateTime` string — The date and time the envelope was initially sent. - `is21CFRPart11` string — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `isDynamicEnvelope` string — When **true,** indicates that the envelope is a dynamic envelope. - `isSignatureProviderEnvelope` string — When **true,** indicates that the envelope is a signature-provided envelope. - `isTicketRelatedEnvelope` string - `lastModifiedDateTime` string — The date and time that the item was last modified. - `location` string — Reserved for Docusign. - `lockInformation` EnvelopeLocks — Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `lockDurationInSeconds` string — The number of seconds until the lock expires when there is no activity on the envelope. The default value is 300 seconds. The maximum value is 1,800 seconds. The lock duration can be extended. - `lockedByApp` string — 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 - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `lockedUntilDateTime` string — The date and time that the lock expires. - `lockToken` string — 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 — The type of lock. Currently `edit` is the only supported type. - `useScratchPad` string — When **true,** a scratchpad is used to edit information. - `messageLock` string — 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 — A complex element that specifies the notification settings for the envelope. - `expirations` 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 — 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 — 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). - `expireWarn` string — 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` Reminders — A complex element that specifies reminder settings for the envelope. - `maximumReminderCount` string - `reminderDelay` string — 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 — When **true,** reminders are enabled. The default value is **false.** - `reminderFrequency` string — An integer specifying the interval in days between reminder emails. The default value is 0. - `smartReminderEnabled` string - `useAccountDefaults` string — 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.** - `notificationUri` string — The URI for retrieving notifications. - `powerForm` PowerForm — recursive - `purgeCompletedDate` string — The date that a purge was completed. - `purgeRequestDate` string — The date that a purge was requested. - `purgeState` string — 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` EnvelopeRecipients — Envelope recipients - `agents` Agent[] — A list of agent recipients assigned to the documents. - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - … - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - … - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `allowSystemOverrideForLockedRecipient` string — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` string — 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 - `clientUserId` string — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. 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 — 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` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `customFields` string[] — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string — The email ID of the agent. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - … - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - … - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - … - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - … - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - … - `ssn4InformationInput` Ssn4InformationInput - … - `ssn9InformationInput` Ssn9InformationInput - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - … - `workflowId` string — 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 — Metadata about a property. - … - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — The recipient's last name. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `note` string — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - … - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - … - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - … - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - … - `number` string — 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 — Metadata about a property. - … - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` string — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - … - `ageVerifyResult` EventResult — Information about the result of an event. - … - `anySocialIDResult` EventResult — Information about the result of an event. - … - `facebookResult` EventResult — Information about the result of an event. - … - `googleResult` EventResult — Information about the result of an event. - … - `identityVerificationResult` EventResult — Information about the result of an event. - … - `idLookupResult` EventResult — Information about the result of an event. - … - `idQuestionsResult` EventResult — Information about the result of an event. - … - `linkedinResult` EventResult — Information about the result of an event. - … - `liveIDResult` EventResult — Information about the result of an event. - … - `ofacResult` EventResult — Information about the result of an event. - … - `openIDResult` EventResult — Information about the result of an event. - … - `phoneAuthResult` EventResult — Information about the result of an event. - … - `salesforceResult` EventResult — Information about the result of an event. - … - `signatureProviderResult` EventResult — Information about the result of an event. - … - `smsAuthResult` EventResult — Information about the result of an event. - … - `sTANPinResult` EventResult — Information about the result of an event. - … - `twitterResult` EventResult — Information about the result of an event. - … - `yahooResult` EventResult — Information about the result of an event. - … - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `roleName` string — Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` string — Reserved for Docusign. - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — 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 — The code associated with the recipient's status. This property is read-only. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `authorizedSignatories` AuthorizedSignatory[] - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - … - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - … - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `agentCanEditEmail` string — 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 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 — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` string — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` string — 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 — Reserved for Docusign. - `bulkSendV2Recipient` string - `canSignOffline` string — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` string — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. 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 — 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` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `creationReason` string — The reason why the item was created. - `customFields` string[] — An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` string — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` DelegationInfo - `email` string - `name` string - `userAuthorizationId` string - `userId` string — 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. - `delegatedTo` DelegationInfo[] - `email` string - `name` string - `userAuthorizationId` string - `userId` string — 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. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - … - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - … - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - … - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - … - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - … - `ssn4InformationInput` Ssn4InformationInput - … - `ssn9InformationInput` Ssn9InformationInput - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - … - `workflowId` string — 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 — Metadata about a property. - … - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — Reserved for Docusign. - `isBulkRecipientMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lastName` string — The user's last name. Maximum Length: 50 characters. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string - `nameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `notaryId` string - `notarySignerEmailSent` string - `note` string — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `offlineAttributes` OfflineAttributes — Reserved for Docusign. - `accountEsignId` string — Reserved for Docusign. - `deviceModel` string — Reserved for Docusign. - `deviceName` string — Reserved for Docusign. - `gpsLatitude` string — Reserved for Docusign. - `gpsLongitude` string — Reserved for Docusign. - `offlineSigningHash` string — Reserved for Docusign. - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - … - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - … - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - … - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - … - `number` string — 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 — Metadata about a property. - … - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` string — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - … - `ageVerifyResult` EventResult — Information about the result of an event. - … - `anySocialIDResult` EventResult — Information about the result of an event. - … - `facebookResult` EventResult — Information about the result of an event. - … - `googleResult` EventResult — Information about the result of an event. - … - `identityVerificationResult` EventResult — Information about the result of an event. - … - `idLookupResult` EventResult — Information about the result of an event. - … - `idQuestionsResult` EventResult — Information about the result of an event. - … - `linkedinResult` EventResult — Information about the result of an event. - … - `liveIDResult` EventResult — Information about the result of an event. - … - `ofacResult` EventResult — Information about the result of an event. - … - `openIDResult` EventResult — Information about the result of an event. - … - `phoneAuthResult` EventResult — Information about the result of an event. - … - `salesforceResult` EventResult — Information about the result of an event. - … - `signatureProviderResult` EventResult — Information about the result of an event. - … - `smsAuthResult` EventResult — Information about the result of an event. - … - `sTANPinResult` EventResult — Information about the result of an event. - … - `twitterResult` EventResult — Information about the result of an event. - … - `yahooResult` EventResult — Information about the result of an event. - … - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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` RecipientSignatureProvider[] — The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `sealDocumentsWithTabsOnly` string — By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document. To apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. - `sealName` string — Indicates the name of the electronic seal to apply on documents. - `signatureProviderName` string — The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. 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` - `signatureProviderNameMetadata` PropertyMetadata — Metadata about a property. - … - `signatureProviderOptions` 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/) - … - `recipientSuppliesTabs` string — When **true,** specifies that the recipient creates the tabs. - `recipientType` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireSignerCertificate` string — By default, Docusign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate. - `requireSignOnPaper` string — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` string — 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 element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signatureInfo` RecipientSignatureInformation — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `fontStyle` string — 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 — Specifies the user's signature in initials format. - `signatureName` string — Specifies the user's signature name. - `signedDateTime` string — Reserved for Docusign. - `signInEachLocation` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). **Note:** When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, Docusign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy. - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — The status of the item. - `statusCode` string — Reserved for Docusign. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` EnvelopeRecipientTabs — All of the tabs associated with a recipient. Each property is a list of a type of tab. - `approveTabs` Approve[] — A list of [Approve tabs][approve]. 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. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `checkboxTabs` Checkbox[] — A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `commentThreadTabs` CommentThread[] — 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` CommissionCounty[] — A list of [Commission County tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `commissionExpirationTabs` CommissionExpiration[] — A list of [Commission Expiration tabs][tabref]. 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][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `commissionNumberTabs` CommissionNumber[] — A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `commissionStateTabs` CommissionState[] — A list of [Commission State tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `companyTabs` Company[] — A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company - … - `dateSignedTabs` DateSigned[] — A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `dateTabs` Date[] — A list of Date tabs. A Date tab enables the recipient to enter a date either by typing or using a date-picker. If you provide a `value` for this tab, it becomes read-only. The tooltip shown to the signer will always show MM/DD/YYYY, but you can specify three different [regular expression](https://en.wikipedia.org/wiki/Regular_expression) (regex) validation patterns for the date by setting the `validationPattern` property. Your three choices are: * DD/MM/YYYY: (((0[1-9])|([12][0-9])|(3[01]))) * MM/DD/YYYY: (((|0)[1-9]|1[0-2])/((|0)[1-9]|[1-2][0-9]|3[0-1])/[0-9]{4}$) * YYYY/DD/MM: ([0-9]{4}/((|0)[1-9]|1[0-2])/((|0)[1-9]|[1-2][0-9]|3[0-1]) - … - `declineTabs` Decline[] — A list of [Decline tabs][decline]. 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. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `drawTabs` Draw[] — A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. - … - `emailAddressTabs` EmailAddress[] — A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `emailTabs` Email[] — A list of [Email tabs][email]. 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. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `envelopeIdTabs` EnvelopeId[] — A list of [Envelope ID tabs][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. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid - … - `firstNameTabs` FirstName[] — A list of [First Name tabs][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. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname - … - `formulaTabs` FormulaTab[] — A list of [Formula tabs][formulaTab]. The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. 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][calculatedfields]. 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][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `fullNameTabs` FullName[] — A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `initialHereTabs` InitialHere[] — A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `lastNameTabs` LastName[] — A list of [Last Name tabs][lastName]. 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. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `listTabs` List[] — 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][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `notarizeTabs` Notarize[] — A list of [Notarize tabs][notarize]. 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. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `notarySealTabs` NotarySeal[] — 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][notary]. [notary]: /docs/notary-api/ - … - `noteTabs` Note[] — A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `numberTabs` Number[] — 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). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `numericalTabs` Numerical[] — 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` PhoneNumber[] — A list of [Phone Number tabs][cc]. 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]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `polyLineOverlayTabs` PolyLineOverlay[] — This type of tab enables the recipient to strike through document text. This value can't be set. - … - `prefillTabs` 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/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - … - `radioGroupTabs` RadioGroup[] — A list of [Radio Group tabs][radioGroup]. 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. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `signerAttachmentTabs` SignerAttachment[] — A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `signHereTabs` SignHere[] — A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `smartSectionTabs` SmartSection[] — 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` Ssn[] — A list of [SSN tabs][ssn]. 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. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `tabGroups` TabGroup[] — 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` Text[] — 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][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `titleTabs` Title[] — A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `viewTabs` View[] — A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `zipTabs` Zip[] — A list of [Zip tabs][zip]. 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. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `carbonCopies` CarbonCopy[] — A list of carbon copy recipients assigned to the documents. - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - … - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - … - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `agentCanEditEmail` string — 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 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 — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` string — 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 - `clientUserId` string — Not applicable for Carbon Copy recipients. - `completedCount` string — Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. - `consentDetailsList` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `customFields` string[] — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string — The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - … - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - … - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - … - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - … - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - … - `ssn4InformationInput` Ssn4InformationInput - … - `ssn9InformationInput` Ssn9InformationInput - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - … - `workflowId` string — 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 — Metadata about a property. - … - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — The recipient's last name. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `linkedAccountConfigurationId` string - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `note` string — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - … - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - … - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - … - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - … - `number` string — 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 — Metadata about a property. - … - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` string — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - … - `ageVerifyResult` EventResult — Information about the result of an event. - … - `anySocialIDResult` EventResult — Information about the result of an event. - … - `facebookResult` EventResult — Information about the result of an event. - … - `googleResult` EventResult — Information about the result of an event. - … - `identityVerificationResult` EventResult — Information about the result of an event. - … - `idLookupResult` EventResult — Information about the result of an event. - … - `idQuestionsResult` EventResult — Information about the result of an event. - … - `linkedinResult` EventResult — Information about the result of an event. - … - `liveIDResult` EventResult — Information about the result of an event. - … - `ofacResult` EventResult — Information about the result of an event. - … - `openIDResult` EventResult — Information about the result of an event. - … - `phoneAuthResult` EventResult — Information about the result of an event. - … - `salesforceResult` EventResult — Information about the result of an event. - … - `signatureProviderResult` EventResult — Information about the result of an event. - … - `smsAuthResult` EventResult — Information about the result of an event. - … - `sTANPinResult` EventResult — Information about the result of an event. - … - `twitterResult` EventResult — Information about the result of an event. - … - `yahooResult` EventResult — Information about the result of an event. - … - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `roleName` string — Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` string — Reserved for Docusign. - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — 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 — The code associated with the recipient's status. This property is read-only. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` EnvelopeRecipientTabs — All of the tabs associated with a recipient. Each property is a list of a type of tab. - `approveTabs` Approve[] — A list of [Approve tabs][approve]. 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. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `checkboxTabs` Checkbox[] — A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `commentThreadTabs` CommentThread[] — 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` CommissionCounty[] — A list of [Commission County tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `commissionExpirationTabs` CommissionExpiration[] — A list of [Commission Expiration tabs][tabref]. 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][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `commissionNumberTabs` CommissionNumber[] — A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `commissionStateTabs` CommissionState[] — A list of [Commission State tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `companyTabs` Company[] — A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company - … - `dateSignedTabs` DateSigned[] — A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `dateTabs` Date[] — A list of Date tabs. A Date tab enables the recipient to enter a date either by typing or using a date-picker. If you provide a `value` for this tab, it becomes read-only. The tooltip shown to the signer will always show MM/DD/YYYY, but you can specify three different [regular expression](https://en.wikipedia.org/wiki/Regular_expression) (regex) validation patterns for the date by setting the `validationPattern` property. Your three choices are: * DD/MM/YYYY: (((0[1-9])|([12][0-9])|(3[01]))) * MM/DD/YYYY: (((|0)[1-9]|1[0-2])/((|0)[1-9]|[1-2][0-9]|3[0-1])/[0-9]{4}$) * YYYY/DD/MM: ([0-9]{4}/((|0)[1-9]|1[0-2])/((|0)[1-9]|[1-2][0-9]|3[0-1]) - … - `declineTabs` Decline[] — A list of [Decline tabs][decline]. 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. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `drawTabs` Draw[] — A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. - … - `emailAddressTabs` EmailAddress[] — A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `emailTabs` Email[] — A list of [Email tabs][email]. 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. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `envelopeIdTabs` EnvelopeId[] — A list of [Envelope ID tabs][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. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid - … - `firstNameTabs` FirstName[] — A list of [First Name tabs][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. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname - … - `formulaTabs` FormulaTab[] — A list of [Formula tabs][formulaTab]. The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. 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][calculatedfields]. 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][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `fullNameTabs` FullName[] — A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `initialHereTabs` InitialHere[] — A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `lastNameTabs` LastName[] — A list of [Last Name tabs][lastName]. 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. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `listTabs` List[] — 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][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `notarizeTabs` Notarize[] — A list of [Notarize tabs][notarize]. 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. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `notarySealTabs` NotarySeal[] — 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][notary]. [notary]: /docs/notary-api/ - … - `noteTabs` Note[] — A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `numberTabs` Number[] — 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). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `numericalTabs` Numerical[] — 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` PhoneNumber[] — A list of [Phone Number tabs][cc]. 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]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - … - `polyLineOverlayTabs` PolyLineOverlay[] — This type of tab enables the recipient to strike through document text. This value can't be set. - … - `prefillTabs` 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/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - … - `radioGroupTabs` RadioGroup[] — A list of [Radio Group tabs][radioGroup]. 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. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `signerAttachmentTabs` SignerAttachment[] — A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `signHereTabs` SignHere[] — A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `smartSectionTabs` SmartSection[] — 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` Ssn[] — A list of [SSN tabs][ssn]. 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. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `tabGroups` TabGroup[] — 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` Text[] — 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][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `titleTabs` Title[] — A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `viewTabs` View[] — A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `zipTabs` Zip[] — A list of [Zip tabs][zip]. 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. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - … - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `certifiedDeliveries` CertifiedDelivery[] — 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. - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - … - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - … - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `agentCanEditEmail` string — 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 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 — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` string — 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 - `clientUserId` string — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. 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 — 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` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `customFields` string[] — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string — The recipient's email address. - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - … - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - … - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - … - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - … - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - … - `ssn4InformationInput` Ssn4InformationInput - … - `ssn9InformationInput` Ssn9InformationInput - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - … - `workflowId` string — 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 — Metadata about a property. - … - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — The recipient's last name. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `note` string — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - … - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - … - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - … - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - … - `number` string — 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 — Metadata about a property. - … - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` string — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - … - `ageVerifyResult` EventResult — Information about the result of an event. - … - `anySocialIDResult` EventResult — Information about the result of an event. - … - `facebookResult` EventResult — Information about the result of an event. - … - `googleResult` EventResult — Information about the result of an event. - … - `identityVerificationResult` EventResult — Information about the result of an event. - … - `idLookupResult` EventResult — Information about the result of an event. - … - `idQuestionsResult` EventResult — Information about the result of an event. - … - `linkedinResult` EventResult — Information about the result of an event. - … - `liveIDResult` EventResult — Information about the result of an event. - … - `ofacResult` EventResult — Information about the result of an event. - … - `openIDResult` EventResult — Information about the result of an event. - … - `phoneAuthResult` EventResult — Information about the result of an event. - … - `salesforceResult` EventResult — Information about the result of an event. - … - `signatureProviderResult` EventResult — Information about the result of an event. - … - `smsAuthResult` EventResult — Information about the result of an event. - … - `sTANPinResult` EventResult — Information about the result of an event. - … - `twitterResult` EventResult — Information about the result of an event. - … - `yahooResult` EventResult — Information about the result of an event. - … - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `roleName` string — Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` string — Reserved for Docusign. - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — 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 — The code associated with the recipient's status. This property is read-only. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `currentRoutingOrder` string — 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` Editor[] — A list of users who can edit the envelope. - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - … - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - … - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `allowSystemOverrideForLockedRecipient` string — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` string — 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 - `clientUserId` string — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. 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 — 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` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `customFields` string[] — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string — The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - … - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - … - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - … - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - … - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - … - `ssn4InformationInput` Ssn4InformationInput - … - `ssn9InformationInput` Ssn9InformationInput - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - … - `workflowId` string — 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 — Metadata about a property. - … - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — The recipient's last name. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `note` string — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - … - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - … - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - … - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - … - `number` string — 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 — Metadata about a property. - … - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` string — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - … - `ageVerifyResult` EventResult — Information about the result of an event. - … - `anySocialIDResult` EventResult — Information about the result of an event. - … - `facebookResult` EventResult — Information about the result of an event. - … - `googleResult` EventResult — Information about the result of an event. - … - `identityVerificationResult` EventResult — Information about the result of an event. - … - `idLookupResult` EventResult — Information about the result of an event. - … - `idQuestionsResult` EventResult — Information about the result of an event. - … - `linkedinResult` EventResult — Information about the result of an event. - … - `liveIDResult` EventResult — Information about the result of an event. - … - `ofacResult` EventResult — Information about the result of an event. - … - `openIDResult` EventResult — Information about the result of an event. - … - `phoneAuthResult` EventResult — Information about the result of an event. - … - `salesforceResult` EventResult — Information about the result of an event. - … - `signatureProviderResult` EventResult — Information about the result of an event. - … - `smsAuthResult` EventResult — Information about the result of an event. - … - `sTANPinResult` EventResult — Information about the result of an event. - … - `twitterResult` EventResult — Information about the result of an event. - … - `yahooResult` EventResult — Information about the result of an event. - … - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `roleName` string — Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` string — Reserved for Docusign. - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - … - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — 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 — The code associated with the recipient's status. This property is read-only. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `inPersonSigners` InPersonSigner[] — 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. - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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 — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` string — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` string — 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 - `canSignOffline` string — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` string — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. 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 — 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 — The reason why the recipient was created (for example, `sender`). This property is read-only. - `customFields` string[] — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` string — When **true,** this is the default recipient for the envelope. This option is used when creating an envelope from a template. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string — The signer's email address in an eNotary flow. Use only when `inPersonSigningType` is `notary`. For regular in-person-signer flow, use `signerEmail` instead. - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - … - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - … - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - … - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `hostEmail` string — The email address of the signing host. This is the Docusign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. - `hostEmailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `hostName` string — The name of the signing host. This is the Docusign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. - `hostNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - … - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - … - `ssn4InformationInput` Ssn4InformationInput - … - `ssn9InformationInput` Ssn9InformationInput - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - … - `workflowId` string — 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 — Metadata about a property. - … - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — Specifies whether the envelope uses the eNotary feature. Valid values: * `inPersonSigner`: The envelope uses the normal in-person signing flow. * `notary`: The envelope uses the eNotary in-person signing flow. - `inPersonSigningTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `notaryHost` NotaryHost — This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host. - `accessCode` string — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` PropertyMetadata — Metadata about a property. - … - `addAccessCodeToEmail` string — 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 — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` string — 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 - `clientUserId` string — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. 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 — 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` string[] — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. - `declinedDateTime` string — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - … - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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 — The notary's email address. Maximum Length: 100 characters. - `emailMetadata` PropertyMetadata — Metadata about a property. - … - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - … - `embeddedRecipientStartURL` string — Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `faxNumber` string — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - … - `hostRecipientId` string — The host recipient ID. - `idCheckConfigurationName` string — 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 — Metadata about a property. - … - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - … - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - … - `inheritEmailNotificationConfiguration` string — 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 — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — The notary's full legal name. Maximum Length: 100 characters. - `nameMetadata` PropertyMetadata — Metadata about a property. - … - `note` string — A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - … - `phoneAuthentication` 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. - … - `proofFile` 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/) - … - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - … - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - … - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - … - `recipientId` string — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` string — The 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 — 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 — Metadata about a property. - … - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - … - `roleName` string — Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - … - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` string — Reserved for Docusign. - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - … - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - … - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - … - `socialAuthentications` SocialAuthentication[] — Deprecated. - … - `status` string — 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 — The code associated with the recipient's status. This property is read-only. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` EnvelopeRecipientTabs — All of the tabs associated with a recipient. Each property is a list of a type of tab. - … - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `notaryId` string - `note` string — A note sent to the in-person signer in the signing email. This note is visible only to this recipient. Maximum Length: 1000 characters. - `noteMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `offlineAttributes` OfflineAttributes — Reserved for Docusign. - `accountEsignId` string — Reserved for Docusign. - `deviceModel` string — Reserved for Docusign. - `deviceName` string — Reserved for Docusign. - `gpsLatitude` string — Reserved for Docusign. - `gpsLongitude` string — Reserved for Docusign. - `offlineSigningHash` string — Reserved for Docusign. - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - … - `recordVoicePrint` string — Reserved for Docusign. - … truncated; see the full OpenAPI document linked below ## Response `200` Successful response. ## Other responses - `400` — Error encountered. --- [API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/versions/77f1998c313d/schema)