{"openapi":"3.0.0","servers":[{"url":"https://www.docusign.net/restapi"}],"info":{"contact":{"email":"devcenter@docusign.com","name":"DocuSign Developer Center","url":"https://developers.docusign.com/"},"description":"The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.","termsOfService":"https://www.docusign.com/company/terms-and-conditions/web","title":"DocuSign REST API","version":"v2.1","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://twitter.com/DocuSign/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/docusign/eSign-OpenAPI-Specification/master/esignature.rest.swagger-v2.1.json","version":"3.0"}],"x-providerName":"docusign.net"},"externalDocs":{"description":"See the DocuSign REST API Guide for more information.","url":"https://docs.docusign.com/esign"},"tags":[{"description":"The AcccountBrands resource provides methods that enable you to create and manage brands for an account.\n\nBranding enables you to add the look and feel of your organization's brand to the sending, signing, and email processes, making it easier for recipients to identify envelopes coming from your organization.\n\nThe DocuSign Account Custom Branding feature enables you to set the colors, logo, and text that recipients see at the account level. The settings associated with a brand are applied to all of the envelopes that use the brand. You can create multiple brand profiles for different corporate brands or internal departments.\n\n**Note:** To use this resource, branding for either signing or sending must be enabled for the account (either `canSelfBrandSend`, `canSelfBrandSign`, or both of these account settings must be set to **true**). ","name":"AccountBrands"},{"description":"The `AccountConsumerDisclosures` resource provides methods that enable you to enable, retrieve, and manage the Electronic Record and Signature Consent Disclosure (ERSD) options for your account. This is the disclosure that displays to each new recipient who is going to sign or add other information, or who is required to view the documents you send to them. The recipient must read and agree to the terms of the disclosure before they can access and take action on the documents you send. The ERSD does not apply to copy-only recipients, but does apply to recipients who must sign or view your documents.\n\nYou can use either the default ERSD that DocuSign provides for U.S.-based transactions, or a custom ERSD. \n\n## Languages\n\n**Important:** The system does not translate the ERSD for you. The default ERSD is always in English. For a custom ERSD, an account administrator must create a version of the disclosure for each language that your signers use. When you create a version of your custom ERSD for a specific signer language, you must:\n\n1. Specify the language code (`langCode`) for the signer language.\n2. Provide the `esignAgreementText` and `esignText` in the language associated with the `langCode`.\n\nFor more information, see [Legal Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure).","name":"AccountConsumerDisclosures"},{"description":"Custom fields enable you to record custom information about envelopes that you can then use for sorting, organizing, searching, and other downstream processes. \n\nFor example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault all of their documents from the web app by setting an account custom field with a name like `eVault with eOriginal` to **true.**\n\nYou can also use account custom fields to set the following information:\n\n- Tracking ID\n- Department \n- Use case\n- Other envelope metadata\n\n## Envelope Custom Field Visibility\n\nWhen you create an envelope custom field for your account, you have the following options: \n\n- Make it a required field for senders at the time of sending\n- Display it as an optional field at the time of sending\n- Set a specific value for the field behind the scenes (NOT SURE IF THIS IS RIGHT; MIGHT JUST BE AN UNUSED DRAFT FIELD)\n\nEnvelope recipients do not see the envelope custom fields.\n\n## Types of Envelope Custom Fields\n\nThere are two types of envelope custom fields:\n\n- `text`: Enables the sender to enter the value for the field. \n- `list`: Enables the sender to select the value of the field from a predetermined list.","name":"AccountCustomFields"},{"description":"The EnvelopeCustomFields resource provides methods that allow you manage custom fields in an envelope.\n\nCustom fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields:\n\n- `text`: Enables the sender to enter the value for the field.\n- `list`: Enables the sender to select the value of the field from a predetermined list.\n\n","name":"EnvelopeCustomFields"},{"description":"The EnvelopeDocumentFields resource provides methods that allow you to manage custom fields on a document.\n\nCustom fields are name-value pairs that are returned by the API but otherwise not used by DocuSign. They are not seen by the envelope recipients.\n\n\n\n\n\n","name":"EnvelopeDocumentFields"},{"description":"Envelope locks allow you to manage locks on an envelope.\n\nTo prevent users from changing an envelope while another user is\nmodifying it, you can lock the envelope and set the time until\nthe lock expires.\n\nTo use envelope locks, the user must have envelope locking capability enabled.\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n","name":"EnvelopeLocks"},{"description":"The EnvelopeRecipients resource enables you manage the recipients of an envelope.\nAll recipient types share a set of [core parameters](#core-recipient-parameters),\nbut some recipient types have additional parameters.\nYou specify the recipient type using the `recipientType` parameter. The recipient types are as follows:\n\n
\n\n| Recipient type | Description |\n| :-------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Agent](#agent-recipient) | Agent recipients can add name and email information for recipients that appear after the agent in routing order. |\n| [Carbon Copy](#carbon-copy-recipient) | Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. |\n| [Certified Delivery](#certified-delivery-recipient) | Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date, or add information to any of the documents. |\n| [Editor](#editor-recipient) | Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. |\n| [In-Person Signer](#in-person-signer-recipient) | In-person signer recipients are DocuSign users who act as signing hosts in the same physical location as the signer. |\n| [Intermediary](#intermediary-recipient) | Intermediaries are recipients who can, but are not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors, or intermediaries are added. |\n| [Seal](#seal-recipient) | Electronic seal recipients represent legal entities rather than individuals. Organizations and governments can use electronic seals to show evidence of origin and integrity of documents. |\n| [Signer](#signer-recipient) | Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. |\n| [Witness](#witness-recipient) | Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |\n\n
\n\nNot all recipients are are available to all account types.\nReview your account plan to determine which recipient types are available to you.\nAll recipient types are available in the development environment.\n\n\n## Core Recipient Parameters\n\nAll recipients, regardless of type, have the same common core parameters.\nThe following table contains the descriptions for the core properties for all recipient types:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :--------------------------------------- | :------- | :-------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters.

**Note:** If you are creating an envelope with DocuSign EU advanced signature enabled, ensure that recipient names do not contain any of the following characters: **^ : \\ @ , + <** |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| agentCanEditEmail | No | Boolean | When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. |\n| agentCanEditName | No | Boolean | When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending. Maximum length: 100 characters. |\n| embeddedRecipientStartURL | No | String | This is a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

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

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`|\n| customFields | No | customField | An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional property that has information for setting the language for the recipient's email information. It is composed of three elements:

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

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

*supportedLanguage*: The simple type enumeration (two-letter code) for the language to use for the standard email format and the signing view for the recipient. To retrieve the possible values, use the [Accounts::listSupportedLanguages method][ListLang].

**Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When the enforceSignerVisibility property is set to **true,** documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. |\n| idCheckConfigurationName | No | String | Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.

_Example_:
Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node. |\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.

*addressInformationInput*: Used to set recipient address information and consists of:

*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*dobInformationInput*: Used to set recipient date of birth information and consists of:

*dateOfBirth*: Specifies the recipient's date, month and year of birth.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:

*ssn4*: Specifies the last four digits of the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:



*ssn9*: Specifies the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

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

*senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use.
\n| recipientId | No | String

The string must be formatted as an integer or a GUID. | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.

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

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional. Used only when working with template recipients. When **true** and the `TemplateLocked` parameter is set to **true,** the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional. Used only when working with template recipients. When **true,** the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional. Used only when working with template recipients. When **true,** the sender may not remove the recipient. |\n| identityVerification | No | identityVerification | Optional. Specifies ID Verification applied on an envelope by workflow ID.
See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](/docs/esign-rest-api/esign101/concepts/recipients/auth/) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). |\n\n
\n\n\n\n## Agent Recipient\n\nAn agent recipient can add name and email information for recipients that appear after the agent in routing order.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :----------------- | :------- | :----------------- | :--------------------------------------------------------------------------- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Carbon Copy Recipient\n\nCarbon copy recipients receive a copy of the envelope but don't need to sign, initial,\ndate or add information to any of the documents. You can place this type of recipient in any routing order.\nCarbon copy recipients receive their copy of the envelope when the envelope\nreaches the recipient's order in the process flow and when the envelope is completed.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :----------------- | :------- | :----------------- | :--------------------------------------------------------------------------- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Certified Delivery Recipient\n\nCertified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n| Name | Required | Schema Type | Description |\n| :----------------- | :------- | :----------------- | :--------------------------------------------------------------------------- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Editor Recipient\n\nEditors have the same management and access rights for the envelope as the sender.\nThey can make changes to the envelope as if they were using the Advanced Correct feature.\nThis recipient can add name and email information,\nadd or change the routing order and set authentication options for the remaining recipients.\nAdditionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients.\nThe recipient must have a DocuSign account to be an editor.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :----------------- | :------- | :----------------- | :--------------------------------------------------------------------------- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n\n
\n\n\n## In-Person Signer Recipient\n\nAn in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer.\n\nThe following restrictions apply to using electronic notary when sending documents:\n\n* Authentication methods are allowed for the signer but not the notary.\n* The Sign On Paper, Document Markup, Field Markup and Change Signer options cannot be used for the documents.\n* Tabs may be assigned to the signer, but cannot be assigned to the notary.\n\nSee [eNotary Resources][enotary-resources] in the DocuSign Support Center for more information about how the eNotary feature works.\n\nIn addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :-------------------- | :-------------------------------------------------- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| inPersonSigningType | No | String | Specifies whether the envelope uses the eNotary feature. The accepted values are: |\n| notaryHost | Yes, when `inPersonSigningType` is `notary` | NotaryHost | Sets the information for the notary host for the notary in person signing flow. The following information is required: |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient. |\n| defaultRecipient | No | Boolean | When **true,** this is the default recipient for the envelope. This option is used when creating an envelope from a template. |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n| hostName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. |\n| hostEmail | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. |\n| signerName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's full legal name. |\n| Name | Yes, when `inPersonSigningType` is `notary` | String | The full legal name of the signer in an eNotary flow. |\n| email | Yes, when `inPersonSigningType` is `notary` | String | The signer's email address in an eNotary flow. |\n| recipientSuppliesTabs | No | Boolean | Indicates whether the recipient supplies tabs in the document. |\n| signatureInfo | No | String | Optional element only used with the recipient types In Person Signers, Signers, and Witnesses.

Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signInEachLocation | No | Boolean | When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |\n| tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.

Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. |\n\n
\n\n## Intermediary Recipient\n\nAn intermediary is a recipient who can, but is not required to,\nadd name and email information for recipients\nat the same or subsequent level in the routing order,\nunless subsequent agents, editors or intermediaries are added.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type has the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :----------------- | :------- | :----------------- | :--------------------------------------------------------------------------- |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n\n
\n\n\n\n## Seal Recipient\n\nAn electronic seal recipient is a legal entity rather than an actual person.\nElectronic Seals can be used by organizations and governments to show evidence\nof origin and integrity of documents.\nEven though electronic seals can be represented by a tab in a document,\nthey do not require user interaction and apply automatically in the order specified by the sender.\nThe sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nElectronic seal recipients rely on a subset of core properties, described as follows, plus the `recipientSignatureProviders` parameter:\n\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :-------------------------- | :-------------- | :-------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| recipientId | Yes | String

The string must be formatted as an integer or a GUID. | Indicates the unique ID of the applied electronic seal. |\n| routingOrder | No (default: 1) | String | Specifies the routing order of the electronic seal in the envelope.
The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals.. |\n| recipientSignatureProviders | Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n\n\n
\n\nBy default, Electronic Seals apply to all documents in an envelope.\nHowever, the `sealDocumentsWithTabsOnly` property (see `recipientSignatureProvider`)\nallows you to seal only documents that have `signHere` tabs set for the Electronic Seal recipients.\n\n
\n\n\n\n## Signer Recipient\n\nA signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type adds the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :-------------------- | :------- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient. |\n| defaultRecipient | No | Boolean | When **true,** this is the default recipient for the envelope. This option is used when creating an envelope from a template. |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n| isBulkRecipient | No | Boolean | Indicates whether the recipient is a bulk send recipient or not. |\n| recipientSuppliesTabs | No | Boolean | Indicates whether the recipient supplies tabs in the document. |\n| signInEachLocation | No | Boolean | 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). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers, Signers, and Witnesses.

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

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

Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. |\n\n
\n\n[enotary-resources]: https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources\n\n\n## Witness Recipient\n\nA witness is a recipient whose signature affirms that the identified signers have signed the documents in the envelope.\n\nIn addition to the [core parameters](#core-recipient-parameters), this recipient type adds the following parameters:\n\n
\n\n\n| Name | Required | Schema Type | Description |\n| :-------------------------- | :------- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient. |\n| defaultRecipient | No | Boolean | When **true,** this is the default recipient for the envelope. This option is used when creating an envelope from a template. |\n| documentVisibility | No | documentVisibility | A complex type that specifies which documents are visible to this recipient. |\n| isBulkRecipient | No | Boolean | Indicates whether the recipient is a bulk send recipient or not. |\n| recipientSignatureProviders | Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n| recipientSuppliesTabs | No | Boolean | Indicates whether the recipient supplies tabs in the document. |\n| recipientType | Yes | String | Indicates the recipient type. |\n| requireSignerCertificate | No | Boolean | Indicates whether the envelope requires a signer certificate for this recipient. |\n| requireSignOnPaper | No | Boolean | Specifies whether the signer must print, sign, and upload or fax the signed documents to DocuSign. |\n| signatureInfo | No | Boolean | Optional element only used with recipient types In Person Signers, Signers, and Witnesses. Enables the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. |\n| signInEachLocation | No | Boolean | When **true** and the feature is enabled in the sender's account, specifies that the signing recipient is required to sign and initial at each signature/initial tab (instead of once). |\n| signingGroupId | No | String | The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). |\n| signingGroupName | No | String | The display name for the signing group. Maximum Length: 100 characters. |\n| signingGroupUsers | No | userInfo | A complex type that contains information about the users in the signing group. |\n| witnessFor | Yes | String | Indicates the person or party for whom the recipient is a witness. |\n| witnessForGuid | Yes | String | GUID identifying the person or party for whom the recipient is a witness. |\n\n\n[ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/\n","name":"EnvelopeRecipients"},{"description":"The EnvelopeRecipientTabs resource provides methods that enable you\nto add,\nupdate,\nand delete tabs\nfrom an envelope.\nTabs are associated with a specific recipient\nin an envelope\nand are only used by the recipient types\nIn Person Signers and Signers.\n\n\n\n**On this page**\n\n- [Tab Types](#tab-types)\n- [View Tab](#view-tab)\n- [Requesting Payments](#requesting-payments)\n- [Using Custom Tabs in Envelopes and Templates](#using-custom-tabs-in-envelopes-and-templates)\n- [Anchoring Tabs](#anchoring-tabs)\n- [Automatically Populating Tabs](#automatically-populating-tabs)\n\n\n\n\n## Tab Types\n\nSome tabs enable values to be entered by the signer.\nThose tabs' values can be preset either through the web browser\nor via the API. Other tab types use information that is already\nrecognized by the DocuSign platform.\nThese tabs cannot have their value updated on a per-tab basis\nby the API or via the browser. In some cases, the info might be\nsettable using a different technique.\nFor example, the Full name tab uses the signer's name,\nwhich is set elsewhere in the request.\n\nHere is the list of tabs and whether you can or cannot set their values in the tab definition:\n\n
\n\n| Tab Type | Description |\n| :--------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Approve (`approve`) | Allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. This value **can't** be set. |\n| Checkbox (`checkbox`) | Allows the recipient to select a yes/no (on/off) option. This value can be set. |\n| Commission County (`commissionCounty`) | Displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). This value **can't** be set in the API call. |\n| Commission Expiration (`commissionExpiration`) | Displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). This value **can't** be set. |\n| Commission Number (`commissionNumber`) | Displays the number of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). This value **can't** be set. |\n| Commission State (`commissionState`) | Displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). This value **can't** be set. |\n| Company (`company`) | Displays the recipient's company name. This value **can't** be set. |\n| Date Signed (`dateSigned`) | Displays the date that the recipient signed the document. This value **can't** be set. |\n| Date (`date`) | Allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. This value can be set. |\n| Decline (`decline`) | Allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. This value **can't** be set. |\n| Email Address (`emailAddress`) | Displays the recipient's email as entered in the recipient information. This value **can't** be set. |\n| Email (`email`) | Allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. This value can be set. |\n| Envelope ID (`envelopeId`) | Displays the envelope ID. Recipients cannot enter or change the information in this tab. This value **can't** be set. |\n| First Name (`firstName`) | Displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. This value **can't** be set. |\n| Formula Tab (`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. See [Calculated Fields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures] in the DocuSign Support Center to learn more about payments. |\n| Full Name (`fullName`) | Displays the recipient's full name. This value **can't** be set. |\n| Initial Here (`initialHere`) | Allows the recipient to initial the document. May be optional. This value **can't** be set. |\n| Last Name (`lastName`) | Displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. This value **can't** be set. |\n| List (`list`) | This tab offers a list of options to choose from. The `listItems` property is used to specify the selectable options. This value can be set, |\n| Notarize (`notarize`) | Place this tab on a page to alert Notary recipients that they must take action. Only one notarize tab can appear on a page. This value can be set. |\n| Notary Seal (`notarySeal`) | Enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). This value **can't** be set. |\n| Note (`note`) | Displays additional information, in the form of a note, for the recipient. This value can be set. |\n| Number (`number`) | Allows the recipient to enter numbers and decimal (.) points. This value can be set. |\n| Phone Number (`phoneNumber`) | Allows the recipient to enter a phone number. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). This value **can't** be set. |\n| Radio Group (`radioGroup`) | This group tab is used to place radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. |\n| Sign Here (`signHere`) | Allows the recipient to sign a document. May be optional. This value **can't** be set.
**Note:** `signHere` tabs can also be used to add a visual representation for an electronic seal in a document. |\n| Signer Attachment (`signerAttachment`) | Allows the recipient to attach supporting documents to an envelope. This value **can't** be set. |\n| SSN (`ssn`) | A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. |\n| Text (`text`) | Allows the recipient to enter any type of text. This value can be set. |\n| Title (`title`) | Displays the recipient's title. This value **can't** be set. |\n| View (`view`) | The View tab is used with the Approve tab to handle supplemental documents. This value can be set. |\n| Zip (`zip`) | Allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. |\n\n\n[approve]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[checkbox]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[company]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[dateSigned]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[date]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[decline]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[email]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[envelopeId]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[firstName]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[formulaTab]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[fullName]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[initialHere]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[lastName]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[list]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[note]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[number]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[radioGroup]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[signHere]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[ssn]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[text]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[title]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[view]:\t\t /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n[zip]:\t \t/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/#tab-types\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n\n\n\n\n\n\n## View Tab\n\nThe View tab is used on supplemental documents.\nTo learn more about using the View tab with\nsupplemental documents, see\n[Using Supplemental Documents][usingsupdocs]\nin the [Sending Documents][sendenvelopes] section of\nthe [Envelope: create][envelopecreate] method.\n\n[sendenvelopes]: /docs/esign-rest-api/reference/envelopes/envelopes/create/\n[usingsupdocs]: /docs/esign-rest-api/esign101/concepts/documents/supplemental/\n[envelopecreate]: /docs/esign-rest-api/reference/envelopes/envelopes/create/\n\n
\n\n| Name | Required | Type | Description |\n| :--------------- | :------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| documentId | Yes | String | The document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |\n| pageNumber | Yes | String | Must be set to 1. |\n| recipientId | Yes | String | The recipient associated with the tab. Must refer to an existing recipient's ID attribute. |\n| required | No | Boolean | When **true,** the recipient is required to select the supplemental document View button during signing. |\n| tabLabel | No | String | The label used for the tab. If an empty string is provided for this, an empty sting is used. If no value is provided, the tab type is used as the value. Maximum of 500 characters. |\n| templateLocked | No | Boolean | Optional. Used only when working with template tabs. When **true,** the attributes of the tab cannot be changed by the sender. |\n| templateRequired | No | Boolean | Optional. Used only when working with template tabs. When **true,** the tab cannot be removed by the sender. |\n| xPosition | Yes | String | Required, but can be 0. |\n| yPosition | Yes | String | Required, but can be 0. |\n\n\n## Requesting Payments\n\nThe Payments feature of the DocuSign eSignature REST API\nlets you collect payments\nalong with signatures and other information.\n\nTo send a request for payment\nand collect payments,\nyou need a payment gateway account,\nwhich is the destination for the payments.\nCreate a payment account\nwith a supported payment gateway,\nand then connect the payment gateway account\nto your DocuSign account.\nTo learn how to connect a payment gateway account\nto your DocuSign account\nsee [Managing Payment Gateways][paymentgateways]\nin the DocuSign Support Center.\nYou must connect and manage payment gateway accounts manually\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\nThere is no public API\nfor connecting payment gateway accounts\nto DocuSign accounts\nor for managing payment gateway accounts.\n\nCurrently\n[Stripe][stripe],\n[Braintree](https://www.braintreepayments.com/),\n[Authorize.net](https://www.authorize.net/),\n[CyberSource](https://www.cybersource.com/),\n[Zuora](https://www.zuora.com/), and\n[Elavon](https://www.elavon.com/)\nare the supported payment gateways.\n\n### How Payments Work\n\nTo make a request for payment,\nuse a [`formulaTab`][formulatab]\nthat has a\n[`paymentDetails`][paymentdetails] object.\nThis object includes\na list of [`paymentLineItem`][paymentlineitem] objects.\nEach line item refers to a [`number`][numbertab] tab\nthat contains the value of the each item.\nThe purpose of the line items\nis to transmit them to the payment gateway\nas metadata, so that you can use the information\nin the payment processor.\n\n**Note:** If the `fileExtension` parameter is not added in an API call, only base64 converted PDF files will be accepted.\nAny attempt to send a non-PDF file without using `fileExtension` results in an error.\n\nThis is an example request for two books.\nEach book is specified in the `number` tabs\nlabeled \"Hamlet\" and \"Tempest\".\nThe books are referenced as line items\nby their tab labels\nwithin the `paymentDetails` object\nof a `formula` tab.\nThe formula of the `formula` tab\nadd the values of the same two `number` tabs.\n\n**Note:** This example uses US dollars, a decimal currency,\nso the price is multiplied\nby 100. If you are using a zero-decimal currency,\nsuch as Japanese yen, _do not_ multiply by 100.\n\n```json\n{\n \"documents\": [\n {\n \"documentBase64\": \"\",\n \"documentId\": \"1\",\n \"fileExtension\": \"pdf\",\n \"name\": \"payment.pdf\"\n }\n ],\n \"emailSubject\": \"Order Some Books\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"routingOrder\": \"1\",\n \"tabs\": {\n . . .\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\"\n },\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"154\"\n }\n ],\n \"formulaTabs\": [\n {\n \"required\": \"true\",\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"currencyCode\": \"USD\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Othello\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-xxxx-xxxx-xxxx-a208d659e490\"\n },\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": 300,\n \"yPosition\": 200\n }\n ]\n }\n }\n ]\n },\n \"status\": \"sent\"\n}\n```\n\nUse the\n[EnvelopeRecipients: list][enveloperecipientslist] method\nto check the status of a payment.\nWhen the payment is successful,\nthe `status` property of\nthe [`paymentDetails`][paymentdetails] object\nis `payment_complete`.\n\n```json\n{\n \"signers\": [\n {\n \"tabs\": {\n . . .\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\",\n },\n {\n \"value\": \"10.00\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n }\n ],\n \"formulaTabs\": [\n {\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"status\": \"payment_complete\",\n \"currencyCode\": \"USD\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Tempest\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-xxxx-xxxx-xxxx-a208d659e490\"\n },\n \"value\": \"20\",\n \"required\": \"true\",\n \"locked\": \"false\",\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"recipientId\": \"1\",\n \"pageNumber\": \"1\",\n }\n ]\n },\n \"creationReason\": \"sender\",\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"requireIdLookup\": \"false\",\n \"status\": \"completed\",\n }\n ],\n . . .\n}\n```\n\n#### How to make a request for future payments\n\nUse the following steps to make a request to collect a signer's payment method for future use:\n\n1. Add a text tab with a descriptive `tabLabel` such as `FuturePayment`.\n2. In the formula tab's `paymentDetails` object, add a `lineItem` object that references the `tabLabel` from step 1.\n\n**Note:** Do not include this new `lineItem` in formula calculations.\n\nThe following example builds on the previous code block to also collect a payment method for future use:\n\n```\n{\n \"documents\": [\n {\n \"documentBase64\": \"\",\n \"documentId\": \"1\",\n \"fileExtension\": \"pdf\",\n \"name\": \"payment.pdf\"\n }\n ],\n \"emailSubject\": \"Order Some Books\",\n \"recipients\": {\n \"signers\": [\n {\n \"email\": \"vreader@example.com\",\n \"name\": \"Voracious Reader\",\n \"recipientId\": \"1\",\n \"routingOrder\": \"1\",\n \"tabs\": {\n \"numberTabs\": [\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Hamlet\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"134\"\n },\n {\n \"value\": \"10.00\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"Tempest\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"154\"\n }\n ],\n \"textTabs\": [\n {\n \"value\": \"\",\n \"width\": 78,\n \"required\": \"true\",\n \"locked\": \"true\",\n \"tabLabel\": \"FuturePayment\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": \"323\",\n \"yPosition\": \"174\"\n }\n ],\n \"formulaTabs\": [\n {\n \"required\": \"true\",\n \"formula\": \"([Hamlet] + [Tempest]) * 100\",\n \"roundDecimalPlaces\": \"2\",\n \"paymentDetails\": {\n \"currencyCode\": \"USD\",\n \"paymentOption\": \"save_and_authorize\",\n \"lineItems\": [\n {\n \"name\": \"Hamlet\",\n \"description\": \"The Danish Play\",\n \"itemCode\": \"SHAK1\",\n \"amountReference\": \"Hamlet\"\n },\n {\n \"name\": \"Othello\",\n \"description\": \"The one with Caliban in it\",\n \"itemCode\": \"SHAK2\",\n \"amountReference\": \"Tempest\"\n },\n {\n \"name\": \"Request books\",\n \"description\": \"collect Payment method\",\n \"itemCode\": \"\",\n \"amountReference\": \"FuturePayment\"\n }\n ],\n \"gatewayAccountId\": \"e76668b4-xxxx-xxxx-xxxx-a208d659e490\"\n },\n \"tabLabel\": \"Payment1\",\n \"documentId\": \"1\",\n \"pageNumber\": \"1\",\n \"xPosition\": 300,\n \"yPosition\": 200\n }\n ]\n }\n }\n ]\n },\n \"status\": \"sent\"\n}\n```\n\n### Some Things to Keep in Mind About Payments\n\n* An envelope is not completed until all payments are completed.\n\n* If you are using a a decimal currency, such as USD,\n remember to multiply amounts by 100. If you are using\n zero-decimal currency, such as JPY, _do not_ multiply by 100.\n\n* If a DocuSign account Administrator\n deletes a payment gateway account connection\n DocuSign cancels all in-process envelopes\n that reference the deleted payment gateway account.\n\n* If the sender voids an envelope,\n all payment authorizations are canceled.\n\n* If a required recipient refuses to sign,\n all authorized payments are canceled.\n\n* If a required recipient's payment fails authorization,\n DocuSign attempts to recover\n by sending the recipient\n notification about the failed payment authorization.\n The recipient has the opportunity\n to correct the payment method information.\n\n* Each recipient's payment is authorized separately.\n Accounts are charged and payment made\n after all required tabs are completed,\n and all payments in an envelope for all recipients are authorized.\n\n* Refunds are not supported.\n Conduct refunds or payment changes\n with the payment gateway separately from DocuSign.\n\n* At this time, DocuSign does not charge a per-transaction fee.\n\n\n[enveloperecipientslist]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/list/\n[formulatab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/\n[ISO 4217]: https://en.wikipedia.org/wiki/ISO_4217\n[numbertab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[paymentlineitem]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/\n[paymentdetails]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/\n[stripe]: https://stripe.com/\n\n\n## Using Custom Tabs in Envelopes and Templates\n\nCustom Tabs can be added to envelopes and templates\nby setting the `customTabId` property\nwhen creating an envelope or template recipient\nor when adding a new tab for an existing recipient.\nThe custom tab must be added as the correct tab type.\nFor example if the custom tab type is text, it cannot be used as a number tab.\n\nWhen the `customTabId` property is set,\nthe new tab inherits all the custom tab properties.\nRequired information that is not included in the custom tab,\nsuch as document ID and page ID, must be included when adding the tab.\nIf the custom tab does not have anchor settings, the X and Y positions must be included.\n\nAfter the tab is created,\nit is treated as any other tab for updating or deleting.\n\n## Anchoring Tabs\n\nThe tab anchoring option\nallows you to send documents for signature\nthat do not have a fixed layout or format.\nIn these documents you might not know\nthe absolute location of the tabs\nwhen you design your API client application because the tabs must move with text.\nAs an alternative to sending X and Y coordinates for tabs,\nthe DocuSign Service can derive an anchor location for the tab\nby correlating anchor information to data within the document.\n\nWhen the DocuSign Service receives a request that contains tabs\nwith anchor information,\nit searches the document for instances of the `anchorString` property.\nWhen found,\nit places a tab of the specified type for the designated recipient.\nTab positions are established by setting offsets for the tab.\n\nWhen you apply tabs to the document,\nDocuSign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document.\n\nTo use an anchoring option:\n\n1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.\nFor best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.\nFor example, you might want to add a Sign Here tab to the \"Borrower's Signature\" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text \"BorrowerSignHere\" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use \"BorrowerSignHere\" as the anchor string.\n1. Reference the anchor through the `anchorString` property of the tab.\n1. Determine the offset from the anchor string location to where the tab should be placed.\n\nSetting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets.\nFor Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that.\nFor all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that.\nDocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error.\n\n### Rules for working with anchor tags\n\nWhen anchor tabs are used, all documents in the envelope are searched for the `anchorString` property.\n\n* You set the text of the anchor string in the `anchorString` property. DocuSign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs.\n* You cannot use the same anchored tab for different recipients for the same document.\n* The DocuSign system cannot search for text that is embedded in an image when checking for anchor strings.\n* X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs.\n* If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error.\n* The system does not support an anchor string embedded in the form of a PDF X-object in the document.\n* The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value.\n\n### Tips and Tricks\n\nThe following are tips for effective use of anchor tags:\n* In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document.\n* Develop an extensible and consistent syntax that can be used across multiple document types.\n* Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.\n\n## Automatically Populating Tabs\n\nIf you want similar tab types\nto automatically populate with the same data,\nyou must follow these guidelines:\n\n* Each `tabLabel` entry must have the characters\n `\\\\*` in front of the label.\n If you omit the `\\\\*` prefix,\n only the first occurrence of the tab is populated.\n\n When automatically populating tabs,\n the `tabLabel` must not contain any spaces.\n In the JSON example below,\n the Text tabs properties `StudentLastName` and `StudentFirstName`\n will be auto-populated as specified (\"Doe\" and \"John\")\n each place they appear throughout the envelope.\n\n ```\n \"tabs\": {\n \"textTabs\": [\n {\n \"tabLabel\": \"\\\\*StudentLastName\",\n \"value\": \"Doe\"\n },\n {\n \"tabLabel\": \"\\\\*StudentFirstName\",\n \"value\": \"John\"\n }]\n }\n ```\n\n* Note that `\\\\*` matches _anything_. If you were to add\n another tab with the `tabLabel` set to `\\\\*Name` to the\n example above, it would end up matching the other two\n labels as well.\n\n* Each occurrence of the tab must have identical properties.\n\n For example, suppose there are two Text tabs in a document,\n each with `tabLabel` set to `Name`.\n If one tab has the `bold` property set to **true,**\n and the other has the `bold` property set to **false,**\n only the first one will be populated.\n In order to automatically populate both occurrences\n of the `Name` Text tabs,\n the `bold` property must be set to the same value for both tabs.\n","name":"EnvelopeRecipientTabs"},{"description":"Document tabs are tabs that are associated with a document rather than with a recipient.","name":"EnvelopeDocumentTabs"},{"description":"The EnvelopeDocumentTabs resource provides methods that enable you to manage tabs in a template.","name":"TemplateDocumentTabs"},{"description":"Provides a URL that you can embed in your application\nto provide access to the DocuSign UI.\n\n### Related topics\n\n- [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/)\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\n- [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending)\n\n","name":"EnvelopeViews"},{"description":"","name":"AccountSealProviders"},{"description":"The Accounts resource provides methods that allow you to create, delete, and manage your accounts.","name":"Accounts"},{"description":"Standards-Based Signatures (SBS) is the label used to describe DocuSign's suite of signatures that comply with regional and industry regulations, such as the electronic IDentification, Authentication and trust Services (eIDAS) regulation in Europe.\n\n## Feature Differences When Using Standards-Based Signatures\n\nSome DocuSign features are not compatible with Standards-Based Signatures, while others work somewhat differently. It's important to understand these key differences.\n\n### DocuSign Features Not Compatible with SBS\n\n- Attachment by fax\n- Concatenation of signer attachments\n- Legacy digital signatures\n- Markup\n- Notary\n\n### DocuSign Features That Change with SBS\n\nThe following features work slightly differently with SBS:\n\n- **Advanced Correct:** After the first signature, adding or deleting a field is not allowed. This behavior occurs because SBS does not allow adding or removing form fields after a digital signature has already been applied to a PDF.\n- **Downloading Combined Envelopes:** A combined PDF is not digitally signed. This behavior occurs because concatenating digitally signed PDFs breaks the digital signatures on the PDFs.\n- **Freeform Signing:** After someone has signed, allows only signature and initials on free-form. This behavior occurs because if another signer has already signed the document, adding fields other than signature fields will break the existing digital signatures on the document.\n- **Watermarks:** All watermarks are added as PDF annotations. This behavior occurs because burning the watermark into the PDF will break the digital signatures on the document.\n- **Wet Signing:** Wet-signed documents are added as new documents to envelopes. This behavior results in the uploaded or faxed, physically signed document being added as a new document to the envelope. This new document gets only a platform seal.\n\nFor more information, see [Standards Based Signatures](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).","name":"AccountSignatureProviders"},{"description":"The Billing resource provides methods that allow you to manage the billing plans associated with an account.","name":"BillingPlans"},{"description":"The Invoices resource provides methods that allow you to manage the invoices for an account.","name":"Invoices"},{"description":"The Payments resource provides methods that allow you to manage payments for an account.\n\nThese calls can only be used by users with account administrator privileges.","name":"Payments"},{"description":"The CloudStorage resource provides methods that allow you to list files stored on your cloud storage provider.","name":"CloudStorage"},{"description":"The following providers are supported:\n\n* Google Drive\n* Dropbox\n* Box\n* Evernote\n* OneDrive\n\nTo use cloud storage files, you must first give DocuSign access to your cloud storage provider. You can disconnect authorized a cloud storage provider at any time.","name":"CloudStorageProviders"},{"description":"The `ConnectConfigurations` resource enables you to configure the\nDocuSign Connect service for your account.\n\nYou can use this resource to configure account-level webhooks\nthat send notifications about every envelope sent from your\naccount. You can set account-level webhooks to listen for events\nfor envelopes sent by a specific user on your account, by\nmultiple specific users, or from any of the users on your\naccount. These events will be tracked, and can be delivered to a\nlistening application.\n\n**Note:** To create an envelope-level webhook instead of using\naccount-level webhooks, use the Envelopes::Create method and add\nan `eventNotification` object to an envelope object.\n\n\nDocuSign Connect offers two delivery modes:\n\n- Send Individual Messages\n- Send Aggregated Messages\n\nBy default, the Send Individual Messages mode\nis enabled.\nYou can disable it\n(enabling Aggregated Messages mode)\nthrough DocuSign Admin\nin the **Updates** section.\n\n\n**Note:** In either mode, Connect\n[must be enabled](https://support.docusign.com/en/guides/ndse-admin-guide-connect)\nin your DocuSign account. It is not enabled by default.\n\n\n## Send Individual Messages\n\nSend Individual Messages (SIM) mode is the default.\n\nIn this mode DocuSign delivers notifications for each\nenvelope events individually.\nWhen a final recipient completes an envelope,\nyour listener will receive\na single **Recipient Signed/Completed** event\nfollowed by a single **Envelope Signed/Completed** event\nfor the final participating party on the agreement.\n\nFor more information about SIM mode, see\n[Using Connect's Send Individual Messages Feature](https://www.docusign.com/blog/developers/using-connects-send-individual-messages-feature).\n\n\n\n## Aggregated Messages\n\nIn Aggregated Messages mode,\nConnect aggregates similar events\ninto a single delivery.\nSimilar or simultaneous events\nare aggregated,\nso that your listener doesn't\nreceive extraneous messages.\n\nWhen the final recipient signs an envelope, the\nsystem delivers a single, aggregated Connect event, rather than\nseparate Recipient: complete and Envelope: complete messages.\nThis aggregation process ensures that you only receive the\nminimal viable number of messages about an envelope's life cycle.\n\n\n","name":"ConnectConfigurations"},{"description":"The ConnectEvents resource provides methods that allow you to read, delete, and republish the connect logs associated with an envelope.","name":"ConnectEvents"},{"description":"The CustomTabs resource provides methods that allow you create and manage custom tabs based on the existing DocuSign tabs.\n\nYou can create a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.\n\nCustom tabs can be created based on the approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.","name":"CustomTabs"},{"description":"The RequestLogs resource provide methods that allow you to retrieve and delete the API request log files.\n\nThe log files contain the API requests associated with your integration. They can aid you in troubleshooting specific issues within an integration, or if DocuSign Support requests an API trace log. ","name":"RequestLogs"},{"description":"The Resources resource provides a method which retrieves the base resources that are available.","name":"Resources"},{"description":"The Services resource provides a method that allow you to retrieve the available service versions.","name":"Services"},{"description":"The `EnvelopeConsumerDisclosures` resource provides methods that enable you to retrieve the Electronic Record and Signature Disclosure (ERSD) for an envelope recipient. This is the disclosure that displays to each new recipient who is going to sign or add other information, or who is required to view the documents you send to them. The recipient must read and agree to the terms of the disclosure before they can access and take action on the documents you send. The ERSD does not apply to copy-only recipients, but does apply to recipients who must sign or view your documents.\n\nYou can retrieve either the default ERSD that DocuSign provides for U.S.-based transactions, or a custom ERSD.\n\n## Languages\n\nYou specify the language of the disclosure version that you want to retrieve by using the `langCode` parameter.\n\n**Important:** The system does not translate the ERSD for you. An account administrator must create a version of the account-level disclosure for each language that your signers use. \n\nFor more information, see [Legal Disclosure](https://support.docusign.com/en/guides/ndse-admin-guide-legal-disclosure).","name":"EnvelopeConsumerDisclosures"},{"description":"\n\n\nThe EnvelopeDocuments resource provides methods\nthat manage documents in an envelope.\nYou can:\n* add one or more documents to the envelope\n* retrieve one or more documents from the envelope\n* delete documents from the envelope\n\nAll of the methods in this resource\noperate on on an existing envelope.\nBefore you can add documents\nto an envelope,\nyou must first create it\nwith the [Envelopes: create][envelopescreate] method.\n\n\n[envelopescreate]: /docs/esign-rest-api/reference/envelopes/envelopes/create/\n\n","name":"EnvelopeDocuments"},{"description":"The EnvelopeEmailSettings provide methods that allow you to manage the email override settings for an envelope.\n\nEmail override settings change the reply to email address, name, or the BCC for email archive information, for the envelope. Note that changing email settings will only affect email communications that occur after the addition was made.\n\nThe BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.","name":"EnvelopeEmailSettings"},{"description":"The Envelope resource provides methods that allow you to manipulate and monitor envelopes. \n\nOnce you have authenticated the user you can use the Envelopes: createEnvelope method to create an envelope. You can call the EnvelopeDocuments: update or EnvelopeDocuments: updateList method to add additional documents.\n\nSetting the `status` property on the envelope to `sent` allows you to send it or `created` to save it as a draft.\n\nYou can receive envelope event notifications by setting the `eventNotification` properties. When the envelope or recipient status changes to one of the specified status codes, a notification is sent to a URL that you specify.\n\nIf you have an envelope that you have previously saved, you can modify the subject and message, send it, void it, or place it in the purge queue using the Envelope: update method.\n\nIn addition to receiving notifications you can monitor the status of the envelopes using the following methods:\n* Envelope: getEnvelope - To get the status of a envelope. \n* Envelope: listStatus - To get the envelope status for a set of envelopes.\n* Envelope: listStatusChanges - To get status changes information for one or more envelopes. \n\nIf you need to delete a page from a document in an envelope, use the Envelope: deleteDocumentPage method.\n\nThe resource also includes a number of methods that allow you to retrieve and set the initials and signature for certain types of recipients on the document.","name":"Envelopes"},{"description":"The EnvelopeTemplates resource provides methods that allow you to add and delete templates on envelopes and documents.","name":"EnvelopeTemplates"},{"description":"The Folders resource provides methods that allow you to view contents of folders on the account and move envelopes and templates between folders.","name":"Folders"},{"description":"For the custom groups you define for your account, you can assign brands to specify the ones that group members can use. Group members can use the available brands when they send envelopes or create templates. For more information, see [Assign Brands to Groups](https://support.docusign.com/en/guides/ndse-admin-guide-assign-brands-to-groups).","name":"GroupBrands"},{"description":"The Groups resource provides methods that allow you to manage groups for the account.\n\nGroups can be used to help manage users by associating users with a group. A group can be associated with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but this makes it easier to manage user permissions for a large number of users. Groups can also be used with template sharing to limit user access to templates.","name":"Groups"},{"description":"The GroupUsers resource provides methods that allow you to manage the users in a group.","name":"GroupUsers"},{"description":"The SigningGroups resource provides methods that allow you manage signing groups.\n\nSigning Groups allow you to create a group of people to which an envelope is sent. Any member of that group can open an envelope and sign the documents in the envelope with their own signature, even though a signature field was not directly assigned to them. When the Signing Group option is used, group members that open and sign the envelope are tracked in the envelope history and certificate.\n\nWhen one group member opens the envelope, it is temporarily locked and if other members try to open the envelope they will see a message saying the envelope is currently opened. If the group member exits the envelope without finishing the lock expires, allowing other group members to open and complete the envelope.\n\nWhen the envelope is complete, all members of the group will receive a completed notification and can access the completed envelope. \nThe envelope history and Certificate of Completion will show that the envelope was sent to a signing group and record which members viewed and signed the envelope.\n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n\nThe Signing Groups feature is only supported in certain DocuSign Enterprise and System Automated Premium plans. Your account might not support this option. To access this functionality, contact your Account Manager or DocuSign Support (support@docusign.com) for assistance.\n\nFor more information, see [Signing Groups](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).","name":"SigningGroups"},{"description":"The SigningGroupUsers resource provides methods that allow you to manage users in Signing Groups.","name":"SigningGroupUsers"},{"description":"The TemplateRecipients resource allows you manage the recipients of an template.\n\nThe exact parameters associated with a recipient depend on the recipient type. There are seven recipient types: Agents, Carbon Copies, Certified Deliveries, Editors, In Person Signers, Intermediaries, and Signers.\n\nNot all recipients are are available to all account types, review you account plan to determine which recipient types are available to you. If you are working in the development environment, all recipient types are available.\n\nEach recipient type is described below:\n\n[Agents](#agents): This recipient can add name and email information for recipients that appear after the recipient in routing order.\n\n[Carbon Copies](#carboncopies): Use this action if the recipient should get a copy of the template, but the recipient does not need to sign, initial, date or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the template when the template reaches the recipient's order in the process flow and when the template is completed.\n\n[Certified Deliveries](#certifiedDeliveries): Use this action if the recipient must receive the completed documents for the template to be completed, but the recipient does not need to sign, initial, date or add information to any of the documents.\n\n[Editors](#editors): This recipient has the same management and access rights for the template as the sender and can make changes to the template as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\n[In Person Signers](#inPerson): Use this action if the signer 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.\n\n[Intermediaries](#intermediaries): This recipient 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).\n\n[Signers](#signers): Use this action if your recipient must sign, initial, date or add data to form fields on the documents in the template.\n\n### Core JSON Layout\n\nThe following shows the core JSON layout for a recipient.\n\n```\n\"email\": \"email.name@company.com\",\n \"name\": \"recipient name\",\n \"accessCode\": \"\",\n \"addAccessCodeToEmail\": false,\n \"clientUserIs\": null,\n \"embeddedRecipientStartURL\": \"string\",\n \"customFields\": {\n \"sample string 1\",\n \"sample string 2\"\n },\n \"emailNotification\"{\n \"emailBody\":\"email text\",\n \"emailSubject\":\"Subject text\",\n \"supportedLanguage\":\"en\",\n },\n \"excludedDocuments\": [\"2\", \"4\"],\n \"idCheckConfigurationName\": null,\n \"idCheckInformationInput\": {\n \"addressInformationInput\": {\n \"addressInformation\": {\n \"street1\": \"sample string 1\",\n \"street2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"zip\": \"sample string 5\",\n \"zipPlus4\": \"sample string 6\"\n },\n \"displayLevelCode\": \"sample string 1\",\n \"receiveInResponse\": \"sample string 2\"\n },\n \"dobInformationInput\": {\n \"dateOfBirth\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn4InformationInput\": {\n \"ssn4\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\",\n \"receiveInResponse\": \"sample string 3\"\n },\n \"ssn9InformationInput\": {\n \"ssn9\": \"sample string 1\",\n \"displayLevelCode\": \"sample string 2\"\n }\n },\n \"inheritEmailNotificationConfiguration\": false,\n \"note\": \"\",\n \"phoneAuthentication\": {\n \"recipMayProvideNumber\": \"sample string 1\",\n \"validateRecipProvidedNumber\": \"sample string 2\",\n \"recordVoicePrint\": \"sample string 3\",\n \"senderProvidedNumbers\": [\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"recipientAttachment\": null,\n \"recipientCaptiveInfo\": null,\n \"recipientId\": \"1\",\n \"requireIdLookup\": false,\n \"roleName\": \"\",\n \"routingOrder\": 1,\n \"samlAuthentication\": {\n \"samlAssertionAttributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"smsAuthentication\": {\n \"senderProvidedNumbers\":[\n \"sample string 1\",\n \"sample string 2\"\n ]\n },\n \"socialAuthentications\": null,\n \"templateAccessCodeRequired\": false,\n \"templateLocked\": false,\n \"templateRequired\": false,\n...\n```\n\n### Core Recipient Parameters\n\nThe following table contains the descriptions for the core properties for a recipient.\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.
Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.
Maximum Length: 100 characters. |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.
Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.

If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending. |\n| embeddedRecipientStartURL | No | String | This is a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.

If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.

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

_Example_:
`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the template status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:

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

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

*supportedLanguage*: The simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

**IMPORTANT:** If this is enabled for one recipient, it overrides the Template Subject and `EmailBlurb` property settings. Also, you must set the `emailNotification` property for all recipients. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the template to use this.

When the enforceSignerVisibility property is set to **true,** documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an template, unless they are specifically excluded using this setting when an template is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an template is sent. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.

_Example_:
Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an template, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.

*addressInformationInput*: Used to set recipient address information and consists of:

*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*dobInformationInput*: Used to set recipient date of birth information and consists of:

*dateOfBirth*: Specifies the recipient's date, month and year of birth.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:

*ssn4*: Specifies the last four digits of the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.

*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:



*ssn9*: Specifies the recipient's SSN.

*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If true and the template recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements:

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

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

*recordVoicePrint* - Reserved

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

This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the template. |\n| samlAuthentication | No | samlAssertionAttributes | Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes:

*name*: The name of the SAML assertion attribute.

*value*: The value associated with the named SAML assertion attribute. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:

*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When **true** and the `TemplateLocked` parameter is set to **true,** the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When **true,** the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When **true,** the sender may not remove the recipient. |\n\n## Agents Recipient\n\nThis recipient can add name and email information for recipients that appear after the recipient in routing order.\n\n#### Example Agents layout\n\n```\n\"agents\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe additional parameters for Agents recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | 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. |\n| canEditRecipientNames | No | Boolean | Optional element. When **true,** the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## Carbon Copies Recipient\n\nUse this type if the recipient should get a copy of the template, but the recipient does not need to sign, initial, date, or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the template when the template reaches the recipient's order in the process flow and when the template is completed.\n\n#### Example Carbon Copies layout\n\n```\n\"carbonCopies\": [{\n \n```\n\nThe Carbon Copies recipient uses only the core parameters.\n\n## Certified Deliveries Recipient\n\nUse this action if the recipient must receive the completed documents for the template to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.\n\n#### Example Certified Deliveries layout\n\n```\n\"certifiedDeliveries\": [{\n\n}],\n```\nThe Certified Deliveries recipient uses only the core parameters.\n\n## Editors Recipient\n\nThis recipient has the same management and access rights for the template as the sender and can make changes to the template as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\n#### Example Editors layout\n\n```\n\"editors\": [{\n \n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe additional parameters for Editors recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | Optional element. When **true,** the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When **true,** the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## In Person Signers Recipient\n\nUse this type if the signer 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.\n\n#### Example In Person Signers layout\n\n```\n\"inPersonSigners\": [{\n \"hostEmail\": \"signing.host@company.com\",\n \"hostName\": \"Mike Host\",\n \n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"signerEmail\": \"signer.name@company.com\",\n \"signerName\": \"MC Clap Your Hands\",\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"templateIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n}],\n```\n\nThe additional and changed parameters for In Person Signers recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| hostEmail | Yes | Email | Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.

Specifies the email for the signing host. |\n| hostName | Yes | String | Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.

Specifies the email for the signing host.|\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When **true,** this is the default recipient for the template. This option is used with the CreateTemplateFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | 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). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

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

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

Specifies the Tabs associated with the recipient. See the See the [EnvelopeRecipientTabs resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. for more information about tabs. |\n\n## Intermediaries Recipient\n\nThis recipient 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).\n\n#### Example Intermediaries layout\n\n```\n\"intermediaries\": [{\n\n \"canEditRecipientEmails\": false,\n \"canEditRecipientNames\": false\n}],\n```\n\nThe parameters for Intermediaries recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| canEditRecipientEmails | No | Boolean | 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. |\n| canEditRecipientNames | No | Boolean | Optional element. When **true,** the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n## Signers Recipient\n\nUse this action if your recipient must sign, initial, date, or add data to form fields on the documents in the template.\n\n#### Example Signers layout\n\n```\n\"Signers\": [{\n\n \"autoNavigation\": false,\n \"defaultRecipient\": false,\n \"signInEachLocation\": false,\n \"signatureInfo\": null,\n \"tabs\": {\n \"approveTabs\": null,\n \"checkboxTabs\": null,\n \"companyTabs\": null,\n \"dateSignedTabs\": null,\n \"dateTabs\": null,\n \"declineTabs\": null,\n \"emailTabs\": null,\n \"templateIdTabs\": null,\n \"fullNameTabs\": null,\n \"initialHereTabs\": null,\n \"listTabs\": null,\n \"noteTabs\": null,\n \"numberTabs\": null,\n \"radioGroupTabs\": null,\n \"signHereTabs\": [{\n \"signerAttachmentTabs\": null,\n \"ssnTabs\": null,\n \"textTabs\": null,\n \"titleTabs\": null,\n \"zipTabs\": null\n }\n \"deliveryMethod\":\"\",\n \"deliveredDateTime\":\"String Content\",\n \"signedDateTime\":\"String Content\",\n \"offlineAttributes\":{\n \"deviceName\":\"String Content\",\n \"deviceModel\":\"String Content\",\n \"gpsLatitude\":\"String Content\",\n \"gpsLongitude\":\"String Content\",\n \"accountEsignId\":\"String Content\"\n }\n}],\n```\n\nThe additional parameters for Signers recipient are shown below:\n\n| Name | Required? | Schema Type | Description |\n| --- | --- | --- | --- |\n| autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.|\n| defaultRecipient | No | Boolean | When **true,** this is the default recipient for the template. This option is used with the CreateTemplateFromTemplatesAndForms method. |\n| signInEachLocation | No | Boolean | 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). |\n| signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.

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

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

Specifies the Tabs associated with the recipient. See the See the [EnvelopeRecipientTabs resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) for more information about tabs. section for more information about tabs. |\n| deliveryMethod | No | String | Reserved: For DocuSign use only.|\n| deliveredDateTime | No | DateTime | Reserved: For DocuSign use only. |\n| signedDateTime | No | DateTime | Reserved: For DocuSign use only. |\n| offlineAttributes | No |   | Reserved: For DocuSign use only.|\n","name":"TemplateRecipients"},{"description":"","name":"TemplateBulkRecipients"},{"description":"The TemplateCustomFields resource provides methods that allow you manage custom fields in an template. \n\nCustom fields can be used in the templates for your account to record information about the template, help search for templates and track information. The template custom fields are shown in the Template Settings section when a user is creating an template in the DocuSign member console. The template custom fields are not seen by the template recipients.\n\nThere are two types of custom fields:\n\n- `text`: Enables the sender to enter the value for the field. \n- `list`: Enables the sender to select the value of the field from a predetermined list.","name":"TemplateCustomFields"},{"description":"The TemplateDocumentFields resource provides methods that allow you to manage custom fields on a document.\n\nYou can create custom versions of standard fields that combine of field properties, such as font type or size, or a validation setting. \n\nNote: Some advanced features and options are supported only in certain DocuSign plans. Your account plan might not support some options discussed in this help topic. For more information about which options are available for your account, check your account plan or contact your Account Manager.","name":"TemplateDocumentFields"},{"description":"\n\n\nThe TemplateDocuments resource provides methods\nthat manage documents in a template.\nYou can:\n* Add one or more documents to the template\n* Retrieve one or more documents from the template\n* Delete documents from the template\n\nAll of the methods associated with this resource\noperate on an existing template.\nBefore you can add documents\nto a template,\nyou must first create it\nwith the [Templates:: Create][templatescreate] method.\n\n[templatescreate]: /docs/esign-rest-api/reference/templates/templates/create/\n","name":"TemplateDocuments"},{"description":"The TemplateLocks resource provides methods that allow you to\nmanage locks on a template.\n\nTo prevent users from changing a template while another user is\nmodifying it, you can lock the template and set the time until\nthe lock expires.\n\nFor example, you would use the following flow:\n\n1. Lock the template.\n2. Make changes to template.\n3. Delete the template lock and save the changes. If the template has a password, you must supply the template password to save the changes.\n\n**Note:** To use template locks, the user must have envelope locking capability enabled.","name":"TemplateLocks"},{"description":"The Template resource provides methods that allow you to manipulate and monitor templates. \n\nOnce you have authenticated the user you can use the Templates: createTemplate method to create a template. You can call the TemplateDocuments: update or TemplateDocuments: updateList method to add more documents.\n\nIf you have a template that you have previously saved, you can modify the subject and message, send it, void it, or purge it from the DocuSign system using the Template: update method.\n\nIn addition to receiving notifications, you can monitor the status of the templates using the following methods:\n\n* Template: getTemplate - Gets the status of a template. \n* Template: listStatus - Gets the status for a set of templates.\n* Template: listStatusChanges - Gets status change information for one or more templates. \n\nIf you need to delete a page from a document in a template, use the Template: deleteDocumentPage method.\n\nThe resource also includes a number of methods that allow you to retrieve and set the initials and signature for certain types of recipients on the document.","name":"Templates"},{"description":"\n\n\nThe TemplateRecipientTabs resource provides methods that let you\nadd,\nupdate,\nand delete tabs\nfrom an envelope.\nTabs are associated with a specific recipient\nin an envelope\nand are only used by the recipient types\nIn Person Signers and Signers. \n\n\n## Tab Types\n\nThis table lists the available tab types.\n\n
\n\n\n| Tab Type | Description |\n| :------- | :---------- |\n| Approve Tab | Place this tab on the document if you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. |\n| Checkbox Tab | Place this tab on the document in a location where the recipient can select a yes/no (on/off) type option. |\n| Company Tab | Place this tab on the document where you want the recipient's company name to appear. |\n| Date Signed Tab | Place this tab on the document where you want the date the recipient signed the document to appear. |\n| Date Tab | Place this tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. |\n| Decline Tab | Place this tab on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tab during the signing process, the envelope is voided. |\n| Email Address Tab | Place this tab on a document where you want the recipient's email, as entered in the recipient information, to appear. |\n| Email Tab | This is a single-line field that accepts all characters. |\n| Envelope ID Tab | Place this tab on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab. It is for informational purposes only. |\n| First Name Tab | Place this tab on a document where you want the recipient's first name to appear. This tab splits the recipient's name (as entered in the recipient information) into sections based on spaces and uses the first section as the first name. |\n| Formula Tab | This tab is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tab. The formula tab calculates and displays a new value when changes are made to the reference tab values. The reference tab information and calculation operations are entered in the \"formula\" element. See the Using the Calculated Fields Feature quick start guide or DocuSign Service User Guide for more information about formulas. |\n| Full Name Tab | Place this tab on the document where you want the recipient's full name to appear. |\n| Initial Here Tab | Place this tab where the recipient must initial the document. This tab can be set to be optional. |\n| Last Name Tab | Place this tab on a document where you want the recipient's last name to appear. This tab splits the recipient's name (as entered in the recipient information) into sections based on spaces and uses the last section as the last name. |\n| List Tab | This tab has a list of options that a recipient can select. The `listItems` parameter is used to set the options that can be selected. |\n| Note Tab | Place this tab on the document where you want to add a note for the recipient on a document. |\n| Number Tab | This tab is a field where the recipient can enter numbers and decimal (.) points. |\n| Radio Group Tab | This group tab is used to place radio buttons on a document. The `radios` parameter is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. |\n| Sign Here Tab | Place this tab where the recipient must sign the document. This tab can be set to be optional. |\n| Signer Attachment Tab | The signer attachment is where the recipient initiates the process of adding supporting documents to an envelope. |\n| SSN Tab | This tab is a single-line field where the recipient can enter numbers. A Social Security Number can be typed with or without dashes. |\n| Text Tab | This tab is a field where the recipient can enter any type of characters. |\n| Title Tab | Place this tab on the document where you want the recipient's title to appear. |\n| Zip Tab | This tab is a single-line field where the recipient can enter numbers. |\n\n\n## Using Custom Tabs in Envelopes and Templates \n\nCustom Tabs can be added to envelopes and templates\nby setting the `customTabId` property\nwhen creating an envelope or template recipient\nor when adding a new tab for an existing recipient.\nThe custom tab must be added as the correct tab type.\nFor example if the custom tab type is text, it cannot be used as a number tab.\n\nWhen the `customTabId` property is set,\nthe new tab inherits all the custom tab properties.\nRequired information that is not included in the custom tab,\nsuch as document ID and page ID, must be included when adding the tab.\nIf the custom tab does not have anchor settings, the X and Y positions must be included.\n\nAfter the tab is created,\nit is treated as any other tab for updating or deleting. \n\n## Anchoring Tabs\n\nThe tab anchoring option\nallows you to send documents for signature\nthat do not have a fixed layout or format.\nIn these documents you might not know\nthe absolute location of the tabs\nwhen you design your API client application because the tabs must move with text.\nAs an alternative to sending X and Y coordinates for tabs,\nthe DocuSign Service can derive an anchor location for the tab\nby correlating anchor information to data within the document.\n\nWhen the DocuSign Service receives a request that contains tabs\nwith anchor information,\nit searches the document for instances of the `anchorString` property.\nWhen found,\nit places a tab of the specified type for the designated recipient.\nTab positions are established by setting offsets for the tab.\n\nWhen you apply tabs to the document,\nDocuSign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document.\n\nTo use an anchoring option:\n\n1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.\nFor best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope. \nFor example, you might want to add a Sign Here tab to the \"Borrower's Signature\" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text \"BorrowerSignHere\" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use \"BorrowerSignHere\" as the anchor string. \n1. Reference the anchor through the `anchorString` property of the tab.\n1. Determine the offset from the anchor string location to where the tab should be placed. \n\nSetting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets.\nFor Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that.\nFor all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that.\nDocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error.\n\n### Rules for working with anchor tags\n\nWhen anchor tabs are used, all documents in the envelope are searched for the `anchorString` property.\n\n* You set the text of the anchor string in the `anchorString` property. DocuSign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs.\n* You cannot use the same anchored tab for different recipients for the same document.\n* The DocuSign system cannot search for text that is embedded in an image when checking for anchor strings.\n* X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs.\n* If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error.\n* The system does not support an anchor string embedded in the form of a PDF X-object in the document.\n* The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value.\n\n### Tips and Tricks\n\nThe following are tips for effective use of anchor tags:\n* In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document.\n* Develop an extensible and consistent syntax that can be used across multiple document types.\n* Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.\n\n## Automatically Populating Tabs\n\nIf you want similar tab types\nto automatically populate with the same data,\nyou must follow these guidelines:\n\n* Each `tabLabel` entry must have the characters\n `\\\\*` in front of the label.\n If you omit the `\\\\*` prefix,\n only the first occurrence of the tab is populated.\n\n When automatically populating tabs,\n the `tabLabel` must not contain any spaces.\n In the JSON example below,\n the Text tabs properties `StudentLastName` and `StudentFirstName`\n will be auto-populated as specified (\"Doe\" and \"John\")\n each place they appear throughout the envelope.\n\n ```\n \"tabs\": {\n \"textTabs\": [\n {\n \"tabLabel\": \"\\\\*StudentLastName\",\n \"value\": \"Doe\"\n },\n {\n \"tabLabel\": \"\\\\*StudentFirstName\",\n \"value\": \"John\"\n }]\n }\n ```\n\n* Each occurrence of the tab must have identical properties.\n\n For example, suppose there are two Text tabs in a document,\n each with `tabLabel` set to `Name`.\n If one tab has the `bold` property set to **true,**\n and the other has the `bold` property set to **false,**\n only the first one will be populated.\n In order to automatically populate both occurrences\n of the `Name` Text tabs,\n the `bold` property must be set to the same value for both tabs.\n","name":"TemplateRecipientTabs"},{"description":"The TemplateViews resource\nprovides a method that returns a URL\nthat you can embed in your application\nto generate a template view that uses the DocuSign UI.\n\nOne template view is available:\n\n* Edit View: The DocuSign UI for editing a template.\n\nThis resource is related to the [EnvelopeViews][envelopeviews] resource.\nBoth resources enable you to embed the DocuSign UI into your application.\n\n\n[envelopeviews]: /docs/esign-rest-api/reference/envelopes/envelopeviews/\n","name":"TemplateViews"},{"description":"The UserCustomSettings resource provides methods that allow you to manage the custom settings for a user.\n\nCustom settings are a flexible way to store and retrieve custom user information that can be used in your own system.\n\nThere is a limit on the size for all the custom user settings for a single user. All the custom user settings for a single user is limited to 4,000 characters, which includes the xml and json structure for the settings.","name":"UserCustomSettings"},{"description":"The UserProfiles resource provides methods that allow you to manage a user's profile.","name":"UserProfiles"},{"description":"The Users resource provides methods that enable you to manage users for an account.\n\nThe following User methods do not use the `title` property in the Users object:\n\n- create\n- delete\n- deleteProfileImage\n- get\n- getProfileImage\n- getSettings\n- list\n- update\n- updateList\n- updateProfileImag\n- updateSettings\n\nInstead, you can retrieve and set the user's job title by using the UserProfiles:Get and UserProfiles:Update methods. For more information, see [UserProfiles](/docs/esign-rest-api/reference/users/userprofiles/).","name":"Users"},{"description":"The UserSignatures resource provides methods that allow you manage the initials and signature images for a user.","name":"UserSignatures"},{"description":"DocuSign eSignature includes a contacts list (also referred to as an address book) to help make sending envelopes even easier. When you send an envelope, the recipients' names and email addresses are automatically added to your contacts list. You can use the contacts list to quickly add recipients to the envelopes you send. The `Contacts` resource provides methods that enable you to manage your contacts.\n\n","name":"Contacts"},{"description":"Envelope attachments are files that an application can include in an envelope. They are not visible to envelope senders or recipients, and they are not converted to PDF. Envelope attachments are available only through the API.\n\nTo learn about the different types of attachments, see the [concept guide](/docs/esign-rest-api/esign101/concepts/documents/attachments/).\n","name":"EnvelopeAttachments"},{"description":"An account permission profile is assigned to a group of users, enabling you to set permissions for all of the users in the group at the same time. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. \n\nDocuSign offers the following account permission profiles:\n\n- DocuSign Viewer\n- DocuSign Sender\n- Account Administrator\n\nYou can also create your own custom account permission profiles.\n","name":"AccountPermissionProfiles"},{"description":"PowerForms enable you to create self-service documents for signature. A PowerForm is an envelope initiated from a URL that you make available for signers to complete. You can either add a PowerForm to your website or email the URL to recipients. DocuSign saves the data that recipients enter so you can easily integrate it with your other applications.\n\nFor more information, see [Using PowerForms](https://support.docusign.com/s/document-item?bundleId=jbx1643062255110&topicId=eke1578456649038.html).\n\n**Note:** PowerForms are available only for DocuSign Enterprise accounts.\n\n\n### Errors\n\nPowerForm methods return the following 404 errors:\n\n- `PowerForms_Recipient_Denied_Documents`: The recipient is denied access to the documents.\n- `PowerForms_DigitalCerts_Shared_Tabs_Not_Allowed`: Shared tags are not allowed because a digital certificate is required\nfor a signer.\n- `PowerForms_DigitalCerts_Free_Form_Tabs_Not_Allowed`: Signers that are required to use a digital certificate must have at\nleast one required, non-conditional signature or initials tab.\n- `PowerForms_DigitalCerts_Multiple_Recipients_Routing_Order`: Signers that are required to use a digital certificate must be the\nonly recipient in a routing order. Edit the routing order or remove the digital certificate requirement.\n- `PowerForms_DigitalCerts_Markup_Not_Allowed`: Document markup is not allowed because a digital certificate is\nrequired for a signer.\n- `PowerForms_Incomplete_Recipient`: The recipient's username, email, or role is not set.\n- `PowerForms_PowerFormId_Required`: A `powerFormId` is required.\n- `PowerForms_PowerFormId_Mismatch`: A `powerFormId` mismatch has occurred.\n","name":"PowerForms"},{"description":"The PowerFormData resource provides a method for accessing PowerForm data.\n","name":"PowerFormData"},{"description":"The AccountTabSettings resource provides methods that allow you to manage\ntab settings for an account.\n","name":"AccountTabSettings"},{"description":"The ENoteConfigurations resource provides methods that allow you to manage\ninformation for the eNote eOriginal integration.\n","name":"ENoteConfigurations"},{"description":"The WorkspaceItems resource provides methods that enable you to manage\nworkspace items.\n","name":"WorkspaceItems"},{"description":"A workspace is a collaborative space for sharing documents and managing workflows. A workspace has a single owner who must be a DocuSign user. The owner can invite others to the workspace as collaborators. Individuals who are not DocuSign users must create a DocuSign account to join a workspace as a collaborator.\n \nYou can create an envelope directly from a workspace.\n\nWorkspaces store the following information:\n\n- **Files:** Files uploaded to a workspace for storage or reuse.\n- **Documents:** A document is a component of a transaction, template, or workspace. When a file is added to a transaction, template, or workspace, it is copied as a document. Each document in a workspace has a single owner.\n- **Templates:** A set of documents that you can use to create a transaction or a workspace.\n- **Transactions:** A transaction is a series of workflow events related to one or more documents. These events route the documents to one or more individuals for the purposes of doing business. Each transaction has a single owner (the sender).\n\n**Note:** Documents in a template are not individually listed as files.","name":"Workspaces"},{"description":"A chunked upload is a temporary file that you upload in parts and stage at DocuSign, then refer to as the content for other API calls. For example, you might use it for document content when assembling an envelope or template. \n\nA chunked upload is linked to the DocuSign account member who initiated the API call. This user is the only user who is able to reference the chunked upload.\n\nA ChunkedUpload is intended to be an area for briefly staging data for use with other DocuSign API calls. The ChunkedUpload API endpoints do not provide an action to download the ChunkedUpload's content.\n\nThe typical flow for using a chunked upload involves the following steps:\n\n1) Initiate the chunked upload with content representing part 0.\n\n2) Add more parts to the chunked upload until you have transmitted the entirety of the content.\n\n3) Commit the chunked upload, preparing it for use with other API calls.\n\n4) Assemble a DocuSign envelope with a document that includes a reference to the chunked upload as the content.\n\n5) Continue with envelope-related processes.\n\n**Note:** You must fully upload and use a chunked upload within 20 minutes of initializing it.\n\nAfter the chunked upload has been correctly referenced within another API call, it becomes unavailable for any further use and is promptly removed from the system.\n\nChunked uploads have the following limits, which are configured per DocuSign environment, account, or integrator:\n\n- The maximum number of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 64. \n- The maximum total size of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 1 GB. \n- The amount of time that a chunked upload is active after you initialize it. The default value is 20 minutes.\n","name":"ChunkedUploads"},{"description":"The EnvelopeFormData resource provides a method for downloading the data that users have entered into a form associated with an envelope.","name":"EnvelopeFormData"},{"description":"The Envelope Document Visibility resource provides methods for managing document visibility by recipient.\n","name":"EnvelopeDocumentVisibility"},{"description":"The Template Document Visibility resource provides methods for managing template document visibility by recipient.\n","name":"TemplateDocumentVisibility"},{"description":"The AccountPasswordRules resource provides methods that allow you to obtain and update account password rules, as well as membership and account rules.","name":"AccountPasswordRules"},{"description":"The AccountWatermarks resource provides methods that allow you to obtain, preview and update watermark information.","name":"AccountWatermarks"},{"description":"This object contains details about a payment gateway account.","name":"PaymentGatewayAccounts"},{"description":"","name":"NotaryJournals"},{"description":"The DocuSign Identity Verification process requires a signer to submit an image of their valid government ID and wait for the image to be uploaded and verified before they can access a document.\n\nIdentity Verification supports government photo IDs and European eIDs, analyzing the document security features and matching the name on the agreement against the name on the ID. After a successful verification, the signer can view the agreement and sign as usual.\n\nTo use Identity Verification, the [DocuSign Identity Verification](https://www.docusign.com/products/identify) product must be enabled for your account.\n\nFor more information, see [Digital ID Verification of Government-Issued IDs](https://www.docusign.com/blog/can-i-see-a-photo-of-your-id-digital-verification-of-real-world-ids).","name":"IdentityVerifications"},{"description":"","name":"EnvelopeDocumentHtmlDefinitions"},{"description":"**Note:** Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true.** \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager.","name":"DocumentResponsiveHtmlPreview"},{"description":"","name":"EnvelopeHtmlDefinitions"},{"description":"**Note:** Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true.** \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager.","name":"ResponsiveHtmlPreview"},{"description":"**Note:** Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true.** \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager.","name":"TemplateDocumentResponsiveHtmlPreview"},{"description":"**Note:** Responsive Signing is disabled by default. To use this functionality, an account administrator must switch the account setting `enableResponsiveSigning` to **true.** \nAlso note that Smart Sections (creating a signable HTML document that uses collapsible sections and rotating tables) are premium features. To request them, contact your DocuSign account manager.","name":"TemplateResponsiveHtmlPreview"},{"description":"","name":"TemplateDocumentHtmlDefinitions"},{"description":"","name":"TemplateHtmlDefinitions"},{"description":"Envelope transfer rules enable administrators to transfer envelopes and templates from user to another. For example, you might do this when an employee leaves the company. To transfer ownership of envelopes and templates, the **Transfer Custody** feature must be enabled for your account.\n\nFor more information about this functionality, see [Transfer Envelopes and Templates](https://support.docusign.com/en/guides/ndse-admin-guide-transfer-envelopes-templates).","name":"EnvelopeTransferRules"},{"description":"DocuSign eSignature provides email notifications to senders and recipients for many different scenarios. By default, all notification options are turned on. Notification preferences give you control over the communications that you receive. For more information, see [Manage Notifications](https://support.docusign.com/en/guides/ndse-user-guide-manage-notifications).","name":"NotificationDefaults"},{"description":"You can use bulk send lists send documents to a large number of recipients on a\nrecurring basis. You can use a bulk send list to send up to 1,000 copies at a time.\n\nAfter you create a bulk send list, it persists and can be reused and edited any number of times.\n\nYou can customize individual copies of the envelope. For example, you can customize the email notification and\nlanguage and add personalized notes.\n\n### Requirements and limitations\n\n* Bulk send must be enabled for your account. To enable this feature, contact your Account Manager or Business Development representative.\n* You can include up to 1,000 bulk recipients in each request.\n* When you send an envelope with bulk recipients, envelopes are added to a bulk recipient queue and sent in a metered fashion.\n An account can have a total of 2,000 total envelopes in the queue at a time.\n If you reach this limit, you will get an error message. Wait and resend the envelope at a later time.\n If you hit queue limits often, contact your Account Manager to see about modifying the queue limits for your account.\n\n### Related topics\n\n- [Bulk sending envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/bulk-send/) concept guide\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n","name":"BulkSend"},{"description":"You can configure automatic archiving of emails sent from all of your DocuSign accounts.\n\nFor more information, see [Email Archive Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-email-archive-configuration).\n\n**Note:** This feature is only available for certain account plans and must be enabled by DocuSign.","name":"BCCEmailArchive"},{"description":"This resource has been deprecated.","name":"TabsBlob"},{"description":"The comments resource provides a method that enables you to download a PDF file containing all of the comments that recipients and the sender have added to the documents in an envelope.\n\nComments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**). \n\nFor more information, see [Comments Settings](https://support.docusign.com/en/guides/ndse-admin-guide-comments-settings).","name":"Comments"},{"description":"The FavoriteTemplates resource enables you to get, add, and remove favorite templates.\n\n### Related topics\n\n- [Common API Tasks: Working With Favorite Templates](https://www.docusign.com/blog/developers/common-api-tasks-working-favorite-templates)","name":"FavoriteTemplates"},{"description":"DocuSign eNotary makes the notarization process fully digital\nfor senders, signers, and notaries.\nIt enables a notary public to act as an in-person witness\nto electronic signing of documents.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources)\nto see which jurisdictions are supported.\n\n","name":"Notary"},{"description":"Creating, updating, and deleting notary jurisdiction objects.","name":"NotaryJurisdiction"},{"description":"Describes the workflow for an envelope or template. These methods enable you to use the [scheduled sending](/docs/esign-rest-api/esign101/concepts/recipients/scheduled-sending/) and [delayed routing](/docs/esign-rest-api/esign101/concepts/recipients/delayed-routing/) features.\n","name":"EnvelopeWorkflowDefinition"},{"description":"In certain countries, stamps are used to certify documents. This resource provides methods to manage stamps available in your account.\n\nTo use these endpoints, your account must have Managed Stamps enabled. Contact your DocuSign account manager for more information.\n\n### Related topics\n- [Sending and Signing with eHanko](https://support.docusign.com/s/articles/Sending-and-Signing-with-eHanko?language=en_US&rsc_301)\n- [DocuSign eSignature Admin Guide: Stamps](https://support.docusign.com/s/document-item?language=en_US&rsc_301=&bundleId=pik1583277475390&topicId=cex1583277417267.html&_LANG=enus)","name":"AccountSignatures"},{"description":"","name":"ConnectSecret"},{"description":"","name":"DocumentResponsiveHtml"},{"description":"","name":"ResponsiveHtml"},{"description":"","name":"ReservedDomains"},{"description":"The EnvelopePublish resource provides a method for submitting existing envelopes to a webhook using an ad hoc Connect configuration. See the [Connect category](/docs/esign-rest-api/reference/connect/) for related endpoints.","name":"EnvelopePublish"},{"description":"","name":"DocumentGeneration"},{"description":"","name":"Authorizations"}],"paths":{"/service_information":{"get":{"deprecated":false,"description":"Retrieves the available REST API versions.\n\nDocuSign Production system: https://www.docusign.net/restapi/service_information\nDocuSign Demo system: https://demo.docusign.net/restapi/service_information\n\nYou do not need an integration key to view the REST API versions and resources.","operationId":"ServiceInformation_GetServiceInformation","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/serviceInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves the available REST API versions.","tags":["Services"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getService","x-ds-service":"Diagnostics"},"parameters":[]},"/v2.1":{"get":{"deprecated":false,"description":"Retrieves the base resources available for the eSignature REST API.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\n","operationId":"ServiceInformation_GetResourceInformation","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/resourceInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Lists resources for REST version specified","tags":["Resources"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getResources","x-ds-service":"Diagnostics"},"parameters":[]},"/v2.1/accounts":{"parameters":[],"post":{"deprecated":false,"description":"Creates new DocuSign accounts.\nYou can use this method to create\na single account\nor up to 100 accounts at a time.\n\n**Note:** This method is restricted to partner integrations.\nYou must work with DocuSign Professional Services\nor DocuSign Business Development,\nwho will provide you with the Distributor Code\nand Distributor Password\nthat you need to include in the request body.\n\n\nWhen creating a single account,\nthe body of the request is a\n[`newAccountRequest`][newAccountRequest]\nobject.\n\nExample:\n\n```\n{\n \"newAccountRequest\": [\n {\n \"accountName\":\"Test Account\",\n \"distributorCode\":\"MY_DIST_CODE\",\n \"distributorPassword\":\"MY_DIST_PWD\",\n \"initialUser\":{\n \"email\":\"user@emaildomain.com\",\n \"firstName\":\"John\",\n \"middleName\": \"Harry\",\n \"lastName\":\"Doe\",\n \"suffixName\": \"\",\n \"userName\": \"John Doe\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Test Company\"\n },\n \"addressInformation\":{\n \"address1\": \"1234 Main Street\",\n \"address2\": \"Suite 100\",\n \"city\": \"Seattle\",\n \"state\": \"WA\",\n \"postalCode\": \"98101\",\n \"country\": \"US\",\n \"phone\": \"1234567890\",\n \"fax\": \"1234567891\"\n },\n \"planInformation\":{\n \"planId\":\"37085696-xxxx-xxxx-xxxx-7ea067752959\"\n },\n \"referralInformation\":{\n \"includedSeats\": \"1\",\n \"referralCode\": \"code\",\n \"referrerName\": \"name\"\n }\n }\n ]\n}\n\n```\nIf the request succeeds,\nit returns a\n201 (Created) HTTP response code.\nThe response returns the new account ID, password, and the default user\ninformation for each newly created account.\n\n\nWhen creating multiple accounts,\nthe body of the request is a\n`newAccountRequests`\nobject,\nwhich contains one or more\n[`newAccountDefinition`][newAccountDefinition]\nobjects.\nYou can create up to 100 new accounts\nat a time this way.\n\nThe body for a multi-account\ncreation request\nlooks like this in JSON:\n\n```\n{\n \"newAccountRequests\": [\n {\n \"accountName\": \"accountone\",\n . . .\n },\n {\n \"accountName\": \"accounttwo\",\n . . .\n }\n ]\n}\n```\n\nA multi-account request\nlooks like this in XML:\n\n```\n\n \n \n . . .\n \n \n . . .\n \n \n\n```\n\nA multi-account creation request\nmay succeed (report a 201 code)\neven if some accounts could not be created.\nIn this case, the `errorDetails` property\nin the response contains specific information\nabout the failure.\n\n\n\n[newAccountDefinition]: #/definitions/newAccountDefinition\n[nameValue]: #/definitions/nameValue\n[newAccountRequest]: #/definitions/newAccountRequest\n","operationId":"Accounts_PostAccounts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/newAccountDefinition"}}}},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/newAccountSummary"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates new accounts.","tags":["Accounts"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"create","x-ds-service":"Accounts"}},"/v2.1/accounts/provisioning":{"get":{"deprecated":false,"description":"Retrieves the account provisioning information for the account.","operationId":"Accounts_GetProvisioning","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/provisioningInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves the account provisioning information for the account.","tags":["Accounts"],"x-ds-in-sdk":true,"x-ds-method":"getProvisioning","x-ds-methodname":"getProvisioning","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}":{"delete":{"deprecated":false,"description":"This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.","operationId":"Accounts_DeleteAccount","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes the specified account.","tags":["Accounts"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"delete","x-ds-service":"Accounts"},"get":{"deprecated":false,"description":"Retrieves the account information for the specified account.","operationId":"Accounts_GetAccount","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"When **true,** includes account settings in the response. The default value is **false.**","in":"query","name":"include_account_settings","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/accountInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves the account information for the specified account.","tags":["Accounts"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"GetAccountInformation","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_charges":{"get":{"deprecated":false,"description":"Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. \n\nPrivileges required: account administrator ","operationId":"BillingCharges_GetAccountBillingCharges","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Specifies which billing charges to return.\nValid values are:\n\n* envelopes\n* seats\n","in":"query","name":"include_charges","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingChargeResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets list of recurring and usage charges for the account.","tags":["Accounts"],"x-ds-in-sdk":true,"x-ds-method":"getBillingCharges","x-ds-methodname":"getBillingCharges","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_invoices":{"get":{"deprecated":false,"description":"Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.\n\nPrivileges required: account administrator ","operationId":"BillingInvoices_GetBillingInvoices","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Specifies the date/time of the earliest invoice in the account to retrieve.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"Specifies the date/time of the latest invoice in the account to retrieve.","in":"query","name":"to_date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingInvoicesResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Get a List of Billing Invoices","tags":["Invoices"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listInvoices","x-ds-service":"Billing"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}":{"get":{"deprecated":false,"description":"Retrieves the specified invoice.\n\n**Note:** If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.\n\nPrivileges required: account administrator\n\nThe response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.\n\n**Response**\nThe following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |","operationId":"BillingInvoices_GetBillingInvoice","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the invoice.","in":"path","name":"invoiceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingInvoice"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves a billing invoice.","tags":["Invoices"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getInvoice","x-ds-service":"Billing"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_invoices_past_due":{"get":{"deprecated":false,"description":"Returns a list past due invoices for the account and notes if payment can be made through the REST API. \n\nPrivileges Required: account administrator","operationId":"BillingInvoices_GetBillingInvoicesPastDue","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingInvoicesSummary"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Get a list of past due invoices.","tags":["Invoices"],"x-ds-in-sdk":true,"x-ds-method":"listPastDue","x-ds-methodname":"listInvoicesPastDue","x-ds-service":"Billing"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_payments":{"get":{"deprecated":false,"description":"Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. \n\nPrivileges required: account administrator ","operationId":"BillingPayments_GetPaymentList","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Specifies the date/time of the earliest payment in the account to retrieve.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"Specifies the date/time of the latest payment in the account to retrieve.","in":"query","name":"to_date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingPaymentsResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets payment information for one or more payments.","tags":["Payments"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listPayments","x-ds-service":"Billing"},"parameters":[],"post":{"deprecated":false,"description":"Posts a payment to a past due invoice.\n\nThis method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [Billing::listInvoicesPastDue](/docs/esign-rest-api/reference/billing/invoices/listpastdue/).\n\nThe response returns information for a single payment\nif a payment ID was used in the endpoint, or a list of payments.\nIf the from date or to date queries or payment ID are not used,\nthe response returns payment information for the last 365 days.\n\nIf the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.\n\nPrivileges required: account administrator\n","operationId":"BillingPayments_PostPayment","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPaymentRequest"}}}},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingPaymentResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Posts a payment to a past due invoice.","tags":["Payments"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"makePayment","x-ds-service":"Billing"}},"/v2.1/accounts/{accountId}/billing_payments/{paymentId}":{"get":{"deprecated":false,"description":"Retrieves the information for a specified payment. \n\nPrivileges required: account administrator ","operationId":"BillingPayments_GetPayment","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the payment.","in":"path","name":"paymentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingPaymentItem"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets billing payment information for a specific payment.","tags":["Payments"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getPayment","x-ds-service":"Billing"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_plan":{"get":{"deprecated":false,"description":"Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false.**\n\nResponse\n\nThe response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing: getBillingPlan](/docs/esign-rest-api/reference/billing/billingplans/get/) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing: updatePlan](/docs/esign-rest-api/reference/billing/billingplans/update/) reference.\n\n**Note:** When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.\n","operationId":"BillingPlan_GetBillingPlan","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"When **true,** payment information including credit card information will show in the return.","in":"query","name":"include_credit_card_information","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"include_downgrade_information","required":false,"schema":{"type":"string"}},{"description":"When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to the `billingAddress` information. ","in":"query","name":"include_metadata","required":false,"schema":{"type":"string"}},{"description":"When **true,** excludes successor information from the response.","in":"query","name":"include_successor_plans","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"include_tax_exempt_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/accountBillingPlanResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Get Account Billing Plan","tags":["BillingPlans"],"x-ds-in-sdk":true,"x-ds-method":"getAccountPlan","x-ds-methodname":"getPlan","x-ds-service":"Billing"},"parameters":[],"put":{"deprecated":false,"description":"Updates the billing plan information, billing address, and credit card information for the specified account.","operationId":"BillingPlan_PutBillingPlan","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"When **true,** updates the account using a preview billing plan.","in":"query","name":"preview_billing_plan","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPlanInformation"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/billingPlanUpdateResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates an account billing plan.","tags":["BillingPlans"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updatePlan","x-ds-service":"Billing"}},"/v2.1/accounts/{accountId}/billing_plan/credit_card":{"get":{"deprecated":false,"description":"This method returns information about a credit card associated with an account.","operationId":"BillingPlan_GetCreditCardInfo","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/creditCardInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Get credit card information","tags":["BillingPlans"],"x-ds-in-sdk":true,"x-ds-method":"getCreditCard","x-ds-methodname":"getCreditCardInfo","x-ds-service":"Billing"},"parameters":[]},"/v2.1/accounts/{accountId}/billing_plan/downgrade":{"get":{"deprecated":false,"description":"","operationId":"BillingPlan_GetDowngradeRequestBillingInfo","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/downgradRequestBillingInfoResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns downgrade plan information for the specified account.","tags":["BillingPlans"],"x-ds-in-sdk":true,"x-ds-method":"getDowngradeRequestBillingInfo","x-ds-methodname":"getDowngradeRequestBillingInfo","x-ds-service":"Uncategorized"},"parameters":[],"put":{"deprecated":false,"description":"","operationId":"BillingPlan_PutDowngradeAccountBillingPlan","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/downgradeBillingPlanInformation"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/downgradePlanUpdateResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Queues downgrade billing plan request for an account.","tags":["BillingPlans"],"x-ds-in-sdk":true,"x-ds-method":"updateDowngradeAccountBillingPlan","x-ds-methodname":"updateDowngradeAccountBillingPlan","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes":{"parameters":[],"put":{"deprecated":false,"description":"Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.","operationId":"PurchasedEnvelopes_PutPurchasedEnvelopes","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/purchasedEnvelopesInformation"}}}},"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Reserved: Purchase additional envelopes.","tags":["BillingPlans"],"x-ds-in-sdk":true,"x-ds-method":"purchaseEnvelopes","x-ds-methodname":"purchaseEnvelopes","x-ds-service":"Billing"}},"/v2.1/accounts/{accountId}/brands":{"delete":{"deprecated":false,"description":"This method deletes one or more brand profiles from an account, based on the brand IDs that you include in the `brandsRequest`.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n","operationId":"Brands_DeleteBrands","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/brandsRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountBrands"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes one or more brand profiles.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"deleteList","x-ds-methodname":"deleteBrands","x-ds-service":"Accounts"},"get":{"deprecated":false,"description":"This method returns details about all of the brands associated with an account,\nincluding the default brand profiles.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n","operationId":"Brands_GetBrands","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"When **true,** excludes distributor brand information from the response set.","in":"query","name":"exclude_distributor_brand","required":false,"schema":{"type":"string"}},{"description":"When **true,** returns the logos associated with the brand.","in":"query","name":"include_logos","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountBrands"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a list of brands.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listBrands","x-ds-service":"Accounts"},"parameters":[],"post":{"deprecated":false,"description":"This method creates one or more brand profile files for an account.\n\nTo specify logos for the brand,\nuse the\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)\nmethod\nafter you create the brand.\n\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n","operationId":"Brands_PostBrands","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/brand"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountBrands"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates one or more brand profiles for an account.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createBrand","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/brands/{brandId}":{"delete":{"deprecated":false,"description":"This method deletes a brand from an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"Brand_DeleteBrand","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a brand.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteBrand","x-ds-service":"Accounts"},"get":{"deprecated":false,"description":"This method returns details about an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"Brand_GetBrand","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"When **true,** the landing pages and links associated with the brand are included in the response.","in":"query","name":"include_external_references","required":false,"schema":{"type":"string"}},{"description":"When **true,** the URIs for the logos associated with the brand are included in the response.","in":"query","name":"include_logos","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/brand"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets information about a brand.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getBrand","x-ds-service":"Accounts"},"parameters":[],"put":{"deprecated":false,"description":"This method updates an account brand. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"Brand_PutBrand","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is **false.**","in":"query","name":"replace_brand","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/brand"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/brand"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates an existing brand.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateBrand","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/brands/{brandId}/file":{"get":{"deprecated":false,"description":"This method exports information about a brand to an XML file.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"BrandExport_GetBrandExportFile","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Exports a brand.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"getExportFile","x-ds-methodname":"getBrandExportFile","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}":{"delete":{"deprecated":false,"description":"This method deletes a single logo from an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"BrandLogo_DeleteBrandLogo","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"The type of logo. Valid values are:\n\n- `primary` \n- `secondary` \n- `email`","in":"path","name":"logoType","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a brand logo.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"deleteLogo","x-ds-methodname":"deleteBrandLogoByType","x-ds-service":"Accounts"},"get":{"deprecated":false,"description":"This method returns a specific logo that is used in a brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"BrandLogo_GetBrandLogo","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"The type of logo. Valid values are:\n\n- `primary` \n- `secondary` \n- `email`","in":"path","name":"logoType","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"Successful response."},"400":{"content":{"image/png":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a brand logo.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"getLogo","x-ds-methodname":"getBrandLogoByType","x-ds-service":"Accounts"},"parameters":[],"put":{"deprecated":false,"description":"This method updates a single brand logo.\n\nYou pass in the new version of the resource in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"BrandLogo_PutBrandLogo","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"The type of logo. Valid values are:\n\n- `primary` \n- `secondary` \n- `email`","in":"path","name":"logoType","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places","required":true},"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates a brand logo.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"updateLogo","x-ds-methodname":"updateBrandLogoByType","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/brands/{brandId}/resources":{"get":{"deprecated":false,"description":"This method returns metadata about the branding resources that are associated with an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"BrandResources_GetBrandResourcesList","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/brandResourcesList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns metadata about the branding resources for an account.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"listResources","x-ds-methodname":"getBrandResources","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}":{"get":{"deprecated":false,"description":"This method returns a specific branding resource file.\n\nA brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.\n\n**Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","operationId":"BrandResources_GetBrandResources","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"The type of brand resource file to return. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`","in":"path","name":"resourceContentType","required":true,"schema":{"type":"string"}},{"description":"The ISO 3166-1 alpha-2 codes for the languages that the brand supports.","in":"query","name":"langcode","required":false,"schema":{"type":"string"}},{"description":"Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements that you modified are returned.","in":"query","name":"return_master","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns a branding resource file.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"getResource","x-ds-methodname":"getBrandResourcesByContentType","x-ds-service":"Accounts"},"parameters":[],"put":{"deprecated":false,"description":"This method updates a branding resource file.\n\nYou pass in the new version of the resource file in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\n\n**Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed.\n\nWhen you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.","operationId":"BrandResources_PutBrandResources","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the brand.","in":"path","name":"brandId","required":true,"schema":{"type":"string"}},{"description":"The type of brand resource file that you are updating. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`","in":"path","name":"resourceContentType","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file.xml":{"description":"Brand resource XML file.","format":"binary","type":"string"}},"required":["file.xml"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/brandResources"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates a branding resource file.","tags":["AccountBrands"],"x-ds-in-sdk":true,"x-ds-method":"updateResource","x-ds-methodname":"updateBrandResourcesByContentType","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/bulk_send_batch":{"get":{"deprecated":false,"description":"Returns a summary of bulk send batches.\n\nUse the `batch_ids` query parameter to narrow the list of batches.","operationId":"BulkSendV2Batch_GetBulkSendBatches","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"A comma-separated list of batch IDs to query.","in":"query","name":"batch_ids","required":false,"schema":{"type":"string"}},{"description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`
\nDefault: `100`","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"Use this parameter to search for specific text.","in":"query","name":"search_text","required":false,"schema":{"type":"string"}},{"description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n","in":"query","name":"start_position","required":false,"schema":{"type":"string"}},{"description":"The kind of results to collect. Must be one of:\n\n- all\n- failed\n- sent\n- queued","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","in":"query","name":"to_date","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"user_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendBatchSummaries"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns a list of bulk send batch summaries. ","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"getBulkSendBatches","x-ds-methodname":"getBulkSendBatches","x-ds-service":"Uncategorized"},"parameters":[]},"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}":{"get":{"deprecated":false,"description":"Gets the general status of a specific bulk send batch such as:\n\n- number of successes\n- number pending\n- number of errors\n\nThe `bulkErrors` property of the response object contains more information about the errors.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n","operationId":"BulkSendV2Batch_GetBulkSendBatchStatus","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The batch ID.","in":"path","name":"bulkSendBatchId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendBatchStatus"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the status of a specific bulk send batch.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"getBulkSendBatchStatus","x-ds-methodname":"getBulkSendBatchStatus","x-ds-service":"Uncategorized"},"parameters":[],"put":{"deprecated":false,"description":"Updates the name of a bulk send batch.","operationId":"BulkSendV2Batch_PutBulkSendBatchStatus","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The batch ID.","in":"path","name":"bulkSendBatchId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchRequest"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendBatchStatus"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates the name of a bulk send batch.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"updateBulkSendBatchStatus","x-ds-methodname":"updateBulkSendBatchStatus","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes":{"get":{"deprecated":false,"description":"This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.","operationId":"BulkSendV2Envelopes_GetBulkSendBatchEnvelopes","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The batch ID.","in":"path","name":"bulkSendBatchId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `1000`\n","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"When `recipients`, only envelopes with recipient nodes will be included in the response.","in":"query","name":"include","required":false,"schema":{"type":"string"}},{"description":"The order in which to sort the results. Valid values are:\n\n- Descending order: `desc` (default)\n- Ascending order: `asc`","in":"query","name":"order","required":false,"schema":{"type":"string"}},{"description":"The envelope attribute used to sort the results. Valid values are:\n\n- `created` (default)\n- `completed`\n- `last_modified`\n- `sent`\n- `status`\n- `subject`\n- `status_changed`","in":"query","name":"order_by","required":false,"schema":{"type":"string"}},{"description":"Use this parameter to search for specific text.","in":"query","name":"search_text","required":false,"schema":{"type":"string"}},{"description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n","in":"query","name":"start_position","required":false,"schema":{"type":"string"}},{"description":"Comma-separated list of envelope statuses.\n\nNote that `any` should not be included with other statuses. In other words, `any` is a valid parameter value, but `any,sent` is not.\n\nUse the value `deliveryfailure` to get all envelopes with `AuthFailed` and `AutoResponded` status. This value is specific to bulk sending.","in":"query","name":"status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets envelopes from a specific bulk send batch.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"getBulkSendBatchEnvelopes","x-ds-methodname":"getBulkSendBatchEnvelopes","x-ds-service":"Uncategorized"},"parameters":[]},"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}":{"parameters":[],"put":{"deprecated":false,"description":"Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.","operationId":"BulkSendV2Batch_PutBulkSendBatchAction","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The action to apply. Valid values:\n* `resend`\n* `correct`\n* `void`\n","in":"path","name":"bulkAction","required":true,"schema":{"type":"string"}},{"description":"The batch ID.","in":"path","name":"bulkSendBatchId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchActionRequest"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendBatchStatus"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Applies a bulk action to all envelopes from a specified bulk send.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"updateBulkSendBatchAction","x-ds-methodname":"updateBulkSendBatchAction","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/bulk_send_lists":{"get":{"deprecated":false,"description":"This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.","operationId":"BulkSendV2CRUD_GetBulkSendLists","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendingListSummaries"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets bulk send lists.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"getBulkSendLists","x-ds-methodname":"getBulkSendLists","x-ds-service":"Uncategorized"},"parameters":[],"post":{"deprecated":false,"description":"This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n### Errors\n\n| Error code | Description |\n| :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |\n| BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |\n| BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |\n| BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient. |\n| BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. |\n| BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. |\n| BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. |\n| BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. |\n| BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |\n| BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |\n| BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |\n| BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |\n| BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |\n| BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. |\n| BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. |\n| BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |","operationId":"BulkSendV2CRUD_PostBulkSendList","parameters":[{"description":"The ID of the account.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/bulkSendingList"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a bulk send list.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"createBulkSendList","x-ds-methodname":"createBulkSendList","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}":{"delete":{"deprecated":false,"description":"This method deletes a bulk send list.","operationId":"BulkSendV2CRUD_DeleteBulkSendList","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","in":"path","name":"bulkSendListId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendingListSummaries"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a bulk send list.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"deleteBulkSendList","x-ds-methodname":"deleteBulkSendList","x-ds-service":"Uncategorized"},"get":{"deprecated":false,"description":"This method returns all of the details associated with a specific bulk send list that belongs to the current user.","operationId":"BulkSendV2CRUD_GetBulkSendList","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","in":"path","name":"bulkSendListId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a specific bulk send list.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"getBulkSendList","x-ds-methodname":"getBulkSendList","x-ds-service":"Uncategorized"},"parameters":[],"put":{"deprecated":false,"description":"This method replaces the definition of an existing bulk send list.","operationId":"BulkSendV2CRUD_PutBulkSendList","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","in":"path","name":"bulkSendListId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/bulkSendingList"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates a bulk send list.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"updateBulkSendList","x-ds-methodname":"updateBulkSendList","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send":{"parameters":[],"post":{"deprecated":false,"description":"This method initiates the bulk send process. It generates a bulk send request based on an [existing bulk send list][create_list] and an envelope or template.\n\nConsider using the [BulkSend::createBulkSendTestRequest][create_test] method to test your bulk send list for compatibility with the envelope or template that you want to send first. To learn about the complete bulk send flow, see the [Bulk Send overview][BulkSendOverview].\n\nIf the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.\n\n**Note:** Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n\n### Errors\n\nThis method returns the following errors:\n\n| Error code | Description |\n| :--------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than {0} copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |\n| BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |\n| BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support. |\n| BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later.\" .Try again later, or contact DocuSign Support to request a higher tier. |\n| BULK_SEND_ENVELOPE_NOT_FOUND | Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |\n| BULK_SEND_LIST_NOT_FOUND | Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |\n| BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up. |\n| BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |\n| BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible. |\n| BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope. |\n| BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |\n| BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_TAB_DOES_NOT_MATCH | Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |\n\n[create_list]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/\n[create_test]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendtestrequest/\n[BulkSendOverview]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/\n\n","operationId":"BulkSendV2Send_PostBulkSendRequest","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","in":"path","name":"bulkSendListId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/bulkSendRequest"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a bulk send request.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"createBulkSendRequest","x-ds-methodname":"createBulkSendRequest","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test":{"parameters":[],"post":{"deprecated":false,"description":"This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first.\n\nA successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred.\n\nIf the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method.\n\n## Envelope Compatibility Checks\n\nThis section describes the envelope compatibility checks that the system performs.\n\n**Top-Level Issues**\n\n- Envelopes must be in a sendable state.\n- The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.\n- The envelope must not be null and must be visible to the current user.\n- The account cannot have more queued envelopes than the maximum number configured for the account.\n- The bulk send list must exist.\n\n**Recipients**\n\n- The envelope must have recipients.\n- If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.\n- The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign's bulk send\n functionality).\n\n**Recipient Tabs**\n\n- Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.\n\n**Custom Fields**\n\n- Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the\n envelope definition. You do not have to match the recipient-level custom fields.\n\n[BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/\n\n\n","operationId":"BulkSendV2Test_PostBulkSendTestRequest","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","in":"path","name":"bulkSendListId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/bulkSendRequest"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/bulkSendTestResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a bulk send test.","tags":["BulkSend"],"x-ds-in-sdk":true,"x-ds-method":"createBulkSendTestRequest","x-ds-methodname":"createBulkSendTestRequest","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}":{"delete":{"deprecated":false,"description":"This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.","operationId":"CaptiveRecipients_DeleteCaptiveRecipientsPart","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Signature is the only supported value. ","in":"path","name":"recipientPart","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/captiveRecipientInformation"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/captiveRecipientInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes the signature for one or more captive recipient records.","tags":["Accounts"],"x-ds-in-sdk":true,"x-ds-method":"deleteCaptiveRecipient","x-ds-methodname":"deleteCaptiveRecipient","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}/chunked_uploads":{"parameters":[],"post":{"deprecated":false,"description":"This method initiates a new chunked upload with the first part of the content.","operationId":"ChunkedUploads_PostChunkedUploads","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/chunkedUploadRequest"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Initiate a new chunked upload.","tags":["ChunkedUploads"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createChunkedUpload","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}":{"delete":{"deprecated":false,"description":"Deletes a chunked upload that has been committed but not yet consumed.\n\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\n\n\n- Chunked uploads that have been consumed by use in another API call.\n- Expired chunked uploads.\n\n**Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.","operationId":"ChunkedUploads_DeleteChunkedUpload","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the chunked upload. ","in":"path","name":"chunkedUploadId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a chunked upload.","tags":["ChunkedUploads"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteChunkedUpload","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Returns the details (but not the content) about a chunked upload.\n\n**Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.","operationId":"ChunkedUploads_GetChunkedUpload","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the chunked upload. ","in":"path","name":"chunkedUploadId","required":true,"schema":{"type":"string"}},{"description":"(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves metadata about a chunked upload.","tags":["ChunkedUploads"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getChunkedUpload","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.\n\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\n\n**Note:** After you commit a chunked upload, it no longer accepts additional parts.","operationId":"ChunkedUploads_PutChunkedUploads","parameters":[{"description":"(Required) The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"(Required) The ID of the chunked upload to commit.","in":"path","name":"chunkedUploadId","required":true,"schema":{"type":"string"}},{"description":"(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls.","in":"query","name":"action","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Commit a chunked upload.","tags":["ChunkedUploads"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"commit","x-ds-methodname":"updateChunkedUpload","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}":{"parameters":[],"put":{"deprecated":false,"description":"Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, \nuse this method to upload subsequent parts.\n\nFor simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.\n\nExample:\n\n\n```\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\n```\n\n**Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.","operationId":"ChunkedUploads_PutChunkedUploadPart","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the chunked upload. ","in":"path","name":"chunkedUploadId","required":true,"schema":{"type":"string"}},{"description":"The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`.\n\n**Note:** You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it.","in":"path","name":"chunkedUploadPartSeq","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/chunkedUploadRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Add a chunk to an existing chunked upload.","tags":["ChunkedUploads"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateChunkedUploadPart","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/connect":{"get":{"deprecated":false,"description":"Retrieves all the DocuSign Custom Connect definitions for the specified account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"Connect_GetConnectConfigs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectConfigResults"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Get Connect configuration information.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listConfigurations","x-ds-service":"Connect"},"parameters":[],"post":{"deprecated":false,"description":"Creates a custom Connect configuration for the specified account.\n\nConnect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create:\n* Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users\n* Recipient Connect configurations that are triggered when one or more of your account users receive an envelope\n\nTo set an account-level configuration, set `configurationType` to **custom.**\nTo set a Recipient Connect configuration, set `configurationType` to **customrecipient.**\n\nIf you want to listen for events on only one envelope, use the [eventNotification](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_eventnotification) object instead.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Data models\n\nThere are four possible data models for your Connect configuration. Consider:\n* Do you want the data in JSON or XML?\n* Do you want events sent individually (SIM) or in aggregate?\n\nDocuSign recommends using the [JSON SIM event model](/platform/webhooks/connect/improved-json-sim-event-model/).\n\n\n\n\n

JSON SIM (Recommended)

\n
\n\nSet `deliveryMode` to **SIM** and `eventData.version` to **restv2.1.** Use the `events` property to set the event statuses that will trigger your configuration.\n\nThe following sample request shows how to create an envelope-level configuration using JSON SIM:\n```\n{\n \"configurationType\": \"custom\",\n \"urlToPublishTo\": \"YOUR-WEBHOOK-URL\",\n \"allUsers\": \"true\",\n \"name\": \"jsonSimTest\",\n \"deliveryMode\": \"SIM\",\n \"allowEnvelopePublish\": \"true\",\n \"enableLog\": \"true\",\n \"eventData\": {\n \"version\": \"restv2.1\"\n },\n \"events\": [\n \"envelope-sent\",\n \"envelope-delivered\",\n \"envelope-completed\"\n ]\n}\n```\n\nThe following sample request shows how to create a Recipient Connect configuration using JSON SIM:\n```\n{\n \"configurationType\": \"customrecipient\",\n \"urlToPublishTo\": \"YOUR-WEBHOOK-URL\",\n \"allUsers\": \"true\",\n \"name\": \"jsonSimTest\",\n \"deliveryMode\": \"SIM\",\n \"allowEnvelopePublish\": \"true\",\n \"enableLog\": \"true\",\n \"eventData\": {\n \"version\": \"restv2.1\"\n },\n \"events\": [\n \"recipient-sent\",\n \"recipient-completed\"\n ]\n}\n```\n\n
\n\n\n

JSON Aggregate

\n
\n\nSet `deliveryMode` to **aggregate** and `eventData.version` to **restv2.1.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n
\n\n\n

XML Aggregate

\n
\n\nSet `deliveryMode` to **aggregate.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n
\n\n\n

XML SIM (Legacy apps only)

\n
\n\n**Note:** This model [will be deprecated](https://www.docusign.com/blog/developers/docusign-connect-xml-sim-messaging-format-deprecated). \n\nSet `deliveryMode` to **SIM.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n
\n\n\n## Troubleshooting\n\nIf your configuration is not working, check the following.\n\n* Connect must be enabled for your account to use this function.\n* If you are using `envelopeEvents` or `recipientEvents`, make sure that the event values are sentence case, not lowercase.\n* Make sure you have either set `allUsers` to **true** or set `userIds` to a non-empty array of IDs.\n* By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter `allowEnvelopePublish` to **true.** You can also enable the configuration in the UI.\n* To check if events are being emitted, set `enableLog` to **true** to view event logs in the Connect console.\n\n## Related topics\n\n* For more information about Connect, see the [DocuSign Connect guide](/platform/webhooks/connect/).\n* Use the MyAPICalls sample app to see an [example of this endpoint](https://myapicalls.sampleapps.docusign.com/scenario/6) using the JSON SIM model.","operationId":"Connect_PostConnectConfiguration","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/connectCustomConfiguration"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectCustomConfiguration"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a Connect configuration.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createConfiguration","x-ds-service":"Connect"},"put":{"deprecated":false,"description":"Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the `allowEnvelopePublish` property to **true.**\n\nAfter any updates, test your configuration to make sure it works as expected.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"Connect_PutConnectConfiguration","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/connectCustomConfiguration"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectCustomConfiguration"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates a specified Connect configuration.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateConfiguration","x-ds-service":"Connect"}},"/v2.1/accounts/{accountId}/connect/envelopes/publish/historical":{"parameters":[],"post":{"deprecated":false,"description":"This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the `urlToPublishTo` request body parameter.\n\nThis endpoint does not call an existing Connect configuration or create a new Connect listener to monitor new activity. It simply uses an ad hoc configuration to submit existing envelopes. You must include all the configuration data in the request body.\n\nThe envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported.\n\nYour request should match the following format:\n\n```\n{\n \"envelopes\": [\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\", \"8373a938-xxxx-xxxx-xxxx-e992a2abae01\"],\n \"config\": {\n \"configurationType\":\"custom\",\n \"name\": \"Test\",\n \"urlToPublishTo\":\"YOUR-WEBHOOK-URL\",\n \"allowEnvelopePublish\": \"true\",\n \"enableLog\": \"true\",\n \"requiresAcknowledgement\": \"true\",\n \"IncludeHMAC\": \"true\",\n \"SignMessageWithX509Cert\": \"true\",\n \"deliveryMode\": \"SIM\",\n \"eventData\": {\n \"version\": \"restv2.1\",\n \"format\": \"json\",\n \"includedata\": [\"tabs\",\"payment_tabs\",\"custom_fields\",\"powerform\",\"recipients\",\"folde rs\",\"extensions\",\"attachments\", \"prefill_tabs\", \"documents\"]\n }\n }\n}\n```\n\nIf the request succeeds, it returns a 201 (Created) HTTP response code and the response body property `processingStatus` will be set to `processing`. You can then view the status of each historical republish request in the [Bulk Actions Log](https://support.docusign.com/s/document-item?language=en_US&bundleId=pik1583277475390&topicId=nvf1648497452396.html&_LANG=enus).","operationId":"HistoricalEnvelopePublish_PostHistoricalEnvelopePublishTransaction","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectHistoricalEnvelopeRepublish"}}}},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopePublishTransaction"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Submits a batch of historical envelopes for republish to a webhook.","tags":["EnvelopePublish"],"x-ds-in-sdk":true,"x-ds-method":"createHistoricalEnvelopePublishTransaction","x-ds-methodname":"createHistoricalEnvelopePublishTransaction","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/connect/envelopes/retry_queue":{"parameters":[],"put":{"deprecated":false,"description":"Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [Connect::listEventLogs](/docs/esign-rest-api/reference/connect/connectevents/list/) retrieve the failure log.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectPublish_PutConnectRetry","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectFailureFilter"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectFailureResults"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Republishes Connect information for multiple envelopes.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"retryForEnvelopes","x-ds-methodname":"retryEventForEnvelopes","x-ds-service":"Connect"}},"/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue":{"parameters":[],"put":{"deprecated":false,"description":"Republishes Connect information for the specified envelope.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectPublish_PutConnectRetryByEnvelope","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectFailureResults"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Republishes Connect information for the specified envelope.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"retryForEnvelope","x-ds-methodname":"retryEventForEnvelope","x-ds-service":"Connect"}},"/v2.1/accounts/{accountId}/connect/failures":{"get":{"deprecated":false,"description":"Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, in order to create a republish request.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectFailures_GetConnectLogs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","in":"query","name":"to_date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectLogs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the Connect failure log information.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"listFailures","x-ds-methodname":"listEventFailureLogs","x-ds-service":"Connect"},"parameters":[]},"/v2.1/accounts/{accountId}/connect/failures/{failureId}":{"delete":{"deprecated":false,"description":"Deletes the Connect failure log information for the specified entry.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectFailures_DeleteConnectFailureLog","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the Connect post failure. Use `all` to delete all failures for the account.","in":"path","name":"failureId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectDeleteFailureResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a Connect failure log entry.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"deleteFailure","x-ds-methodname":"deleteEventFailureLog","x-ds-service":"Connect"},"parameters":[]},"/v2.1/accounts/{accountId}/connect/logs":{"delete":{"deprecated":false,"description":"Deletes a list of Connect log entries for your account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectLog_DeleteConnectLogs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a list of Connect log entries.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"deleteList","x-ds-methodname":"deleteEventLogs","x-ds-service":"Connect"},"get":{"deprecated":false,"description":"Retrieves a list of the 100 most recent connect log entries for your account.\n\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging.\nIf logging is not enabled, then no log entries are recorded.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectLog_GetConnectLogs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","in":"query","name":"to_date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectLogs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the Connect log.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listEventLogs","x-ds-service":"Connect"},"parameters":[]},"/v2.1/accounts/{accountId}/connect/logs/{logId}":{"delete":{"deprecated":false,"description":"Deletes a specified entry from the Connect Log.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectLog_DeleteConnectLog","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the Connect log entry.","in":"path","name":"logId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a specified Connect log entry.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteEventLog","x-ds-service":"Connect"},"get":{"deprecated":false,"description":"Retrieves the specified Connect log entry for your account.\n\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging.\nIf logging is not enabled, then no log entries are recorded.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"ConnectLog_GetConnectLog","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the Connect log entry.","in":"path","name":"logId","required":true,"schema":{"type":"string"}},{"description":"When **true,** the response includes the `connectDebugLog` information.","in":"query","name":"additional_info","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectLog"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a Connect log entry.","tags":["ConnectEvents"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getEventLog","x-ds-service":"Connect"},"parameters":[]},"/v2.1/accounts/{accountId}/connect/oauth":{"delete":{"deprecated":false,"description":"Deletes the Connect OAuth configuration for the specified account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n","operationId":"ConnectOAuthConfig_DeleteConnectOAuthConfig","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Delete the Connect OAuth configuration.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"deleteConnectOAuthConfig","x-ds-methodname":"deleteConnectOAuthConfig","x-ds-service":"Uncategorized"},"get":{"deprecated":false,"description":"Gets the Connect OAuth configuration for the specified account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n","operationId":"ConnectOAuthConfig_GetConnectOAuthConfig","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves the Connect OAuth information for the account.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"getConnectOAuthConfig","x-ds-methodname":"getConnectOAuthConfig","x-ds-service":"Uncategorized"},"parameters":[],"post":{"deprecated":false,"description":"Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server.\n\nWhen you call this endpoint, DocuSign requests an access token from your authorization server. DocuSign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n","operationId":"ConnectOAuthConfig_PostConnectOAuthConfig","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/connectOAuthConfig"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Set up Connect OAuth for the specified account.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"createConnectOAuthConfig","x-ds-methodname":"createConnectOAuthConfig","x-ds-service":"Uncategorized"},"put":{"deprecated":false,"description":"","operationId":"ConnectOAuthConfig_PutConnectOAuthConfig","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/connectOAuthConfig"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates the existing Connect OAuth configuration for the account.\n","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"updateConnectOAuthConfig","x-ds-methodname":"updateConnectOAuthConfig","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/connect/{connectId}":{"delete":{"deprecated":false,"description":"Deletes the specified DocuSign Connect configuration.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n\n","operationId":"Connect_DeleteConnectConfig","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the custom Connect configuration being accessed.","in":"path","name":"connectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes the specified Connect configuration.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteConfiguration","x-ds-service":"Connect"},"get":{"deprecated":false,"description":"Retrieves the information for the specified DocuSign Connect configuration.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n","operationId":"Connect_GetConnectConfig","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the custom Connect configuration being accessed.","in":"path","name":"connectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/connectConfigResults"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the details about a Connect configuration.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getConfiguration","x-ds-service":"Connect"},"parameters":[]},"/v2.1/accounts/{accountId}/connect/{connectId}/all/users":{"get":{"deprecated":false,"description":"Returns all users from the configured Connect service.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"Connect_GetConnectAllUsers","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the custom Connect configuration being accessed.","in":"path","name":"connectId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return.","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"domain_users_only","required":false,"schema":{"type":"string"}},{"description":"Filters returned user records by full email address or a substring of email address.","in":"query","name":"email_substring","required":false,"schema":{"type":"string"}},{"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","in":"query","name":"start_position","required":false,"schema":{"type":"string"}},{"description":"The status of the item.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character.","in":"query","name":"user_name_substring","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/integratedConnectUserInfoList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns all users from the configured Connect service.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"getConnectAllUsers","x-ds-methodname":"getConnectAllUsers","x-ds-service":"Uncategorized"},"parameters":[]},"/v2.1/accounts/{accountId}/connect/{connectId}/users":{"get":{"deprecated":false,"description":"Returns users from the configured Connect service.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.","operationId":"Connect_GetConnectUsers","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the custom Connect configuration being accessed.","in":"path","name":"connectId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\n","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"Filters returned user records by full email address or a substring of email address.","in":"query","name":"email_substring","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"list_included_users","required":false,"schema":{"type":"string"}},{"description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n","in":"query","name":"start_position","required":false,"schema":{"type":"string"}},{"description":"Filters the results by user status.\nYou can specify a comma-separated\nlist of the following statuses:\n\n* ActivationRequired \n* ActivationSent \n* Active\n* Closed \n* Disabled\n","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character.","in":"query","name":"user_name_substring","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/integratedUserInfoList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns users from the configured Connect service.","tags":["ConnectConfigurations"],"x-ds-in-sdk":true,"x-ds-method":"listUsers","x-ds-methodname":"connectUsers","x-ds-service":"Connect"},"parameters":[]},"/v2.1/accounts/{accountId}/consumer_disclosure":{"get":{"deprecated":false,"description":"Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \n\nThis is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.","operationId":"ConsumerDisclosure_GetConsumerDisclosure","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","in":"query","name":"langCode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountConsumerDisclosures"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the default Electronic Record and Signature Disclosure for an account.","tags":["AccountConsumerDisclosures"],"x-ds-in-sdk":true,"x-ds-method":"getDefault","x-ds-methodname":"getConsumerDisclosureDefault","x-ds-service":"Accounts"},"parameters":[]},"/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}":{"get":{"deprecated":false,"description":"Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\n\n**Note:** The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the `langCode` parameter to specify the signer language version that you want to retrieve. ","operationId":"ConsumerDisclosure_GetConsumerDisclosureLangCode","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","in":"path","name":"langCode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountConsumerDisclosures"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the Electronic Record and Signature Disclosure for an account.","tags":["AccountConsumerDisclosures"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getConsumerDisclosure","x-ds-service":"Accounts"},"parameters":[],"put":{"deprecated":false,"description":"Account administrators can use this method to perform the following tasks:\n\n- Customize values in the default disclosure.\n- Switch to a custom disclosure that uses your own text and HTML formatting.\n- Change values in your existing consumer disclosure. \n\nTo specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.\n\n**Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. \n\n## Updating the default disclosure\n\nWhen you update the default disclosure, you can edit all properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure.\n- `esignAgreement`: This property is read-only.\n- `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`.\n- Metadata properties: These properties are read-only.\n\n**Note:** The text of the default disclosure is always in English.\n\n## Switching to a custom disclosure\n\nTo switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. \n\nYou can also edit all of the other properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.\n\n**Important:** When you switch from a default to a custom disclosure, note the following information:\n\n- You will not be able to return to using the default disclosure.\n- Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n## Updating a custom disclosure\n\nWhen you update a custom disclosure, you can update all of the properties except for the following ones:\n\n- `accountEsignId`: This property is read-only. \n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n","operationId":"ConsumerDisclosure_PutConsumerDisclosure","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The code for the signer language version of the disclosure that you want to update. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","in":"path","name":"langCode","required":true,"schema":{"type":"string"}},{"description":"(Optional) When true, the response includes metadata indicating which properties are editable.","in":"query","name":"include_metadata","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates the Electronic Record and Signature Disclosure for an account.","tags":["AccountConsumerDisclosures"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateConsumerDisclosure","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/contacts":{"delete":{"deprecated":false,"description":"This method deletes multiple contacts associated with an account.","operationId":"Contacts_DeleteContacts","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/contactModRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes multiple contacts from an account.","tags":["Contacts"],"x-ds-in-sdk":true,"x-ds-method":"deleteList","x-ds-methodname":"deleteContacts","x-ds-service":"Users"},"parameters":[],"post":{"deprecated":false,"description":"This method adds multiple contacts into a contacts list.","operationId":"Contacts_PostContacts","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/contactModRequest"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Add contacts to a contacts list.","tags":["Contacts"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"postContacts","x-ds-service":"Users"},"put":{"deprecated":false,"description":"This method updates one or more contacts associated with an account.","operationId":"Contacts_PutContacts","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/contactModRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates one or more contacts.","tags":["Contacts"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"putContacts","x-ds-service":"Users"}},"/v2.1/accounts/{accountId}/contacts/{contactId}":{"delete":{"deprecated":false,"description":"This method deletes a contact associated with an account.","operationId":"Contacts_DeleteContactWithId","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of a contact person in the account's address book.","in":"path","name":"contactId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a contact.","tags":["Contacts"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteContactWithId","x-ds-service":"Users"},"get":{"deprecated":false,"description":"This method returns one or more contacts\nassociated with a DocuSign account. You can also\nretrieve contacts from connected [cloud storage][CloudStorage] providers by using the\n`cloud_provider` query parameter. By default,\ncontacts are retrieved from the DocuSign account's\ndefault address book.\n\nTo return a specific contact, use the `contactId`\nquery parameter. To return all contacts associated\nwith an account, omit this parameter.\n\n[CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/","operationId":"Contacts_GetContactById","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of a contact person in the account's address book.\n\n**Note:** To return all contacts, omit this parameter. It is not required.","in":"path","name":"contactId","required":true,"schema":{"type":"string"}},{"description":"(Optional) The cloud provider from which to retrieve the contacts. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)","in":"query","name":"cloud_provider","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/contactGetResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets one or more contacts.","tags":["Contacts"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getContactById","x-ds-service":"Users"},"parameters":[]},"/v2.1/accounts/{accountId}/custom_fields":{"get":{"deprecated":false,"description":"This method returns a list of the envelope and document custom fields associated with an account.","operationId":"AccountCustomFields_GetAccountCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountCustomFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a list of custom fields.","tags":["AccountCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listCustomFields","x-ds-service":"Accounts"},"parameters":[],"post":{"deprecated":false,"description":"This method creates a custom field and makes it available for all new envelopes associated with an account.","operationId":"AccountCustomFields_PostAccountCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"(Optional) When **true,** the new custom field is applied to all of the templates on the account.","in":"query","name":"apply_to_templates","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/customField"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountCustomFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates an account custom field.","tags":["AccountCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createCustomField","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/custom_fields/{customFieldId}":{"delete":{"deprecated":false,"description":"This method deletes an existing account custom field.","operationId":"AccountCustomFields_DeleteAccountCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the custom field.","in":"path","name":"customFieldId","required":true,"schema":{"type":"string"}},{"description":"","in":"query","name":"apply_to_templates","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes an account custom field.","tags":["AccountCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteCustomField","x-ds-service":"Accounts"},"parameters":[],"put":{"deprecated":false,"description":"This method updates an existing account custom field.","operationId":"AccountCustomFields_PutAccountCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the custom field.","in":"path","name":"customFieldId","required":true,"schema":{"type":"string"}},{"description":"","in":"query","name":"apply_to_templates","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/customField"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountCustomFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates an account custom field.","tags":["AccountCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateCustomField","x-ds-service":"Accounts"}},"/v2.1/accounts/{accountId}/envelopes":{"get":{"deprecated":false,"description":"This method lets you\n[search for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/)\nin your accounts.\nA large set of filters let you narrow the scope of your search\nby date,\nby envelope ID,\nor by status codes.\nYour request must include one or more of the following parameters:\n\n* `from_date`\n* `envelope_ids`\n* `transaction_ids`\n\n\nTo avoid unnecessary database queries, the DocuSign\nsignature platform first checks requests to ensure that the\nfilter set supplied does not result in a zero-size response\nbefore querying the database.\n\nFor example, for a request with a `from_to_status` of\n`delivered` and a current `status` of `created,sent`,\nDocuSign will always return an empty list.\nThis is because the request translates to: find the\nenvelopes that were delivered between the `from_date` and\n`to_date` dates that have a current status of `created` or\n`sent`. Since an envelope that has been delivered can\nnever have a status of `created` or `sent`, a zero-size\nresponse would be generated.\nIn this case, DocuSign does not query the database\nand returns an empty list immediately.\n\nGetting envelope status using `transaction_ids` is useful\nfor offline signing situations where it can be used\ndetermine if an envelope was created or not. It can be used\nfor the cases where a network connection was lost, before\nthe envelope status could be returned.\n\n\nThe following table shows the valid current envelope\nstatuses (`status` parameter) for the different status\nqualifiers (`from_to_status` parameter) in the request. If\nthe status and status qualifiers in the API request do not\ncontain any of the values shown in the Valid Current\nStatuses column, then an empty list is returned.\n\nClient applications should check that the statuses (`status`\nparameter) they are requesting make sense for a given\n`from_to_status` parameter value.\n\n| Status Qualifier
(`from_to_status`) | Effective Status Qualifier | Valid Current Statuses |\n| :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- |\n| any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted |\n| delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted |\n| signed | StatusChanged | any, signed, completed, declined, voided, deleted |\n| completed | Completed | any, completed, declined, voided, deleted |\n| declined | StatusChanged | any, declined, voided, deleted |\n| timedout
always return zero results | StatusChanged | any, voided, deleted |\n| voided | Voided | any, voided, deleted |\n| deleted | StatusChanged | any, deleted |\n\n## Extraneous results\n\nIn some cases, a request for a specific envelope status will\ninclude envelopes with additional statuses. For example, in\na request with a `from_date` of 2017-01-01, a `to_date` of\n2017-01-07 and the status qualifier (`from_to_status`) set\nto `delivered`, the response set might contain envelopes\nthat were created during that time period, but not delivered\nduring the time period. As a workaround, check the envelope\nstatus values in the result set as needed.\n\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\n","operationId":"Envelopes_GetEnvelopes","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Specifies the Authoritative Copy Status for the envelopes. Valid values: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.","in":"query","name":"ac_status","required":false,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.\n","in":"query","name":"block","required":false,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.\n","in":"query","name":"cdse_mode","required":false,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.","in":"query","name":"continuation_token","required":false,"schema":{"type":"string"}},{"description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`\n\nExample: If you have an envelope custom field named \"Region\" and you want to search for all envelopes where the value is \"West\" you would use set this parameter to `Region=West`. \n \n","in":"query","name":"custom_field","required":false,"schema":{"type":"string"}},{"description":"Limit results to envelopes\nsent by the account user\nwith this email address.\n\n`user_name` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of `envelopeId` values.","in":"query","name":"envelope_ids","required":false,"schema":{"type":"string"}},{"description":"Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). Valid values are:\n\n- `recipients`\n- `powerforms`\n- `folders`","in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"description":"Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values: \n\n- `awaiting_my_signature`\n- `completed`\n- `draft`\n- `drafts`\n- `expiring_soon`\n- `inbox`\n- `out_for_signature`\n- `recyclebin`\n- `sentitems`\n- `waiting_for_others`","in":"query","name":"folder_ids","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of folder types you want to retrieve envelopes from. Valid values are: \n\n- `normal`\n- `inbox`\n- `sentitems`\n- `draft`\n- `templates`","in":"query","name":"folder_types","required":false,"schema":{"type":"string"}},{"description":"Specifies the date and time\nto start looking for status changes.\nThis parameter is required\nunless `envelopeIds` or `transactionIds`\nare set.\n\n\nAlthough you can use any date format\nsupported by the .NET system library's\n[`DateTime.Parse()`][msoft] function,\nDocuSign recommends\nusing [ISO 8601][] format dates\nwith an explicit time zone offset\nIf you do not provide\na time zone offset,\nthe method uses the server's time zone.\n\nFor example, the following dates and times refer to the same instant:\n\n* `2017-05-02T01:44Z`\n* `2017-05-01T21:44-04:00`\n* `2017-05-01T18:44-07:00`\n\n\n[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"This is the status type checked for in the `from_date`/`to_date` period. If `changed` is specified, then envelopes that changed status during the period are found. If for example, `created` is specified, then envelopes created during the period are found. Default is `changed`. \n\nPossible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.","in":"query","name":"from_to_status","required":false,"schema":{"type":"string"}},{"description":"Specifies additional information to return about the envelopes.\nUse a comma-separated list, such as `folders, recipients` to specify information.\nValid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: Information about the email settings associated with the envelope.\n- `folders`: The folders where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n","in":"query","name":"include","required":false,"schema":{"type":"string"}},{"description":"When **true,** information about envelopes that have been deleted is included in the response.","in":"query","name":"include_purge_information","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of folders that you want want to get envelopes from. Valid values are: \n\n- `normal`\n- `inbox`\n- `sentitems`\n- `draft`\n- `templates`","in":"query","name":"intersecting_folder_ids","required":false,"schema":{"type":"string"}},{"description":"Returns envelopes that were modified prior to the specified date and time. \n\nExample: `2020-05-09T21:56:12.2500000Z`","in":"query","name":"last_queried_date","required":false,"schema":{"type":"string"}},{"description":"Returns envelopes in either ascending (`asc`) or descending (`desc`) order.","in":"query","name":"order","required":false,"schema":{"type":"string"}},{"description":"Sorts results according to a specific property. Valid values are:\n\n- `last_modified`\n- `action_required`\n- `created`\n- `completed`\n- `envelope_name`\n- `expire`\n- `sent`\n- `signer_list`\n- `status`\n- `subject`\n- `user_name`\n- `status_changed`\n- `last_modified`","in":"query","name":"order_by","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of `PowerFormId` values.","in":"query","name":"powerformids","required":false,"schema":{"type":"string"}},{"description":"The time in seconds that the query should run before returning data.","in":"query","name":"query_budget","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"requester_date_format","required":false,"schema":{"type":"string"}},{"description":"Free text search criteria that you can use to filter the list of envelopes that is returned.","in":"query","name":"search_text","required":false,"schema":{"type":"string"}},{"description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n","in":"query","name":"start_position","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of current envelope statuses to included in the response. Possible values are:\n\n* `completed`\n* `created`\n* `declined`\n* `deleted`\n* `delivered`\n* `processing`\n* `sent`\n* `signed`\n* `timedout`\n* `voided`\n\nThe `any` value is equivalent to any status.\n","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Specifies the date and time\nto stop looking for status changes.\nThe default is the current date and time.\n\nAlthough you can use any date format\nsupported by the .NET system library's\n[`DateTime.Parse()`][msoft] function,\nDocuSign recommends\nusing [ISO 8601][] format dates\nwith an explicit time zone offset\nIf you do not provide\na time zone offset,\nthe method uses the server's time zone.\n\nFor example, the following dates and times refer to the same instant:\n\n* `2017-05-02T01:44Z`\n* `2017-05-01T21:44-04:00`\n* `2017-05-01T18:44-07:00`\n\n\n[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601\n","in":"query","name":"to_date","required":false,"schema":{"type":"string"}},{"description":"If included in the query string, this is a comma separated list of envelope `transactionId`s. \n\nIf included in the `request_body`, this is a list of envelope `transactionId`s. \n\n###### Note: `transactionId`s are only valid in the DocuSign system for seven days.\n","in":"query","name":"transaction_ids","required":false,"schema":{"type":"string"}},{"description":"Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid values are:\n\n- `sender`\n- `recipient`\n- `recipient_only`","in":"query","name":"user_filter","required":false,"schema":{"type":"string"}},{"description":"The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.","in":"query","name":"user_id","required":false,"schema":{"type":"string"}},{"description":"Limit results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n","in":"query","name":"user_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Search for specific sets of envelopes by using search filters.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"listStatusChanges","x-ds-methodname":"listStatusChanges","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the DocuSign platform.\n\n\nWith this method you can:\n\n* Create and send an envelope\n with [documents][], [recipients][], and [tabs][].\n* [Create and send an envelope from a template](/docs/esign-rest-api/esign101/concepts/templates/).\n* [Create and send an envelope from\n a combination of documents and templates](/docs/esign-rest-api/esign101/concepts/templates/composite/).\n* Create a draft envelope.\n\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition] object) are required:\n\n| Parameter | Description |\n| :-------- | :---------- |\n| `status` | Set to `sent` to send the envelope to recipients.
Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents` | The [documents][] to be signed. |\n| `recipients` | The email addresses of the envelope [recipients][]. |\n\n\nWhen you create an envelope by using a\n[composite template](/docs/esign-rest-api/esign101/concepts/templates/composite/),\nyou should specify the envelope custom fields in the inline template.\nAny custom fields that you specify at the root level are ignored.\n\nIf the envelope has a workflow definition\nand the `workflowStatus` is `paused`,\nthe envelope will not be sent immediately,\neven if the envelope's `status` is `sent`.\n\n\n### Related topics\n\n[Envelope][envelopes] and [template][templates]\nobjects along with [documents][documents],\n[recipients][recipients], and [tabs][tabs]\nare the five object models at the core of the eSignature API.\nThe [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)\ndescribes how the five object models work together.\n\nThe following how-to articles contain\npractical examples that show you how to\nto\nconfigure this method's\n[`envelopeDefinition`][envelopeDefinition] request body\nto perform common tasks.\n\nRequesting signatures\n\n- [How to request a signature by email](/docs/esign-rest-api/how-to/request-signature-email-remote/)\n- [How to request a signature by email using a template](/docs/esign-rest-api/how-to/request-signature-template-remote/)\n- [How to request a signature by SMS delivery](/docs/esign-rest-api/how-to/request-signature-sms/)\n- [How to request a signature using a composite template](/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/)\n\nRequiring authentication\n\n- [How to require access code authentication for a recipient](/docs/esign-rest-api/how-to/require-access-code-recipient/)\n- [How to require phone authentication for a recipient](/docs/esign-rest-api/how-to/phone-auth/)\n- [How to require knowledge-based authentication (KBA) for a recipient](/docs/esign-rest-api/how-to/knowledge-based-authentication/)\n- [How to require ID verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)\n\nSending envelopes\n\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n- [How to send a request for payment](/docs/esign-rest-api/how-to/request-a-payment/)\n\nSetting tab values\n\n- [How to set envelope tab values](/docs/esign-rest-api/how-to/set-envelope-tab-values/)\n- [How to set tab values in a template](/docs/esign-rest-api/how-to/set-template-tab-values/)\n\nApplying brands\n\n- [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)\n- [How to apply a brand and template to an envelope](/docs/esign-rest-api/how-to/apply-brand-and-template-to-envelope/)\n\nDocuments, conditional recipients, pausing a workflow\n\n- [How to attach documents via binary transfer](/docs/esign-rest-api/how-to/send-binary/)\n- [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/)\n- [How to pause a signature workflow](/docs/esign-rest-api/how-to/pause-workflow/)\n\n\n\n\n\n[addingdocs]: /docs/esign-rest-api/esign101/concepts/envelopes/\n[attachments]: /docs/esign-rest-api/esign101/concepts/documents/attachments/\n[authcopies]: /docs/esign-rest-api/esign101/concepts/documents/authoritative-copies/\n[conoverview]: /docs/esign-rest-api/esign101/concepts/overview/\n[deleting]: /docs/esign-rest-api/esign101/concepts/envelopes/\n[documents]: /docs/esign-rest-api/esign101/concepts/documents/\n[envelopeDefinition]: /docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition\n[envelopes]: /docs/esign-rest-api/esign101/concepts/envelopes/\n[locking]: /docs/esign-rest-api/esign101/concepts/envelopes/lock/\n[payments]: /docs/esign-rest-api/esign101/concepts/tabs/payment/\n[purging]: /docs/esign-rest-api/esign101/concepts/documents/purging/\n[recipients]: /docs/esign-rest-api/esign101/concepts/recipients/\n[recipstatus]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-status\n[reciptypes]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-types\n[supdocs]: /docs/esign-rest-api/esign101/concepts/documents/supplemental/\n[tabanchor]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n[tabcustom]: /docs/esign-rest-api/esign101/concepts/tabs/custom-tabs/\n[tabs]: /docs/esign-rest-api/esign101/concepts/tabs/\n[tabtypes]: /docs/esign-rest-api/esign101/concepts/tabs/\n[templates]: /docs/esign-rest-api/esign101/concepts/templates/\n[tracking]: /docs/esign-rest-api/esign101/concepts/envelopes/\n\n","operationId":"Envelopes_PostEnvelopes","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.\n","in":"query","name":"cdse_mode","required":false,"schema":{"type":"string"}},{"description":"When true, users can define the routing order of recipients while sending documents for signature.","in":"query","name":"change_routing_order","required":false,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.\n","in":"query","name":"completed_documents_only","required":false,"schema":{"type":"string"}},{"description":"When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)\n\n**Note:** DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.","in":"query","name":"merge_roles_on_draft","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/envelopeDefinition"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeSummary"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates an envelope.","tags":["Envelopes"],"x-ds-examples":[{"description":"This example shows a request/response that includes:\n\n* A single PDF document to be signed\n* One tab positioned using anchor text\n* One recipient\n","direction":"both","format":"json","request":{"documents":[{"documentBase64":"[Document content (PDF File)]","documentId":"1","fileExtension":"pdf","name":"NDA.pdf"}],"emailSubject":"Please sign the NDA","recipients":{"signers":[{"email":"the_nda_signer@example.com","name":"Darlene Petersen","recipientId":"1","routingOrder":"1","tabs":{"dateSignedTabs":[{"anchorString":"signer1date","anchorYOffset":"-6","fontSize":"Size12","name":"Date Signed","recipientId":"1","tabLabel":"date_signed"}],"fullNameTabs":[{"anchorString":"signer1name","anchorYOffset":"-6","fontSize":"Size12","name":"Full Name","recipientId":"1","tabLabel":"Full Name"}],"signHereTabs":[{"anchorString":"signer1sig","anchorUnits":"mms","anchorXOffset":"0","anchorYOffset":"0","name":"Please sign here","optional":"false","recipientId":"1","scaleValue":1,"tabLabel":"signer1sig"}]}}]},"status":"sent"},"response":{"envelopeId":"63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80","status":"sent","statusDateTime":"2025-08-15T13:52:51.651Z","uri":"/envelopes/63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80"},"style":"custom","title":"Request Signature on Single Document by Email"},{"description":"This example shows a request/response that includes:\n\n* Multiple documents, both pdf and Word docx files.\n* Multiple tabs including signing, fullName, dateSigned, and text tabs.\n* Tabs positioned using anchor text.\n* Two recipients, a signer and a cc recipient.\n","direction":"both","format":"json","request":{"documents":[{"documentBase64":"[Document 1 content (PDF File)]","documentId":"1","fileExtension":"pdf","name":"NDA.pdf"},{"documentBase64":"[Document 2 content (PDF File)]","documentId":"2","fileExtension":"pdf","name":"House.pdf"},{"documentBase64":"[Document 3 content (Word file)]","documentId":"3","fileExtension":"docx","name":"contractor_agreement.docx"}],"emailSubject":"Please sign the house documentation package","recipients":{"carbonCopies":[{"email":"cody_vigil@worldwidecorp.example.com","name":"Cody Vigil","recipientId":"2","routingOrder":"2"}],"signers":[{"email":"darlene_petersen@newco.example.com","name":"Darlene Petersen","recipientId":"1","routingOrder":"1","tabs":{"dateSignedTabs":[{"anchorString":"signer1date","anchorYOffset":"-6","fontSize":"Size12","name":"Date Signed","recipientId":"1","tabLabel":"date_signed"},{"documentId":"2","fontSize":"Size12","name":"Date Signed","pageNumber":"1","recipientId":"1","tabLabel":"doc3_date_signed","xPosition":"89","yPosition":"100"}],"fullNameTabs":[{"anchorString":"signer1name","anchorYOffset":"-6","fontSize":"Size12","name":"Full Name","recipientId":"1","tabLabel":"Full Name"}],"signHereTabs":[{"anchorString":"signer1sig","anchorUnits":"mms","anchorXOffset":"0","anchorYOffset":"0","name":"Please sign here","optional":"false","recipientId":"1","scaleValue":1,"tabLabel":"signer1sig"},{"documentId":"2","name":"Please sign here","optional":"false","pageNumber":"1","recipientId":"2","scaleValue":1,"tabLabel":"signer1_doc2","xPosition":"89","yPosition":"40"},{"anchorString":"Client Signature","anchorUnits":"mms","anchorXOffset":"0","anchorYOffset":"-4","name":"Please sign here","optional":"false","recipientId":"1","scaleValue":1,"tabLabel":"doc3_client_sig"}],"textTabs":[{"anchorString":"signer1company","anchorYOffset":"-8","fontSize":"Size12","name":"Company","recipientId":"1","required":"true","tabLabel":"Company"},{"anchorString":"Client Name","anchorYOffset":"-38","fontSize":"Size12","name":"Company","recipientId":"1","required":"true","tabLabel":"Company"},{"documentId":"3","fontSize":"Size10","name":"Company","pageNumber":"1","recipientId":"1","required":"true","tabLabel":"Company","xPosition":"145","yPosition":"195"}]}}]},"status":"sent"},"response":{"envelopeId":"63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80","status":"sent","statusDateTime":"2025-08-15T13:52:51.651Z","uri":"/envelopes/63e05468-xxxx-xxxx-xxxx-8b48f7dbeb80"},"style":"custom","title":"Multiple Documents and Tabs, Signer and CC Recipients"},{"description":"For some documents, one or more signatures must be witnessed by an appointed [notary public](https://en.wikipedia.org/wiki/Notary_public).\n\nDocuSign supports eNotary services for many jurisdictions. This example demonstrates how to send an envelope to be signed by Susan Signer with her signature witnessed by Nancy Notary. You must know the name and email address of the signer and the notary public for a signature to be notarized.\n\nNote that the full legal name of the signer must be used. It will be checked against the signer's government-issued proof of identity by the notary public.\n\nPlease see the [DocuSign eNotary resource page](https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources) for further information. It lists the jurisdictions participating in the DocuSign eNotary program and additional reference information.\n\nNote that eNotary services are not included with all account types and are **not** included by default with demo/developer sandbox accounts. To enable eNotary service for your sandbox account, contact your DocuSign technical support person or DocuSign customer service.\n\nThe example includes event notification via the Connect service.","direction":"both","format":"json","request":{"documents":[{"documentBase64":"[Contents elided]","documentId":"1","fileExtension":"docx","name":"important document.docx"}],"emailSubject":"Important agreement for notarized signature","eventNotification":{"envelopeEvents":[{"envelopeEventStatusCode":"Completed"},{"envelopeEventStatusCode":"Declined"},{"envelopeEventStatusCode":"Voided"}],"includeDocumentFields":"false","includeDocuments":"false","includeSenderAccountAsCustomField":"true","loggingEnabled":"true","requireAcknowledgment":"true","signMessageWithX509Cert":"true","url":"https://listener.example.com/docusign_notifications"},"recipients":{"inPersonSigners":[{"email":"susan_signer@gmail.com","inPersonSigningType":"notary","name":"Susan Anne Signer","notaryHost":{"email":"nancy@notary-svc.com","name":"Nancy Notary","recipientId":2},"recipientId":1,"routingOrder":1,"tabs":{"signHereTabs":[{"documentId":"1","name":"Please sign here","optional":"false","pageNumber":"1","recipientId":"1","tabLabel":"signer1sig","xPosition":"100","yPosition":"100"}]}}]},"status":"sent"},"response":{"envelopeId":"aaaaaaaa-xxxx-xxxx-xxxx-52a86fb94be8","status":"sent","statusDateTime":"2025-08-15T13:52:51.651Z","uri":"/envelopes/aaaaaaaa-xxxx-xxxx-xxxx-52a86fb94be8"},"style":"custom","title":"Create a Notarized Signing Recipient"},{"description":"DocuSign enables document signers to use\nelectronic or\ndigital signatures.\n\nDocuSign has tightly integrated standard digital signatures into the DocuSign Signature platform. This enables a single envelope to include:\n\n* electronic signatures,\n* AES digital signatures using certificates from DocuSign or from your organization,\n* QES digital signatures from government certified Trust Service Providers (TSPs).\n\nThis example enables the signer to create an eIDAS compliant AES signature with embedded signing. InPerson signers can also use SBS digital signatures.\n\n[More information on creating SBS digital signature requests.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)\n\nThe `clientId` in the example tells DocuSign that the Signing Ceremony will be embedded.\nThe example also includes an `eventNotification` object for receiving envelope status updates from DocuSign.\n\n## Embedding the signing ceremony\n1. Send the `Envelopes: create` call as shown below in the Request/Response section.\n2. The response will include the `envelopeId`\n3. Use the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) request to obtain the redirectURL as follows:\n\n`POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`\n\n````\n{\n \"clientUserId\": \"1000\",\n \"email\": \"Sam@spade.com\",\n \"userName\": \"Sam Spade\",\n \"returnUrl\": \"https://your_app.example.com\",\n \"AuthenticationMethod\": \"Password\"\n}\n````\nThe response will include the `url`. Redirect the user's browser to the URL to start the signing ceremony.\n\n**Note:** You must **immediately** redirect the user to the URL you receive from DocuSign. The URL is only valid for 5 minutes. Don't request a recipient view URL until you are ready to redirect the user's browser.\n","direction":"both","format":"json","request":{"documents":[{"documentBase64":"[Contents elided]","documentId":"1","fileExtension":"html","name":" Agreement"}],"emailSubject":"NewCo agreement for signature","eventNotification":{"envelopeEvents":[{"envelopeEventStatusCode":"Completed"},{"envelopeEventStatusCode":"Declined"},{"envelopeEventStatusCode":"Voided"}],"includeDocumentFields":"false","includeDocuments":"false","includeSenderAccountAsCustomField":"true","loggingEnabled":"true","requireAcknowledgment":"true","signMessageWithX509Cert":"true","url":"https://your_app.example.com/listener"},"recipients":{"signers":[{"clientUserId":"1000","email":"Sam@spade.com","name":"Sam Spade","recipientId":"1","recipientSignatureProviders":[{"signatureProviderName":"UniversalSignaturePen_OpenTrust_Hash_TSP","signatureProviderOptions":{"SMS":"+33134567899"}}],"routingOrder":"1","tabs":{"signHereTabs":[{"anchorString":"signer1sig","documentId":"1","name":"Please sign here","optional":"false","recipientId":"1","tabLabel":"signer1sig"}]}}]},"status":"sent"},"response":{"envelopeId":"caaaaaaa-xxxx-xxxx-xxxx-c171528e99c8","status":"sent","statusDateTime":"2025-08-15T13:52:51.651Z","uri":"/envelopes/caaaaaaa-xxxx-xxxx-xxxx-c171528e99c8"},"style":"custom","title":"Request an SBS digital signature, with an embedded signing ceremony"}],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createEnvelope","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/status":{"parameters":[],"put":{"deprecated":false,"description":"Retrieves envelope statuses for a set of envelopes.\n\nYou must specify exactly one of the following query parameters:\n\n| Parameter | Description |\n| :---------------- | :------------------------------------------------------------------------------- |\n| `from_date` | a valid UTC DateTime: `2016-01-01` |\n| `envelope_ids` | A comma-separated list of envelope IDs
or the special value `request_body` |\n| `transaction_ids` | A comma-separated list of transaction IDs
or the special value `request_body` |\n\nWhen you use the special value `request_body`, the request body looks like this:\n\n```\n{\n \"envelopeIds\": [\n \"44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15\",\n \"8e26040d-xxxx-xxxx-xxxx-1e29b924d237\",\n \"c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95\"\n ]\n}\n```\n\n**Note:** Omitting the request body altogether causes the endpoint to return an error.\nThe request body must be at least `{}`.\n","operationId":"Envelopes_PutStatus","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"Specifies the Authoritative Copy Status for the envelopes. Valid values: \n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`","in":"query","name":"ac_status","required":false,"schema":{"type":"string"}},{"description":"When **true,** removes any results that match one of the provided `transaction_ids`.","in":"query","name":"block","required":false,"schema":{"type":"string"}},{"description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\n","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"The email address of the sender.","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"The envelope IDs to include in the results.\n\nThe value of this property can be:\n- A comma-separated list of envelope IDs\n- The special value `request_body`. In this case, the method uses the envelope IDs in the request body.","in":"query","name":"envelope_ids","required":false,"schema":{"type":"string"}},{"description":"The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided.\n\n**Note:** This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified.","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"The envelope status that you are checking for. Possible values are:\n\n\n- `Changed` (default)\n- `Completed`\n- `Created`\n- `Declined`\n- `Deleted`\n- `Delivered`\n- `Processing`\n- `Sent`\n- `Signed`\n- `TimedOut`\n- `Voided`\n\nFor example, if you specify `Changed`, this method\nreturns a list of envelopes that changed status\nduring the `from_date` to `to_date` time period. \n","in":"query","name":"from_to_status","required":false,"schema":{"type":"string"}},{"description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n","in":"query","name":"start_position","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of envelope status to search for. Possible values are:\n\n- `completed`\n- `created`\n- `declined`\n- `deleted`\n- `delivered`\n- `processing`\n- `sent`\n- `signed`\n- `template`\n- `voided`\n","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"Optional date/time setting\nthat specifies the last date/time \nor envelope status changes in the result set. \n\nThe default value is the time that you call the method. \n","in":"query","name":"to_date","required":false,"schema":{"type":"string"}},{"description":"The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.\n\nThe value of this property can be:\n- A list of comma-separated transaction IDs\n- The special value `request_body`. In this case, this method uses the transaction IDs in the request body.","in":"query","name":"transaction_ids","required":false,"schema":{"type":"string"}},{"description":"Limits results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.\n","in":"query","name":"user_name","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeIdsRequest"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets envelope statuses for a set of envelopes.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"listStatus","x-ds-methodname":"listStatus","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/transfer_rules":{"get":{"deprecated":false,"description":"This method retrieves a list of envelope transfer rules associated with an account.\n\n**Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","operationId":"EnvelopeTransferRules_GetEnvelopeTransferRules","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n","in":"query","name":"start_position","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets envelope transfer rules.","tags":["EnvelopeTransferRules"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"get","x-ds-service":"Uncategorized"},"parameters":[],"post":{"deprecated":false,"description":"This method creates an envelope transfer rule.\n\nWhen you create an envelope transfer rule, you specify the following properties: \n\n- `eventType`\n- `fromGroups`\n- `toUser`\n- `toFolder`\n- `carbonCopyOriginalOwner`\n- `enabled`\n\n**Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","operationId":"EnvelopeTransferRules_PostEnvelopeTransferRules","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleRequest"}}}},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates an envelope transfer rule.","tags":["EnvelopeTransferRules"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"create","x-ds-service":"Uncategorized"},"put":{"deprecated":false,"description":"This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled.\n\n**Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","operationId":"EnvelopeTransferRules_PutEnvelopeTransferRules","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Changes the status of multiple envelope transfer rules.","tags":["EnvelopeTransferRules"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"update","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}":{"delete":{"deprecated":false,"description":"This method deletes an envelope transfer rule.\n\n**Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","operationId":"EnvelopeTransferRules_DeleteEnvelopeTransferRules","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created.","in":"path","name":"envelopeTransferRuleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes an envelope transfer rule.","tags":["EnvelopeTransferRules"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"delete","x-ds-service":"Uncategorized"},"parameters":[],"put":{"deprecated":false,"description":"This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.\n\nYou must include the `envelopeTransferRuleId` both as a query parameter, and in the request body.\n\n**Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","operationId":"EnvelopeTransferRules_PutEnvelopeTransferRule","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created.","in":"path","name":"envelopeTransferRuleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRule"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeTransferRule"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Changes the status of an envelope transfer rule.","tags":["EnvelopeTransferRules"],"x-ds-in-sdk":true,"x-ds-method":"updateEnvelopeTransferRule","x-ds-methodname":"updateEnvelopeTransferRule","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}":{"get":{"deprecated":false,"description":"Retrieves the overall status for the specified envelope.\nTo get the status of a list of envelopes, use\n[Envelope: listStatusChanges ](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/).\n\n### Related topics\n\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)\n","operationId":"Envelopes_GetEnvelope","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"When **true,** envelope information can be added or modified.","in":"query","name":"advanced_update","required":false,"schema":{"type":"string"}},{"description":"Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: The email settings associated with the envelope.\n- `folders`: The folder where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `tabs`: The tabs associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n- `workflow`: The workflow definition associated with the envelope.\n","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelope"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the status of a single envelope.","tags":["Envelopes"],"x-ds-examples":[{"description":"This example shows a how to get information about\nan envelope with a given envelope id.\n\nThe request for this endpoint has no payload.\n\n### Request\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6\n```\n","direction":"response","format":"json","response":{"allowMarkup":"false","autoNavigation":"true","brandId":"56502fe1-xxxx-xxxx-xxxx-97cb5c43176a","certificateUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/certificate","createdDateTime":"2025-08-15T13:52:51.652Z","customFieldsUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/custom_fields","documentsCombinedUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents/combined","documentsUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/documents","emailSubject":"Please sign the NDA","enableWetSign":"true","envelopeId":"4b728be4-xxxx-xxxx-xxxx-d63e23f822b6","envelopeIdStamping":"true","envelopeUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6","initialSentDateTime":"2025-08-15T13:52:51.652Z","is21CFRPart11":"false","isSignatureProviderEnvelope":"false","lastModifiedDateTime":"2025-08-15T13:52:51.652Z","notificationUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/notification","purgeState":"unpurged","recipientsUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/recipients","sentDateTime":"2025-08-15T13:52:51.652Z","status":"sent","statusChangedDateTime":"2025-08-15T13:52:51.652Z","templatesUri":"/envelopes/4b728be4-xxxx-xxxx-xxxx-d63e23f822b6/templates"},"style":"custom","title":"Get Status About a Specific Envelope"}],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getEnvelope","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"This method enables you to make changes to an envelope.\nYou can use it to:\n\n* [Send a draft envelope](#sending-a-draft-envelope)\n* [Void an in-process envelope](#voiding-an-in-process-envelope)\n* [Modify a draft envelope](#modifying-envelope-email-information)\n* [Purge documents and envelope metadata from the DocuSign platform](#purging-documents-from-docusign)\n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nthe properties that\nyou're updating.\n\n## Sending a draft envelope\n\nTo send a draft envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"sent\"\n}\n```\n\nYou can attach a workflow before sending the envelope:\n\n```json\n{\n \"status\": \"sent\",\n \"workflow\": {\n \"workflowSteps\": [\n {\n \"action\": \"pause_before\",\n \"description\": \"pause_before routing order 2\",\n \"itemId\": 2,\n \"triggerOnItem\": \"routing_order\"\n }\n ]\n }\n}\n```\n\n## Working with workflows\n\nTo unpause a workflow, the request body should include this:\n\n```json\n{\n \"workflow\": {\n \"workflowStatus\": \"in_progress\"\n }\n}\n```\n\n## Voiding an in-process envelope\n\nTo void an in-process envelope, include the following code in the request body:\n\n```json\n{\n \"status\": \"voided\",\n \"voidedReason\": \"The reason for voiding the envelope\"\n}\n```\n\n## Modifying envelope email information\n\nTo change the email subject and message of a draft envelope,\ninclude the following code in the request body:\n\n```json\n{\n \"emailSubject\": \"new email subject\",\n \"emailBlurb\": \"new email message\"\n}\n```\n\n## Purging documents from docusign\n\nTo place only the documents\nin the purge queue,\nleaving any\ncorresponding attachments\nand tabs in the DocuSign platform,\nset the `purgeState` property\nto `documents_queued`.\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue,\nset the `purgeState` property\nto `documents_and_metadata_queued`.\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_and_metadata_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue\nand to redact personal information,\nset the `purgeState` property\nto `documents_and_metadata_and_redact_queued`.\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_and_metadata_and_redact_queued\"\n}\n```\n\nYou can purge documents\nonly from completed envelopes\nthat are not marked as the authoritative copy.\nThe user requesting the purge\nmust have permission to purge documents\nand\nmust be the sender or be acting on behalf of the sender.\n\nWhen the purge request is initiated\nthe items to be purged\nare placed in the purge queue\nfor deletion in 14 days.\nThe sender\nand\nall recipients with DocuSign accounts\nassociated with the envelope\nget an email notification\nthe documents will be deleted in 14 days.\nThe notification contains a link\nto the documents.\nA second email notification\nis sent 7 days later.\nAt the end of the 14-day period\nthe documents are deleted from the system.\nRecipients without DocuSign accounts\ndo not receive email notifications.\n\nIf your account has a Document Retention policy,\nenvelope documents\nare automatically placed\nin the purge queue,\nand notification emails are sent\nat the end of the retention period.\nSetting a Document Retention policy is the same as setting a\nschedule for purging documents.\n\n## Removing documents from the purge queue\n\nTo remove documents from the purge queue, include the following code in the request body:\n\n```json\n{\n \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n \"purgeState\": \"documents_dequeued\"\n}\n```\n\n### Related topics\n\n- [Void an envelope](https://www.docusign.com/blog/dsdev-common-api-tasks-void-an-envelope) ([Common API Tasks](https://www.docusign.com/blog/tags/common-api-tasks))\n- [Purging documents (eSignature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)\n","operationId":"Envelopes_PutEnvelope","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.","in":"query","name":"advanced_update","required":false,"schema":{"type":"string"}},{"description":"When **true,**\nsends the specified envelope again.","in":"query","name":"resend_envelope","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelope"}}},"description":"A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients."},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeUpdateSummary"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Send, void, or modify a draft envelope. Purge documents from a completed envelope.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"update","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments":{"delete":{"deprecated":false,"description":"Deletes one or more attachments from a draft envelope.","operationId":"Attachments_DeleteAttachments","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/envelopeAttachmentsRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes one or more attachments from a draft envelope.","tags":["EnvelopeAttachments"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteAttachments","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Returns a list of attachments associated with a specified envelope.","operationId":"Attachments_GetAttachments","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns a list of attachments associated with a specified envelope","tags":["EnvelopeAttachments"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"getAttachments","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Adds one or more attachments to a draft or in-process envelope.\n\nEnvelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them.\n\nFor a list of supported file formats, see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).","operationId":"Attachments_PutAttachments","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/envelopeAttachmentsRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds one or more attachments to a draft or in-process envelope.","tags":["EnvelopeAttachments"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"putAttachments","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}":{"get":{"deprecated":false,"description":"Retrieves an attachment from an envelope.","operationId":"Attachments_GetAttachment","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier for the attachment.","in":"path","name":"attachmentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves an attachment from an envelope.","tags":["EnvelopeAttachments"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getAttachment","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Adds an attachment to a draft or in-process envelope.","operationId":"Attachments_PutAttachment","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier for the attachment.","in":"path","name":"attachmentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/attachment"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds an attachment to a draft or in-process envelope.","tags":["EnvelopeAttachments"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"putAttachment","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events":{"get":{"deprecated":false,"description":"Gets the envelope audit events for the specified envelope.","operationId":"AuditEvents_GetAuditEvents","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeAuditEventResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the envelope audit events for an envelope.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"listAuditEvents","x-ds-methodname":"listAuditEvents","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript":{"get":{"deprecated":false,"description":"Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.\n\nThe response body of this method is the PDF file as a byte\nstream.\n\n\n**Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**). ","operationId":"Comments_GetCommentsTranscript","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"(Optional) The encoding to use for the file.","in":"query","name":"encoding","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Successful response."},"400":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a PDF transcript of all of the comments in an envelope.","tags":["Comments"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getCommentsTranscript","x-ds-service":"Uncategorized"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields":{"delete":{"deprecated":false,"description":"Deletes envelope custom fields for draft and in-process envelopes.","operationId":"CustomFields_DeleteCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeCustomFields"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeCustomFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes envelope custom fields for draft and in-process envelopes.","tags":["EnvelopeCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteCustomFields","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.\n\n\n### Related topics\n\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)\n","operationId":"CustomFields_GetCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/customFieldsEnvelope"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the custom field information for the specified envelope.","tags":["EnvelopeCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listCustomFields","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Updates the envelope custom fields for draft and in-process envelopes.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n","operationId":"CustomFields_PostCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeCustomFields"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeCustomFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates envelope custom fields for an envelope.","tags":["EnvelopeCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createCustomFields","x-ds-service":"Envelopes"},"put":{"deprecated":false,"description":"Updates the envelope custom fields in draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.\n","operationId":"CustomFields_PutCustomFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeCustomFields"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeCustomFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates envelope custom fields in an envelope.","tags":["EnvelopeCustomFields"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateCustomFields","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields":{"get":{"deprecated":false,"description":"","operationId":"DocGenFormFields_GetEnvelopeDocGenFormFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/docGenFormFieldResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns formfields for an envelope","tags":["DocumentGeneration"],"x-ds-in-sdk":true,"x-ds-method":"getEnvelopeDocGenFormFields","x-ds-methodname":"getEnvelopeDocGenFormFields","x-ds-service":"Uncategorized"},"parameters":[],"put":{"deprecated":false,"description":"","operationId":"DocGenFormFields_PutEnvelopeDocGenFormFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"","in":"query","name":"update_docgen_formfields_only","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/docGenFormFieldRequest"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/docGenFormFieldResponse"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates formfields for an envelope","tags":["DocumentGeneration"],"x-ds-in-sdk":true,"x-ds-method":"updateEnvelopeDocGenFormFields","x-ds-methodname":"updateEnvelopeDocGenFormFields","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents":{"delete":{"deprecated":false,"description":"Deletes one or more documents from an existing envelope that has not yet been completed.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n\n```text\n{\n \"documents\": [\n {\n \"documentId\": \"1\"\n }\n ]\n}\n```\n\nThe envelope status must be one of:\n\n- `created`\n- `sent`\n- `delivered`\n\n\n","operationId":"Documents_DeleteDocuments","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/envelopeDefinition"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeDocumentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes documents from a draft envelope.","tags":["EnvelopeDocuments"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteDocuments","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves a list of documents associated with the specified envelope.\n\n### Related topics\n\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)\n","operationId":"Documents_GetDocuments","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.","in":"query","name":"documents_by_userid","required":false,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.","in":"query","name":"include_docgen_formfields","required":false,"schema":{"type":"string"}},{"description":"When **true,** the response includes metadata that indicates which properties the sender can edit.","in":"query","name":"include_metadata","required":false,"schema":{"type":"string"}},{"description":"When **true,** information about the tabs, including prefill tabs, associated with the documents are included in the response.","in":"query","name":"include_tabs","required":false,"schema":{"type":"string"}},{"description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work.","in":"query","name":"recipient_id","required":false,"schema":{"type":"string"}},{"description":"The ID of a shared user that you want to impersonate in order to\nretrieve their view of the list of documents. This parameter is\nused in the context of a shared inbox (i.e., when you share\nenvelopes from one user to another through the DocuSign Admin console).","in":"query","name":"shared_user_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeDocumentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a list of documents in an envelope.","tags":["EnvelopeDocuments"],"x-ds-examples":[{"description":"This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents\n```\n","direction":"response","format":"json","response":{"envelopeDocuments":[{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"1","includeInDownload":"true","name":"NDA.pdf","order":"1","pages":"3","signerMustAcknowledge":"no_interaction","type":"content","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/1"},{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"2","includeInDownload":"true","name":"House.pdf","order":"2","pages":"1","signerMustAcknowledge":"no_interaction","type":"content","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/2"},{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"3","includeInDownload":"true","name":"contractor_agreement.docx","order":"3","pages":"2","signerMustAcknowledge":"no_interaction","type":"content","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3"},{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"certificate","includeInDownload":"true","name":"Summary","order":"999","pages":"4","signerMustAcknowledge":"no_interaction","type":"summary","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/certificate"}],"envelopeId":"44efc9e6-xxxx-xxxx-xxxx-801410d6922d"},"style":"custom","title":"List All Documents in an Envelope"}],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listDocuments","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Adds one or more documents to an existing envelope.\nThe tabs of the original document will be applied to the new document.\n\n\n**Note:** When adding or modifying documents for an in-process envelope,\nDocuSign recommends\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nprior to making any changes.\n\nIf the file name of a document contains Unicode characters, you need to include a `Content-Disposition` header. Example:\n\n\n**Header:** `Content-Disposition`\n\n\n**Value:** `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`","operationId":"Documents_PutDocuments","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/envelopeDefinition"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeDocumentsResult"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds one or more documents to an existing envelope.","tags":["EnvelopeDocuments"],"x-ds-in-sdk":true,"x-ds-method":"updateList","x-ds-methodname":"updateDocuments","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}":{"get":{"deprecated":false,"description":"Retrieves a single document or all documents from an envelope.\n\nTo retrieve a single document, provide the ID of the document in the `documentId` path parameter.\nAlternatively, by setting the `documentId` parameter to special keyword values,\nyou can retrieve all the documents (as a combined PDF, portfolio PDF, or ZIP archive)\nor just the certificate of completion. See the `documentId` description for how to retrieve each format.\n\n\nThe response body of this method\nis a file. If you request multiple documents,\nthe result is a ZIP archive\nthat contains all of the documents.\n\nIn all other cases, the response is a PDF\nfile or PDF portfolio.\n\n\nYou can get the file name and document ID from the response's `Content-Disposition` header:\n\n```\nContent-Disposition: file; filename=\"NDA.pdf\"; documentid=\"1\n```\n\nBy default, the response is the PDF file\nas a byte stream.\nFor example a request/response in `curl` looks like this:\n\n```\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n --header 'Authorization: Bearer eyJ...bqg'\n\n\nHTTP/1.1 200 OK\nContent-Length: 167539\nContent-Type: application/pdf\n. . .\nContent-Disposition: file; filename=\"Lorem_Ipsum.pdf\"; documentid=\"1\"\nDate: Tue, 23 Aug 2022 01:13:15 GMT\n\n%PDF-1.4\n%˚¸˝˛\n6 0 obj\n<>stream\n. . .\n```\n\nBy using the `Content-Transfer-Encoding`\nheader in the request, you can obtain the PDF file\nencoded in base64. The same `curl` request with\nthe base64 header would look like this:\n\n```\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n --header 'Authorization: Bearer eyJ...bqg' \\\n --header 'Content-Transfer-Encoding: base64'\n\n\nHTTP/1.1 200 OK\nContent-Length: 223384\nContent-Type: application/pdf\n. . .\nContent-Disposition: file; filename=\"Lorem_Ipsum.pdf\"; documentid=\"1\"\nContent-Transfer-Encoding: base64\nDate: Tue, 23 Aug 2022 01:12:30 GMT\n\nJVBERi0xLjQKJfv8/f4KNiAwIG9iago8PC9MZW. . .==\n```\n\n\n(In an actual `curl` request you would use the `--output` switch to\nsave the byte stream into a file.)\n\n### Related topics\n\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n","operationId":"Documents_GetDocument","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The ID of the document to retrieve. Alternatively, you can use one of the following special keywords:\n\n- `combined`: Retrieves all of the documents as a single PDF file.\n When the query parameter `certificate` is **true,** the certificate of completion is included in the PDF file.\n When the query parameter `certificate` is **false,** the certificate of completion is not included in the PDF file.\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the certificate of completion.\n- `certificate`: Retrieves only the certificate of completion as a PDF file.\n- `portfolio`: Retrieves the envelope documents as a [PDF portfolio](https://helpx.adobe.com/acrobat/using/overview-pdf-portfolios.html).","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"Used only when the `documentId` parameter is the special keyword `combined`.\n\nWhen **true,** the certificate of completion is included in the combined PDF file.\nWhen **false,** (the default) the certificate of completion is not included in the combined PDF file.\n\n","in":"query","name":"certificate","required":false,"schema":{"type":"string"}},{"description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.","in":"query","name":"documents_by_userid","required":false,"schema":{"type":"string"}},{"description":"Reserved for DocuSign.","in":"query","name":"encoding","required":false,"schema":{"type":"string"}},{"description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.","in":"query","name":"encrypt","required":false,"schema":{"type":"string"}},{"description":"Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). ","in":"query","name":"language","required":false,"schema":{"type":"string"}},{"description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work.","in":"query","name":"recipient_id","required":false,"schema":{"type":"string"}},{"description":"The ID of a shared user that you want to impersonate in order to\nretrieve their view of the list of documents. This parameter is\nused in the context of a shared inbox (i.e., when you share\nenvelopes from one user to another through the DocuSign Admin console).","in":"query","name":"shared_user_id","required":false,"schema":{"type":"string"}},{"description":"When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the **Highlight Data Changes** feature enabled.","in":"query","name":"show_changes","required":false,"schema":{"type":"string"}},{"description":"When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. ","in":"query","name":"watermark","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Successful response."},"400":{"content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves a single document or all documents from an envelope.","tags":["EnvelopeDocuments"],"x-ds-examples":[{"description":"This example shows how to retrieve\na single document from an envelope\nas a PDF file.\n\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3\n```\n\n","direction":"response","format":"json","response":"A byte stream representing a PDF file.","style":"custom","title":"Get a Single Document as a PDF File"},{"description":"If you use `combined` instead of a document id\nthe response is a PDF file that contains\nall of the documents in the specified envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/combined\n```\n\n","direction":"response","format":"json","response":"A byte stream representing a PDF file.","style":"custom","title":"Get All Documents as a Single PDF File"},{"description":"This example shows how\nto get a list\nof all the documents in an envelope.\n\nThe request for this endpoint has no payload.\n\n### Request\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents\n```\n","direction":"response","format":"json","response":{"envelopeDocuments":[{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"1","includeInDownload":"true","name":"NDA.pdf","order":"1","pages":"3","signerMustAcknowledge":"no_interaction","type":"content","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/1"},{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"2","includeInDownload":"true","name":"House.pdf","order":"2","pages":"1","signerMustAcknowledge":"no_interaction","type":"content","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/2"},{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"3","includeInDownload":"true","name":"contractor_agreement.docx","order":"3","pages":"2","signerMustAcknowledge":"no_interaction","type":"content","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/3"},{"availableDocumentTypes":[{"isDefault":"true","type":"electronic"}],"display":"inline","documentId":"certificate","includeInDownload":"true","name":"Summary","order":"999","pages":"4","signerMustAcknowledge":"no_interaction","type":"summary","uri":"/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/documents/certificate"}],"envelopeId":"44efc9e6-xxxx-xxxx-xxxx-801410d6922d"},"style":"custom","title":"List All Documents in an Envelope"}],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getDocument","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Adds or replaces a document in an existing draft or in-process envelope.\nAn in-process envelope is one that has been sent but not yet completed or voided.\n\n\n**Note:** When adding or modifying documents for an in-process envelope,\nDocuSign recommends\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nprior to making any changes.\n\nTo add a new document, set the `documentId` path parameter to a new document ID.\n\nTo replace a document, set the `documentId` path parameter to the document ID of the existing document.\nThe tabs of the original document will be applied to the new document.\nFor example, a request in cURL looks like this:\n\n```\n$ curl --location --request PUT 'https://demo.docusign.net/restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1' \\\n --header 'Authorization: Bearer eyJ...bqg' \\\n --header 'Content-Disposition: filename=\"newDocument\"' \\\n --header 'Content-Type: application/pdf' \\\n --data-binary '@/location/of/document.pdf'\n```\n","operationId":"Documents_PutDocument","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Updated document content.","required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeDocument"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds or replaces a document in an existing envelope.","tags":["EnvelopeDocuments"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateDocument","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields":{"delete":{"deprecated":false,"description":"Deletes custom document fields from an existing envelope document.","operationId":"DocumentFields_DeleteDocumentFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeDocumentFields"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeDocumentFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes custom document fields from an existing envelope document.","tags":["EnvelopeDocumentFields"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteDocumentFields","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves the custom document field information from an existing envelope document.","operationId":"DocumentFields_GetDocumentFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeDocumentFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the custom document fields from an existing envelope document.","tags":["EnvelopeDocumentFields"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listDocumentFields","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Creates custom document fields in an existing envelope document.","operationId":"DocumentFields_PostDocumentFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeDocumentFields"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeDocumentFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates custom document fields in an existing envelope document.","tags":["EnvelopeDocumentFields"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createDocumentFields","x-ds-service":"Envelopes"},"put":{"deprecated":false,"description":"Updates existing custom document fields in an existing envelope document.","operationId":"DocumentFields_PutDocumentFields","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeDocumentFields"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeDocumentFields"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates existing custom document fields in an existing envelope document.","tags":["EnvelopeDocumentFields"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateDocumentFields","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions":{"get":{"deprecated":false,"description":"Retrieves the HTML definition used to generate a dynamically sized responsive document.\n\nIf the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. \n\n**Note:** The `documentId` query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body.\n\n### Related topics\n\n- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)","operationId":"ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The GUID of the document.\n\nExample: c671747c-xxxx-xxxx-xxxx-4a4a48e23744","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginals"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieves the HTML definition used to generate a dynamically sized responsive document.","tags":["EnvelopeDocumentHtmlDefinitions"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getEnvelopeDocumentHtmlDefinitions","x-ds-service":"Uncategorized"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages":{"get":{"deprecated":false,"description":"Returns images of the pages in a document for display based on the parameters that you specify.","operationId":"Pages_GetPageImages","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return.","in":"query","name":"count","required":false,"schema":{"type":"string"}},{"description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","in":"query","name":"dpi","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum height of the returned images in pixels.","in":"query","name":"max_height","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum width of the returned images in pixels.","in":"query","name":"max_width","required":false,"schema":{"type":"string"}},{"description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value. ","in":"query","name":"nocache","required":false,"schema":{"type":"string"}},{"description":"When **true,** changes display in the user interface.","in":"query","name":"show_changes","required":false,"schema":{"type":"string"}},{"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","in":"query","name":"start_position","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/pageImages"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns document page images based on input.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"getPageImages","x-ds-methodname":"getDocumentPageImages","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}":{"delete":{"deprecated":false,"description":"Deletes a page from a document in an envelope based on the page number.","operationId":"Pages_DeletePage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The page number being accessed.","in":"path","name":"pageNumber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a page from a document in an envelope.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"deleteDocumentPage","x-ds-methodname":"deleteDocumentPage","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image":{"get":{"deprecated":false,"description":"Returns an image of a page in a document for display.","operationId":"Pages_GetPageImage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The page number being accessed.","in":"path","name":"pageNumber","required":true,"schema":{"type":"string"}},{"description":"Sets the dots per inch (DPI) for the returned image.","in":"query","name":"dpi","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.","in":"query","name":"max_height","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.","in":"query","name":"max_width","required":false,"schema":{"type":"string"}},{"description":"When **true,** changes display in the user interface.","in":"query","name":"show_changes","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"Successful response."},"400":{"content":{"image/png":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets a page image from an envelope for display.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"getPageImage","x-ds-methodname":"getDocumentPageImage","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Rotates page image from an envelope for display. The page image can be rotated to the left or right.","operationId":"Pages_PutPageImage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The page number being accessed.","in":"path","name":"pageNumber","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/pageRequest"},"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Rotates page image from an envelope for display.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"rotateDocumentPage","x-ds-methodname":"rotateDocumentPage","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs":{"get":{"deprecated":false,"description":"Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","operationId":"Tabs_GetPageTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The page number being accessed.","in":"path","name":"pageNumber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeDocumentTabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns tabs on the specified page.","tags":["EnvelopeDocumentTabs"],"x-ds-in-sdk":true,"x-ds-method":"getByPage","x-ds-methodname":"getPageTabs","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview":{"parameters":[],"post":{"deprecated":false,"description":"Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/)\nHTML version of a specific document.\nThis method enables you to preview a PDF document\nconversion to responsive HTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.","operationId":"ResponsiveHtml_PostDocumentResponsiveHtmlPreview","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/documentHtmlDefinition"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitions"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a preview of the responsive version of a document.","tags":["DocumentResponsiveHtmlPreview"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createDocumentResponsiveHtmlPreview","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs":{"delete":{"deprecated":false,"description":"Deletes tabs from the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","operationId":"Tabs_DeleteDocumentTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/tabs"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/tabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes tabs from a document in an envelope.","tags":["EnvelopeDocumentTabs"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteDocumentTabs","x-ds-service":"Uncategorized"},"get":{"deprecated":false,"description":"Returns the tabs on the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","operationId":"Tabs_GetDocumentTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"When **true,** the response includes metadata indicating which properties are editable.","in":"query","name":"include_metadata","required":false,"schema":{"type":"string"}},{"description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\n\nExample: `page_numbers=2,6`\n\nNote: You can only enter individual page numbers, and not a page range.","in":"query","name":"page_numbers","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeDocumentTabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns the tabs on a document.","tags":["EnvelopeDocumentTabs"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getDocumentTabs","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Adds tabs to the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\nIn the request body, you only need to specify the tabs that your\nare adding. For example, to add a text\n[prefill tab](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs),\nyour request body might look like this:\n\n```\n{\n \"prefillTabs\": {\n \"textTabs\": [\n {\n \"value\": \"a prefill text tab\",\n \"pageNumber\": \"1\",\n \"documentId\": \"1\",\n \"xPosition\": 316,\n \"yPosition\": 97\n }\n ]\n }\n}\n```\n","operationId":"Tabs_PostDocumentTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/tabs"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/tabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds tabs to a document in an envelope.","tags":["EnvelopeDocumentTabs"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createDocumentTabs","x-ds-service":"Uncategorized"},"put":{"deprecated":false,"description":"Updates tabs in the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","operationId":"Tabs_PutDocumentTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/tabs"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/tabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates the tabs for document.","tags":["EnvelopeDocumentTabs"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateDocumentTabs","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates":{"get":{"deprecated":false,"description":"Retrieves the templates associated with a document in the specified envelope.","operationId":"Templates_GetDocumentTemplates","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A comma-separated list that limits the results.\nValid values are:\n\n* `applied`\n* `matched`\n","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/templateInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the templates associated with a document in an existing envelope.","tags":["EnvelopeTemplates"],"x-ds-in-sdk":true,"x-ds-method":"listByDocument","x-ds-methodname":"listTemplatesForDocument","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Adds templates to a document in the specified envelope.","operationId":"Templates_PostDocumentTemplates","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text. \n\nWhen **true,** the recipients _will be preserved_ after the template is applied.\n\n","in":"query","name":"preserve_template_recipient","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/documentTemplateList"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentTemplateList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds templates to a document in an envelope.","tags":["EnvelopeTemplates"],"x-ds-in-sdk":true,"x-ds-method":"applyToDocument","x-ds-methodname":"applyTemplateToDocument","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}":{"delete":{"deprecated":false,"description":"Deletes the specified template from a document in an existing envelope.","operationId":"Templates_DeleteDocumentTemplates","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n","in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The ID of the template.","in":"path","name":"templateId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a template from a document in an existing envelope.","tags":["EnvelopeTemplates"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteTemplatesFromDocument","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings":{"delete":{"deprecated":false,"description":"Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.","operationId":"EmailSettings_DeleteEmailSettings","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/emailSettings"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes the email setting overrides for an envelope.","tags":["EnvelopeEmailSettings"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteEmailSettings","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves the email override settings for the specified envelope.","operationId":"EmailSettings_GetEmailSettings","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/emailSettings"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the email setting overrides for an envelope.","tags":["EnvelopeEmailSettings"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getEmailSettings","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.\n\nThe BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes.\nTo send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.\n\n**Note:** DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. ","operationId":"EmailSettings_PostEmailSettings","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/emailSettings"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/emailSettings"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds email setting overrides to an envelope.","tags":["EnvelopeEmailSettings"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createEmailSettings","x-ds-service":"Envelopes"},"put":{"deprecated":false,"description":"Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.","operationId":"EmailSettings_PutEmailSettings","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/emailSettings"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/emailSettings"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates the email setting overrides for an envelope.","tags":["EnvelopeEmailSettings"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateEmailSettings","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data":{"get":{"deprecated":false,"description":"This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.\n\n**Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.\n\n### Related topics\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n","operationId":"FormData_GetFormData","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/envelopeFormData"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns envelope tab data for an existing envelope.","tags":["EnvelopeFormData"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getFormData","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions":{"get":{"deprecated":false,"description":"","operationId":"ResponsiveHtml_GetEnvelopeHtmlDefinitions","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginals"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.","tags":["EnvelopeHtmlDefinitions"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"getEnvelopeHtmlDefinitions","x-ds-service":"Uncategorized"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock":{"delete":{"deprecated":false,"description":"Deletes the lock from the specified envelope.\nThe user deleting the lock must be the same user\nwho locked the envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\nThis method takes an optional query parameter\nthat lets you specify whether\nchanges made while the envelope was locked\nare kept or discarded.\n\n\n| Query Parameter | Description |\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n","operationId":"Lock_DeleteEnvelopeLock","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeLocks"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes an envelope lock.","tags":["EnvelopeLocks"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteLock","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves general information about an envelope lock.\n\nThe user requesting the information must be the same user\nwho locked the envelope.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked envelope.\nThe `X-DocuSign-Edit` header is included in the response.\n\nSee [EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n","operationId":"Lock_GetEnvelopeLock","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeLocks"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets envelope lock information.","tags":["EnvelopeLocks"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getLock","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"This method locks the specified envelope and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the envelope.\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates an envelope)\nwhile the envelope is locked.\n\n\nIf you do not provide the `lockToken` when accessing\na locked envelope, you will get the following\nerror:\n\n```\n{\n \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n```\n{\n \"LockToken\": \"token-from-response\",\n \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n```\n\n token-from-response\n 600\n\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n or\nX-DocuSign-Edit:token-from-response600\n```\n\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\n\n","operationId":"Lock_PostEnvelopeLock","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/lockRequest"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeLocks"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Locks an envelope.","tags":["EnvelopeLocks"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createLock","x-ds-service":"Envelopes"},"put":{"deprecated":false,"description":"Updates the lock information for a locked envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\n\nUse this method to change the duration\nof the lock (`lockDurationInSeconds`)\nor the `lockedByApp` string.\n\nThe request body is a full `lockRequest` object,\nbut you only need to specify the\nproperties that you are updating. For example:\n\n```\n{\n \"lockDurationInSeconds\": \"3600\",\n \"lockedByApp\": \"My Application\"\n}\n```\n\n","operationId":"Lock_PutEnvelopeLock","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/lockRequest"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeLocks"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates an envelope lock.","tags":["EnvelopeLocks"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateLock","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification":{"get":{"deprecated":false,"description":"Retrieves the envelope notification, reminders and expirations, information for an existing envelope.","operationId":"Notification_GetEnvelopesEnvelopeIdNotification","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/notification"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets envelope notification information.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"getNotificationSettings","x-ds-methodname":"getNotificationSettings","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.","operationId":"Notification_PutEnvelopesEnvelopeIdNotification","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeNotificationRequest"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/notification"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Sets envelope notifications for an existing envelope.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"updateNotificationSettings","x-ds-methodname":"updateNotificationSettings","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients":{"delete":{"deprecated":false,"description":"Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the `recipientId` as the key for deleting recipients.\n\nIf the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.","operationId":"Recipients_DeleteRecipients","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeRecipients"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipients"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes recipients from an envelope.","tags":["EnvelopeRecipients"],"x-ds-in-sdk":true,"x-ds-method":"deleteList","x-ds-methodname":"deleteRecipients","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.\n\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.\n\n### Related topics\n\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\n","operationId":"Recipients_GetRecipients","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":" When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response. ","in":"query","name":"include_anchor_tab_locations","required":false,"schema":{"type":"string"}},{"description":" When **true,** the extended properties are included in the response. ","in":"query","name":"include_extended","required":false,"schema":{"type":"string"}},{"description":"Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).","in":"query","name":"include_metadata","required":false,"schema":{"type":"string"}},{"description":"When **true,** the tab information associated with the recipient is included in the response.","in":"query","name":"include_tabs","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipients"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the status of recipients for an envelope.","tags":["EnvelopeRecipients"],"x-ds-examples":[{"description":"This example shows the result of an envelope\nwith one signer and a CC'ed recipient.\n\n\n### Request\nThe request for this endpoint has no payload.\n\n```\nGET /restapi/v2.1/accounts/1703061/envelopes/44efc9e6-xxxx-xxxx-xxxx-801410d6922d/recipients\n```\n\n\n","direction":"response","format":"json","response":{"agents":[],"carbonCopies":[{"email":"aoneil@example.com","name":"Ariana O'Neill","recipientId":"2","recipientIdGuid":"72edf9b6-xxxx-xxxx-xxxx-86bc5d598bb8","requireIdLookup":"false","routingOrder":"2","status":"completed","userId":"b72bd827-xxxx-xxxx-xxxx-64ab32f0a0eb"}],"certifiedDeliveries":[],"currentRoutingOrder":"1","editors":[],"inPersonSigners":[],"intermediaries":[],"recipientCount":"2","signers":[{"deliveredDateTime":"2025-08-15T13:52:51.653Z","email":"jallard@example.com","isBulkRecipient":"false","name":"Jennie Allard","recipientId":"1","recipientIdGuid":"4575d5e9-xxxx-xxxx-xxxx-6c59ca7c43f8","requireIdLookup":"false","routingOrder":"1","signedDateTime":"2025-08-15T13:52:51.653Z","status":"completed","userId":"ca45284a-xxxx-xxxx-xxxx-76035bd795b2"}]},"style":"custom","title":"List Recipients and CC-ed Recipients"},{"description":"This example shows the method's response after the envelope was signed.\n\nThe signer recipient successfully authenticated using:\n* An access code (a pre-shared secret between the sender and the signer)\n* Authentication via Facebook. The Facebook email address is recorded in the Certificate of Completion\n","direction":"response","format":"json","response":{"agents":[],"carbonCopies":[],"certifiedDeliveries":[],"currentRoutingOrder":"1","editors":[],"inPersonSigners":[],"intermediaries":[],"recipientCount":"1","signers":[{"accessCode":"1234","deliveredDateTime":"2025-08-15T13:52:51.653Z","email":"larry@example.com","idCheckConfigurationName":"Facebook","isBulkRecipient":"false","name":"Larry Smithers","recipientAuthenticationStatus":{"accessCodeResult":{"eventTimestamp":"2025-08-15T13:52:51.653Z","status":"Passed"},"facebookResult":{"eventTimestamp":"2025-08-15T13:52:51.653Z","status":"Passed"}},"recipientId":"1","recipientIdGuid":"9670e679-xxxx-xxxx-xxxx-02b43027cb0a","requireIdLookup":"true","routingOrder":"1","signInEachLocation":"false","signedDateTime":"2025-08-15T13:52:51.653Z","status":"completed","userId":"57a7b68f-xxxx-xxxx-xxxx-381042d14ca5"}]},"style":"custom","title":"List Recipients Who Used Facebook and Access Code Authentication"}],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listRecipients","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Adds one or more recipients to an envelope.\n\nFor an in-process envelope,\none that has been sent and has not been completed or voided,\nan email is sent to a new recipient\nwhen they are reached in the routing order.\nIf the new recipient's routing order\nis before or the same as the envelope's\nnext recipient,\nan email is only sent if the optional\n`resend_envelope` query string is set to **true.**\n\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n \"signers\": [\n {\n \"email\": \"astanton@example.com\",\n \"name\": \"Anne Stanton\",\n \"recipientId\": \"1\",\n \"tabs\": { // These tabs will NOT be added\n \"signHereTabs\": [ // with this method. See note above.\n {\n \"anchorString\": \"below\",\n \"tooltip\": \"please sign here\"\n },\n . . .\n ]\n }\n }\n ]\n}\n```\n\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n\n\n","operationId":"Recipients_PostRecipients","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"When **true,**\nforces the envelope to be resent\nif it would not be resent otherwise.\n\nOrdinarily, if the recipient's routing order\nis before or the same as the envelope's next recipient,\nthe envelope is not resent.\n\nSetting this query parameter\nto **false** has no effect and is the same as omitting\nit altogether.\n","in":"query","name":"resend_envelope","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeRecipients"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipients"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds one or more recipients to an envelope.","tags":["EnvelopeRecipients"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createRecipient","x-ds-service":"Envelopes"},"put":{"deprecated":false,"description":"Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.\n\nIf you send information for a recipient that does not already\nexist in a draft envelope, the recipient is added to the envelope\n(similar to the [EnvelopeRecipients: Create][EnvelopeRecipients-create] method).\n\nYou can also use this method to resend an envelope to a recipient\nby using the `resend_envelope` option.\n\n**Updating Sent Envelopes**\n\nAfter an envelope has been sent, you can edit only the following properties:\n\n- `accessCode`\n- `agentCanEditName`\n- `agentCanEditEmail`\n- `customFields`\n- `deliveryMethod`\n- `documentVisibility`\n- `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)\n- `emailNotification`\n- `idCheckConfigurationName`\n- `identityVerification`\n- `name`\n- `note`\n- `phoneAuthentication`\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\n- `requireIdLookup`\n- `routingOrder`\n- `routingOrder`\n- `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)\n- `smsAuthentication`\n- `suppressEmails`\n- `userName`\n\nIf the recipient has signed,\nbut the envelope is still active,\nthe method will return success,\nbut the `recipientUpdateResults` property\nin the response will include an error\nthat the recipient could not be updated:\n\n```\n{\n \"recipientUpdateResults\": [\n {\n \"recipientId\": \"999\",\n \"errorDetails\": {\n \"errorCode\": \"RECIPIENT_UPDATE_FAILED\",\n \"message\": \"The recipient could not be updated. Recipient not in state that allows correction.\"\n }\n }\n ]\n}\n```\n\nIf the envelope is completed,\nand you try to change a recipient's address,\nthe method will fail with this error:\n\n```\n{\n \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n \"message\": \"Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct.\"\n}\n```\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n \"signers\": [\n {\n \"email\": \"astanton@example.com\",\n \"name\": \"Anne Stanton\",\n \"recipientId\": \"1\",\n// THIS WILL NOT WORK\n \"tabs\": {\n \"signHereTabs\": [\n {\n \"anchorString\": \"below\",\n \"tooltip\": \"please sign here3\"\n },\n . . .\n ]\n }\n }\n ]\n}\n```\n\n\n[EnvelopeRecipients-create]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/create/\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n\n","operationId":"Recipients_PutRecipients","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://support.docusign.com/en/guides/ndse-user-guide-manage-automatic-template-matching), and is based on Recipient Role and Routing Order.","in":"query","name":"combine_same_order_recipients","required":false,"schema":{"type":"string"}},{"description":"Indicates if offline signing is enabled for the recipient when a network connection is unavailable. ","in":"query","name":"offline_signing","required":false,"schema":{"type":"string"}},{"description":"When **true,**\nforces the envelope to be resent\nif it would not be resent otherwise.\n\nOrdinarily, if the recipient's routing order\nis before or the same as the envelope's next recipient,\nthe envelope is not resent.\n\nSetting this query parameter\nto **false** has no effect and is the same as omitting\nit altogether.\n","in":"query","name":"resend_envelope","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeRecipients"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/recipientsUpdateSummary"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.","tags":["EnvelopeRecipients"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateRecipients","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility":{"parameters":[],"put":{"deprecated":false,"description":"This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.","operationId":"Recipients_PutRecipientsDocumentVisibility","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/documentVisibilityList"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates document visibility for recipients","tags":["EnvelopeDocumentVisibility"],"x-ds-in-sdk":true,"x-ds-method":"updateRecipientsDocumentVisibility","x-ds-methodname":"updateRecipientsDocumentVisibility","x-ds-service":"EnvelopeDocumentVisibility"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}":{"delete":{"deprecated":false,"description":"Deletes a recipient from a `draft` or `sent` envelope.\n\nIf the envelope is \"In Process\" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.","operationId":"Recipients_DeleteRecipient","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipients"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes a recipient from an envelope.","tags":["EnvelopeRecipients"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteRecipient","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure":{"get":{"deprecated":false,"description":"Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. \n\nThis is the default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.","operationId":"ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}},{"description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","in":"query","name":"langCode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the default Electronic Record and Signature Disclosure for an envelope.","tags":["EnvelopeConsumerDisclosures"],"x-ds-in-sdk":true,"x-ds-method":"getDefault","x-ds-methodname":"getConsumerDisclosureDefault","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}":{"get":{"deprecated":false,"description":"Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings.\n\nTo set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.","operationId":"ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","in":"path","name":"langCode","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}},{"description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","in":"query","name":"langCode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.","tags":["EnvelopeConsumerDisclosures"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getConsumerDisclosure","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility":{"get":{"deprecated":false,"description":"This method returns information about document visibility for a recipient.","operationId":"Recipients_GetRecipientDocumentVisibility","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Returns document visibility for a recipient","tags":["EnvelopeDocumentVisibility"],"x-ds-in-sdk":true,"x-ds-method":"get","x-ds-methodname":"getRecipientDocumentVisibility","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"This method updates document visibility for a recipient.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.","operationId":"Recipients_PutRecipientDocumentVisibility","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/documentVisibilityList"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates document visibility for a recipient","tags":["EnvelopeDocumentVisibility"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateRecipientDocumentVisibility","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token":{"parameters":[],"post":{"deprecated":false,"description":"Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).","operationId":"Recipients_PostRecipientProofFileResourceToken","parameters":[{"description":"The account ID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The `recipientIdGuid`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/idEvidenceResourceToken"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a resource token for a sender to request ID Evidence data. ","tags":["EnvelopeRecipients"],"x-ds-api-status":"beta","x-ds-in-sdk":true,"x-ds-method":"createRecipientProofFileResourceToken","x-ds-methodname":"createRecipientProofFileResourceToken","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image":{"get":{"deprecated":false,"description":"Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint.\n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.","operationId":"Recipients_GetRecipientInitialsImage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}},{"description":"The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.","in":"query","name":"include_chrome","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/gif":{"schema":{"format":"binary","type":"string"}}},"description":"Successful response."},"400":{"content":{"image/gif":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the initials image for a user.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"getRecipientInitialsImage","x-ds-methodname":"getRecipientInitialsImage","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false.**","operationId":"Recipients_PutRecipientInitialsImage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Sets the initials image for an accountless signer.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"updateRecipientInitialsImage","x-ds-methodname":"updateRecipientInitialsImage","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature":{"get":{"deprecated":false,"description":"Retrieves signature information for a signer or sign-in-person recipient.","operationId":"Recipients_GetRecipientSignature","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/userSignature"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets signature information for a signer or sign-in-person recipient.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"getRecipientSignature","x-ds-methodname":"getRecipientSignature","x-ds-service":"Envelopes"},"parameters":[]},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image":{"get":{"deprecated":false,"description":"Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. \n\nFor example: \"Bob Smith\" to \"Bob%20Smith\"\n\nOlder envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.","operationId":"Recipients_GetRecipientSignatureImage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}},{"description":"When **true,** the response includes the chromed version of the signature image.","in":"query","name":"include_chrome","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/gif":{"schema":{"format":"binary","type":"string"}}},"description":"Successful response."},"400":{"content":{"image/gif":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Retrieve signature image information for a signer/sign-in-person recipient.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"getRecipientSignatureImage","x-ds-methodname":"getRecipientSignatureImage","x-ds-service":"Envelopes"},"parameters":[],"put":{"deprecated":false,"description":"Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false.**","operationId":"Recipients_PutRecipientSignatureImage","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Sets the signature image for an accountless signer.","tags":["Envelopes"],"x-ds-in-sdk":true,"x-ds-method":"updateRecipientSignatureImage","x-ds-methodname":"updateRecipientSignatureImage","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs":{"delete":{"deprecated":false,"description":"Deletes one or more tabs associated with a recipient in a draft envelope.","operationId":"Recipients_DeleteRecipientTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeRecipientTabs"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipientTabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Deletes the tabs associated with a recipient.\n\n**Note:** It is an error to delete a tab that has the\n`templateLocked` property set to true.\nThis property corresponds to the **Restrict changes** option in the web app.\n\n","tags":["EnvelopeRecipientTabs"],"x-ds-in-sdk":true,"x-ds-method":"delete","x-ds-methodname":"deleteTabs","x-ds-service":"Envelopes"},"get":{"deprecated":false,"description":"Retrieves information about the tabs associated\nwith a recipient. You can make a single API call\nto get all the tab values and information from a\ngiven, completed envelope in addition to draft\nones. Tab values can be retrieved by using the\n[EnvelopeRecipients:list method](/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/)\nwith query parameter `include_tabs` set to **true.**","operationId":"Recipients_GetRecipientTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}},{"description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","in":"query","name":"include_anchor_tab_locations","required":false,"schema":{"type":"string"}},{"description":"When **true,** the response includes metadata indicating which properties are editable.","in":"query","name":"include_metadata","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipientTabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Gets the tabs information for a signer or sign-in-person recipient in an envelope.","tags":["EnvelopeRecipientTabs"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listTabs","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Adds one or more tabs for a recipient.","operationId":"Recipients_PostRecipientTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeRecipientTabs"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipientTabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds tabs for a recipient.","tags":["EnvelopeRecipientTabs"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createTabs","x-ds-service":"Envelopes"},"put":{"deprecated":false,"description":"Updates one or more tabs for a recipient in a draft envelope.\nA draft envelope is one that is not yet complete.\n\n**Note:** It is an error to update a tab that has the\n`templateLocked` property set to true.\nThis property corresponds to the **Restrict changes** option in the web app.\n\n","operationId":"Recipients_PutRecipientTabs","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EnvelopeRecipientTabs"},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnvelopeRecipientTabs"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Updates the tabs for a recipient.\n\n","tags":["EnvelopeRecipientTabs"],"x-ds-in-sdk":true,"x-ds-method":"update","x-ds-methodname":"updateTabs","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review":{"parameters":[],"post":{"deprecated":false,"description":"This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient. ","operationId":"Views_PostRecipientManualReviewView","parameters":[{"description":"A value that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the [AppsI and Keys](https://support.docusign.com/en/guides/ndse-admin-guide-api-and-keys) page.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"A GUID value that DocuSign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account.\n\nThe specified recipient must belong to a workflow that allows the [manual review](https://support.docusign.com/en/guides/Identity-Verification-DocuSign-eSignature-Admin-Guide) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](/docs/esign-rest-api/reference/envelopes/envelopes/get/) method:\n

\n\n```\n\"recipientAuthenticationStatus\": {\n \"identityVerificationResult\": { \n \"status\": \"Failed\",\n \"eventTimestamp\": \"2020-09-04T16:59:42.8045667Z\",\n \"vendorFailureStatusCode\": \"MANUAL_REVIEW_STARTED\"\n }\n }\n```","in":"path","name":"recipientId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/viewUrl"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Create the link to the page for manually reviewing IDs.","tags":["EnvelopeRecipients"],"x-ds-in-sdk":true,"x-ds-method":"createRecipientManualReviewView","x-ds-methodname":"createRecipientManualReviewView","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview":{"parameters":[],"post":{"deprecated":false,"description":"Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n","operationId":"ResponsiveHtml_PostResponsiveHtmlPreview","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/documentHtmlDefinition"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitions"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Creates a preview of the responsive versions of all of the documents in an envelope.","tags":["ResponsiveHtmlPreview"],"x-ds-in-sdk":true,"x-ds-method":"create","x-ds-methodname":"createResponsiveHtmlPreview","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob":{"get":{"deprecated":false,"description":"This endpoint has been deprecated.","operationId":"TabsBlob_GetTabsBlob","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Reserved for DocuSign.","tags":["TabsBlob"],"x-ds-in-sdk":true,"x-ds-method":"getTabsBlob","x-ds-methodname":"getTabsBlob","x-ds-service":"Uncategorized"},"parameters":[],"put":{"deprecated":false,"description":"This endpoint has been deprecated.","operationId":"TabsBlob_PutTabsBlob","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Reserved for DocuSign.","tags":["TabsBlob"],"x-ds-in-sdk":true,"x-ds-method":"putTabsBlob","x-ds-methodname":"putTabsBlob","x-ds-service":"Uncategorized"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates":{"get":{"deprecated":false,"description":"This returns a list of the server-side templates, their name and ID, used in an envelope.\n","operationId":"Templates_GetEnvelopeTemplates","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"The possible value is `matching_applied`, which returns template matching information for the template.","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/templateInformation"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Get List of Templates used in an Envelope","tags":["EnvelopeTemplates"],"x-ds-in-sdk":true,"x-ds-method":"list","x-ds-methodname":"listTemplates","x-ds-service":"Envelopes"},"parameters":[],"post":{"deprecated":false,"description":"Adds templates to the specified envelope.","operationId":"Templates_PostEnvelopeTemplates","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}},{"description":"If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text. \n\nWhen **true,** the recipients _will be preserved_ after the template is applied.\n\n","in":"query","name":"preserve_template_recipient","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/documentTemplateList"},"responses":{"201":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/documentTemplateList"}}},"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Adds templates to an envelope.","tags":["EnvelopeTemplates"],"x-ds-in-sdk":true,"x-ds-method":"apply","x-ds-methodname":"applyTemplate","x-ds-service":"Envelopes"}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct":{"delete":{"deprecated":false,"description":"Revokes the correction view URL to the Envelope UI.","operationId":"Views_DeleteEnvelopeCorrectView","parameters":[{"description":"The external account number (int) or account ID GUID.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"description":"The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n","in":"path","name":"envelopeId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/correctViewRequest"},"responses":{"200":{"description":"Successful response."},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/errorDetails"}}},"description":"Error encountered."}},"summary":"Revokes the correction view URL to the Envelope UI.","tags":["EnvelopeViews"],"x-ds-in-sdk":true,"x-ds-method":"deleteEnvelopeCorrectView","x-ds-methodname":"deleteEnvelopeCorrectView","x-ds-service":"Uncategorized"},"parameters":[],"post":{"deprecated":false,"description":"Returns a URL that allows you to embed the envelope correction view of the DocuSign UI. To customize the appearance of the correction view, you can add special query parameters to the returned URL when you use it in your application.\n\nYou can revoke this URL by calling the [deleteEnvelopeCorrectView](/docs/esign-rest-api/reference/envelopes/envelopeviews/deleteenvelopecorrectview/) endpoint.\n\n## Best practices\n\nThe returned URL expires after 10 minutes and can only be used once. Therefore, request the URL immediately before you redirect your user to it.\n\nDue to screen space issues, do not use an `