EnvelopePublish
{
"type": "object",
"properties": {
"errorCount": {
"type": "string",
"description": ""
},
"resultsUri": {
"type": "string",
"description": ""
},
"envelopeCount": {
"type": "string",
"description": ""
},
"submissionDate": {
"type": "string",
"description": ""
},
"fileLevelErrors": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"processingStatus": {
"type": "string",
"description": ""
},
"submittedByUserInfo": {
"$ref": "#/components/schemas/userInfo"
},
"applyConnectSettings": {
"type": "string",
"description": ""
},
"processedEnvelopeCount": {
"type": "string",
"description": ""
},
"envelopeLevelErrorRollups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopePublishTransactionErrorRollup"
},
"description": ""
},
"envelopePublishTransactionId": {
"type": "string",
"description": ""
},
"noActionRequiredEnvelopeCount": {
"type": "string",
"description": ""
},
"submittedForPublishingEnvelopeCount": {
"type": "string",
"description": ""
}
},
"x-ds-order": "100",
"description": "The EnvelopePublish resource allows you to submit existing envelopes to any webhook.\n",
"x-ms-summary": "The EnvelopePublish resource allows you to submit existing envelopes to any webhook.\n",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "envelopePublishTransaction"
}
EnvelopeRecipientTabs
{
"type": "object",
"properties": {
"ssnTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssn"
},
"description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. 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\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"zipTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zip"
},
"description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"dateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date"
},
"description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, DocuSign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"drawTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/draw"
},
"description": "A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."
},
"listTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/list"
},
"description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"noteTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
},
"description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"textTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text"
},
"description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"viewTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view"
},
"description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"emailTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/email"
},
"description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"tabGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tabGroup"
},
"description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n"
},
"titleTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/title"
},
"description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"numberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/number"
},
"description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"approveTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/approve"
},
"description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"companyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/company"
},
"description": "A list of\n[Company tabs][company].\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n[company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company\n"
},
"declineTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/decline"
},
"description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"formulaTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/formulaTab"
},
"description": "A list of [Formula tabs][formulaTab].\n\nThe 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.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n[formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"prefillTabs": {
"$ref": "#/components/schemas/prefillTabs"
},
"checkboxTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkbox"
},
"description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"fullNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fullName"
},
"description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"lastNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lastName"
},
"description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"notarizeTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notarize"
},
"description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page.\n\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"signHereTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signHere"
},
"description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"firstNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/firstName"
},
"description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname\n"
},
"numericalTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/numerical"
},
"description": "A list of numerical tabs.\n\nNumerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. \n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."
},
"dateSignedTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dateSigned"
},
"description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"envelopeIdTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeId"
},
"description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid\n"
},
"notarySealTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notarySeal"
},
"description": "A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/"
},
"radioGroupTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/radioGroup"
},
"description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"initialHereTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/initialHere"
},
"description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"phoneNumberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/phoneNumber"
},
"description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"emailAddressTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailAddress"
},
"description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"smartSectionTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/smartSection"
},
"description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."
},
"commentThreadTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commentThread"
},
"description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set."
},
"commissionStateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionState"
},
"description": "A list of\n[Commission State tabs][cc].\n\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"polyLineOverlayTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/polyLineOverlay"
},
"description": "This type of tab enables the recipient to strike through document text. This value can't be set. "
},
"commissionCountyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionCounty"
},
"description": "A list of\n[Commission County tabs][cc].\n\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"commissionNumberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionNumber"
},
"description": "A list of\n[Commission Number tabs][tabref].\n\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"signerAttachmentTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signerAttachment"
},
"description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"commissionExpirationTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionExpiration"
},
"description": "A list of\n[Commission Expiration tabs][tabref].\n\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
}
},
"x-ds-order": "50",
"description": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n",
"x-ms-summary": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "tabs"
}
EnvelopeRecipients
{
"type": "object",
"properties": {
"seals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sealSign"
},
"description": "A list of electronic seals to apply to documents."
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agent"
},
"description": "A list of agent recipients assigned to the documents."
},
"editors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/editor"
},
"description": "A list of users who can edit the envelope."
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signer"
},
"description": "A list of signers on the envelope."
},
"notaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notaryRecipient"
},
"description": "A list of notary recipients on the envelope."
},
"witnesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/witness"
},
"description": "A list of signers who act as witnesses on the envelope."
},
"carbonCopies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carbonCopy"
},
"description": "A list of carbon copy recipients assigned to the documents."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/participant"
},
"description": ""
},
"intermediaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/intermediary"
},
"description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
},
"recipientCount": {
"type": "string",
"description": "The number of recipients in the envelope."
},
"inPersonSigners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inPersonSigner"
},
"description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
},
"certifiedDeliveries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/certifiedDelivery"
},
"description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
},
"currentRoutingOrder": {
"type": "string",
"description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
}
},
"x-ds-order": "20",
"description": "Envelope recipients",
"x-ms-summary": "Envelope recipients",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "recipients"
}
EnvelopeTemplates
{
"type": "object",
"properties": {
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/templateSummary"
},
"description": "An array of `templateSummary` objects that contain information about templates."
}
},
"x-ds-order": "85",
"description": "Envelope templates",
"x-ms-summary": "Envelope templates",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "templateInformation"
}
EnvelopeTransferRules
{
"type": "object",
"properties": {
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
},
"envelopeTransferRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeTransferRule"
},
"description": "Contains information about a specific envelope transfer rule."
}
},
"x-ds-order": "120",
"description": "This resource provides methods that enable account administrators to create and manage envelope transfer rules.",
"x-ms-summary": "This resource provides methods that enable account administrators to create and manage envelope transfer rules.",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "envelopeTransferRuleInformation"
}
EnvelopeViews
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The view URL to be navigated to."
}
},
"x-ds-order": "1",
"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](https://raw.githubusercontent.com)\n- [Send an envelope via your app](https://raw.githubusercontent.com)\n- [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending)\n\n",
"x-ms-summary": "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](https://raw.githubusercontent.com)\n- [Send an envelope via your app](https://raw.githubusercontent.com)\n- [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending)\n\n",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "viewUrl"
}
EnvelopeWorkflowDefinition
{
"type": "object",
"properties": {
"resumeDate": {
"type": "string",
"description": ""
},
"workflowSteps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/workflowStep"
},
"description": ""
},
"workflowStatus": {
"type": "string",
"description": ""
},
"scheduledSending": {
"$ref": "#/components/schemas/scheduledSending"
},
"currentWorkflowStepId": {
"type": "string",
"description": ""
}
},
"x-ds-order": "300",
"description": "Describes the workflow for an envelope or template.",
"x-ms-summary": "Describes the workflow for an envelope or template.",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "workflow"
}
Envelopes
{
"type": "object",
"properties": {
"holder": {
"type": "string",
"description": "Reserved for DocuSign."
},
"sender": {
"$ref": "#/components/schemas/userInfo"
},
"status": {
"type": "string",
"description": "* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
},
"brandId": {
"type": "string",
"description": "The ID of the brand."
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "A list of folder objects."
},
"location": {
"type": "string",
"description": "Reserved for DocuSign."
},
"workflow": {
"$ref": "#/components/schemas/workflow"
},
"anySigner": {
"type": "string",
"description": "Deprecated. This feature has been replaced by signing groups."
},
"brandLock": {
"type": "string",
"description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
},
"powerForm": {
"$ref": "#/components/schemas/powerForm"
},
"emailBlurb": {
"type": "string",
"description": "This is the same as the email body. If specified it is included in the email body for all envelope recipients."
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"hasWavFile": {
"type": "string",
"description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. "
},
"purgeState": {
"type": "string",
"description": "Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](https://raw.githubusercontent.com)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n\n"
},
"recipients": {
"$ref": "#/components/schemas/EnvelopeRecipients"
},
"allowMarkup": {
"type": "string",
"description": "When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
},
"envelopeUri": {
"type": "string",
"description": "The URI for retrieving the envelope or envelopes."
},
"expireAfter": {
"type": "string",
"description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
},
"hasComments": {
"type": "string",
"description": "When **true,** indicates that users have added comments to the envelope."
},
"messageLock": {
"type": "string",
"description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
},
"asynchronous": {
"type": "string",
"description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
},
"customFields": {
"$ref": "#/components/schemas/AccountCustomFields"
},
"documentsUri": {
"type": "string",
"description": "The URI for retrieving all of the documents associated with the envelope as separate files."
},
"emailSubject": {
"type": "string",
"description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
},
"notification": {
"$ref": "#/components/schemas/notification"
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"templatesUri": {
"type": "string",
"description": "The URI for retrieving the templates."
},
"voidedReason": {
"type": "string",
"description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
},
"allowComments": {
"type": "string",
"description": "When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document."
},
"allowReassign": {
"type": "string",
"description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
},
"emailSettings": {
"$ref": "#/components/schemas/emailSettings"
},
"enableWetSign": {
"type": "string",
"description": "When **true,** the signer is allowed to print the document and sign it on paper."
},
"expireEnabled": {
"type": "string",
"description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
},
"is21CFRPart11": {
"type": "string",
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
},
"recipientsUri": {
"type": "string",
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
},
"transactionId": {
"type": "string",
"description": " Used to identify an envelope. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."
},
"useDisclosure": {
"type": "string",
"description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
},
"attachmentsUri": {
"type": "string",
"description": "Contains a URL for retrieving the attachments that are associated with the envelope."
},
"autoNavigation": {
"type": "string",
"description": "When **true,** autonavigation is set for the recipient.\n"
},
"certificateUri": {
"type": "string",
"description": "The URI for retrieving certificate information."
},
"documentBase64": {
"type": "string",
"description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
},
"expireDateTime": {
"type": "string",
"description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
},
"recipientsLock": {
"type": "string",
"description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
},
"statusDateTime": {
"type": "string",
"description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
},
"voidedDateTime": {
"type": "string",
"description": "The date and time the envelope or template was voided."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
},
"customFieldsUri": {
"type": "string",
"description": "The URI for retrieving custom fields."
},
"deletedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lockInformation": {
"$ref": "#/components/schemas/EnvelopeLocks"
},
"notificationUri": {
"type": "string",
"description": "The URI for retrieving notifications."
},
"signingLocation": {
"type": "string",
"description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
},
"allowViewHistory": {
"type": "string",
"description": "When **true,** recipients can view the history of the envelope."
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"envelopeLocation": {
"type": "string",
"description": "Reserved for DocuSign."
},
"envelopeMetadata": {
"$ref": "#/components/schemas/envelopeMetadata"
},
"purgeRequestDate": {
"type": "string",
"description": "The date that a purge was requested."
},
"authoritativeCopy": {
"type": "string",
"description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
},
"completedDateTime": {
"type": "string",
"description": "Specifies the date and time this item was completed."
},
"copyRecipientData": {
"type": "string",
"description": ""
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"envelopeDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeDocument"
},
"description": "An array containing information about the documents that are included in the envelope."
},
"isDynamicEnvelope": {
"type": "string",
"description": "When **true,** indicates that the envelope is a dynamic envelope."
},
"burnDefaultTabData": {
"type": "string",
"description": ""
},
"envelopeIdStamping": {
"type": "string",
"description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
},
"externalEnvelopeId": {
"type": "string",
"description": "May contain an external identifier for the envelope."
},
"hasFormDataChanged": {
"type": "string",
"description": "Specifies if the `EnvelopeFormData` associated with any forms in the envelope has changed."
},
"purgeCompletedDate": {
"type": "string",
"description": "The date that a purge was completed."
},
"envelopeAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachment"
},
"description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
},
"initialSentDateTime": {
"type": "string",
"description": "The date and time the envelope was initially sent."
},
"documentsCombinedUri": {
"type": "string",
"description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
},
"lastModifiedDateTime": {
"type": "string",
"description": "The date and time that the item was last modified."
},
"signerCanSignOnMobile": {
"type": "string",
"description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
},
"statusChangedDateTime": {
"type": "string",
"description": "The data and time that the status changed."
},
"envelopeCustomMetadata": {
"$ref": "#/components/schemas/envelopeCustomMetadata"
},
"accessControlListBase64": {
"type": "string",
"description": "Reserved for DocuSign."
},
"enforceSignerVisibility": {
"type": "string",
"description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
},
"authoritativeCopyDefault": {
"type": "string",
"description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
},
"disableResponsiveDocument": {
"type": "string",
"description": "When **true,** responsive documents are disabled for the envelope."
},
"isSignatureProviderEnvelope": {
"type": "string",
"description": "When **true,** indicates that the envelope is a signature-provided envelope."
}
},
"x-ds-order": "10",
"description": "Envelope creation, management",
"x-ms-summary": "Envelope creation, management",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "envelope"
}
FavoriteTemplates
{
"type": "object",
"properties": {
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"favoriteTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/favoriteTemplatesContentItem"
},
"description": ""
},
"templatesUpdatedCount": {
"type": "integer",
"format": "int32",
"description": "The number of templates successfully updated by the call. This property is read-only."
}
},
"x-ds-order": "270",
"description": "",
"x-ms-summary": "",
"x-ds-category": "Accounts",
"x-ds-definition-name": "favoriteTemplatesInfo"
}
Folders
{
"type": "object",
"properties": {
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "A list of folder objects."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeSummary"
},
"description": "A list of envelopes in this folder."
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"x-ds-order": "10",
"description": "Folders allow you to organize envelopes and templates.",
"x-ms-summary": "Folders allow you to organize envelopes and templates.",
"x-ds-category": "Folders",
"x-ds-definition-name": "foldersResponse"
}
GroupBrands
{
"type": "object",
"properties": {
"brandOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/brand"
},
"description": "A list of brands."
},
"senderBrandIdDefault": {
"type": "string",
"description": "The brand that envelope senders see when a brand is not explicitly set."
},
"recipientBrandIdDefault": {
"type": "string",
"description": "The brand that envelope recipients see when a brand is not explicitly set."
}
},
"x-ds-order": "30",
"description": "If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.",
"x-ms-summary": "If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.",
"x-ds-category": "UserGroups",
"x-ds-definition-name": "brandsResponse"
}
GroupUsers
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "An array of `userInfo` objects containing information about the users in the group."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"x-ds-order": "20",
"description": "Groups' users",
"x-ms-summary": "Groups' users",
"x-ds-category": "UserGroups",
"x-ds-definition-name": "usersResponse"
}
Groups
{
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
},
"description": "A collection group objects containing information about the groups."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"x-ds-order": "10",
"description": "Group information",
"x-ms-summary": "Group information",
"x-ds-category": "UserGroups",
"x-ds-definition-name": "groupInformation"
}
IdentityVerifications
{
"type": "object",
"properties": {
"identityVerification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountIdentityVerificationWorkflow"
},
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://raw.githubusercontent.com) method in the [IdentityVerifications](https://raw.githubusercontent.com) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>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)."
}
},
"x-ds-order": "30",
"description": "Identity Verification enables you to verify a signer's identity before they can access a document. The `IdentityVerifications` resource provides a method that enables you to list the workflows that are available to an account.",
"x-ms-summary": "Identity Verification enables you to verify a signer's identity before they can access a document. The `IdentityVerifications` resource provides a method that enables you to list the workflows that are available to an account.",
"x-ds-category": "Accounts",
"x-ds-definition-name": "accountIdentityVerificationResponse"
}
Invoices
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "Reserved for DocuSign."
},
"balance": {
"type": "string",
"description": "Reserved for DocuSign."
},
"dueDate": {
"type": "string",
"description": "Reserved for DocuSign."
},
"invoiceId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"invoiceUri": {
"type": "string",
"description": "Contains a URI for an endpoint that you can use to retrieve invoice information."
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billingInvoiceItem"
},
"description": "Reserved for DocuSign."
},
"pdfAvailable": {
"type": "string",
"description": ""
},
"invoiceNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"taxableAmount": {
"type": "string",
"description": ""
},
"nonTaxableAmount": {
"type": "string",
"description": ""
}
},
"x-ds-order": "20",
"description": "Invoices",
"x-ms-summary": "Invoices",
"x-ds-category": "Billing",
"x-ds-definition-name": "billingInvoice"
}
Notary
{
"type": "object",
"properties": {
"enabled": {
"type": "string",
"description": ""
},
"userInfo": {
"$ref": "#/components/schemas/userInformation"
},
"searchable": {
"type": "string",
"description": ""
},
"createdDate": {
"type": "string",
"description": "The creation date of the account in UTC timedate format."
}
},
"x-ds-order": "280",
"description": "Use DocuSign eNotary to notarize documents digitally.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/s/document-item?bundleId=gko1642535666104&topicId=jiv1635359045452.html)\nto see which jurisdictions are supported.\n",
"x-ms-summary": "Use DocuSign eNotary to notarize documents digitally.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/s/document-item?bundleId=gko1642535666104&topicId=jiv1635359045452.html)\nto see which jurisdictions are supported.\n",
"x-ds-category": "Notary",
"x-ds-definition-name": "notary"
}
NotaryJournals
{
"type": "object",
"properties": {
"signerName": {
"type": "string",
"description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
},
"createdDate": {
"type": "string",
"description": "The creation date of the account in UTC timedate format."
},
"documentName": {
"type": "string",
"description": ""
},
"jurisdiction": {
"$ref": "#/components/schemas/jurisdiction"
},
"notaryJournalId": {
"type": "string",
"description": ""
},
"notaryJournalMetaData": {
"$ref": "#/components/schemas/notaryJournalMetaData"
}
},
"x-ds-order": "220",
"description": "",
"x-ms-summary": "",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "notaryJournal"
}
NotaryJurisdiction
{
"type": "object",
"properties": {
"county": {
"type": "string",
"description": ""
},
"sealType": {
"type": "string",
"description": ""
},
"commissionId": {
"type": "string",
"description": ""
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"jurisdiction": {
"$ref": "#/components/schemas/jurisdiction"
},
"registeredName": {
"type": "string",
"description": ""
},
"commissionExpiration": {
"type": "string",
"description": ""
}
},
"x-ds-order": "290",
"description": "Creating, updating, and deleting notary jurisdiction objects.",
"x-ms-summary": "Creating, updating, and deleting notary jurisdiction objects.",
"x-ds-category": "Notary",
"x-ds-definition-name": "notaryJurisdiction"
}
NotificationDefaults
{
"type": "object",
"properties": {
"emailNotifications": {
"$ref": "#/components/schemas/notificationDefaultSettings"
},
"apiEmailNotifications": {
"$ref": "#/components/schemas/notificationDefaultSettings"
}
},
"x-ds-order": "120",
"description": "The `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes.",
"x-ms-summary": "The `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes.",
"x-ds-category": "Accounts",
"x-ds-definition-name": "notificationDefaults"
}
PagesGetPageImageResponse
{
"type": "string",
"format": "binary"
}
PagesGetTemplatePageImageResponse
{
"type": "string",
"format": "binary"
}
PaymentGatewayAccounts
{
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/paymentGatewayAccountSetting"
},
"isLegacy": {
"type": "string",
"description": "Reserved for DocuSign."
},
"isEnabled": {
"type": "string",
"description": "When **true,** the payment gateway account is enabled."
},
"displayName": {
"type": "string",
"description": "A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`."
},
"lastModified": {
"type": "string",
"description": "The UTC DateTime that the payment gateway account was last updated."
},
"paymentGateway": {
"type": "string",
"description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`\n* `CyberSource`\n* `Zuora`\n* `Elavon`"
},
"allowCustomMetadata": {
"type": "boolean",
"description": "When **true,** the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`. \n\nFor example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description.**\n\n**Note:** This property is read-only and cannot be changed."
},
"supportedCurrencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"
},
"payPalLegacySettings": {
"$ref": "#/components/schemas/payPalLegacySettings"
},
"zeroDecimalCurrencies": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"paymentGatewayAccountId": {
"type": "string",
"description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`."
},
"supportedPaymentMethods": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway."
},
"paymentGatewayDisplayName": {
"type": "string",
"description": "The display name of the payment gateway that the connected gateway account uses.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net\n* CyberSource\n* Zuora\n* Elavon"
},
"supportedPaymentMethodsWithOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentMethodWithOptions"
},
"description": "An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method."
}
},
"x-ds-order": "210",
"description": "Information about a connected payment gateway account.",
"x-ms-summary": "Information about a connected payment gateway account.",
"x-ds-category": "Payments",
"x-ds-definition-name": "paymentGatewayAccount"
}
Payments
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "Reserved for DocuSign."
},
"paymentId": {
"type": "string",
"description": "The ID of the payment."
},
"description": {
"type": "string",
"description": "A sender-defined description of the line item.\n"
},
"paymentDate": {
"type": "string",
"description": ""
},
"paymentNumber": {
"type": "string",
"description": "When **true,** a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."
}
},
"x-ds-order": "30",
"description": "Payments",
"x-ms-summary": "Payments",
"x-ds-category": "Billing",
"x-ds-definition-name": "billingPaymentItem"
}
PowerFormData
{
"type": "object",
"properties": {
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerFormFormDataRecipient"
},
"description": "An array of powerform recipients."
}
},
"x-ds-order": "90",
"description": "Data that recipients have entered in PowerForm fields.",
"x-ms-summary": "Data that recipients have entered in PowerForm fields.",
"x-ds-category": "PowerForms",
"x-ds-definition-name": "powerFormFormDataEnvelope"
}
PowerForms
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The URI for the PowerForm."
},
"name": {
"type": "string",
"description": "The name of the PowerForm."
},
"isActive": {
"type": "string",
"description": "When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\n\nWhen **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender."
},
"lastUsed": {
"type": "string",
"description": "The date and time that the PowerForm was last used."
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the PowerForm. This property is returned in a response only when you set the `include_created_by` query parameter to **true.**"
},
"emailBody": {
"type": "string",
"description": "For a PowerForm that is sent by email, this is the body of the email message sent to the recipients.\n\nMaximum length: 10000 characters."
},
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelope"
},
"description": "An array of envelope objects that contain information about the envelopes that are associated with the PowerForm."
},
"timesUsed": {
"type": "string",
"description": "The number of times the PowerForm has been used. "
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerFormRecipient"
},
"description": "An array of `powerFormRecipient` objects.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can enter generic information for the `role` property and leave other details (such as `name` and `email`) blank."
},
"senderName": {
"type": "string",
"description": "The name of the sender. \n\n**Note:** The default sender for a PowerForm is the PowerForm Administrator who created it."
},
"templateId": {
"type": "string",
"description": "The ID of the template used to create the PowerForm."
},
"powerFormId": {
"type": "string",
"description": "The ID of the PowerForm."
},
"signingMode": {
"type": "string",
"description": "The signing method to use. Valid values are:\n\n- `email`: This mode verifies the recipient's identity by using email authentication before the recipient can sign a document.\n\n- `direct`: This mode does not require any verification. DocuSign recommends that you use this signing method only when another form of authentication is in use.\n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\n\nFor more information about signing modes, see the [overview of the Create method](https://raw.githubusercontent.com)."
},
"emailSubject": {
"type": "string",
"description": "Sets the envelope name for the envelopes that the PowerForm generates. One option is to make this property the same as the subject from the template.\n\nYou can customize the subject line to include a recipient's name or email address by using merge fields. For information about adding merge fields to the email subject, see [Template Email Subject Merge Fields](https://raw.githubusercontent.com).\n"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"instructions": {
"type": "string",
"description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. When you include instructions, they display as an introduction after the recipient accesses the PowerForm."
},
"powerFormUrl": {
"type": "string",
"description": "The URL for the PowerForm."
},
"senderUserId": {
"type": "string",
"description": "The ID of the sender."
},
"templateName": {
"type": "string",
"description": "The name of the template used to create the PowerForm."
},
"maxUseEnabled": {
"type": "string",
"description": "When **true,** you can set a maximum number of uses for the PowerForm."
},
"usesRemaining": {
"type": "string",
"description": "The number of times that the PowerForm can still be used. If no use limit is set, the value is `Unlimited`. "
},
"createdDateTime": {
"type": "string",
"description": "The date and time that the PowerForm was created."
},
"limitUseInterval": {
"type": "string",
"description": "The length of time before the same recipient can sign the same PowerForm again. This property is used in combination with the `limitUseIntervalUnits` property."
},
"limitUseIntervalUnits": {
"type": "string",
"description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours`\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n"
},
"limitUseIntervalEnabled": {
"type": "string",
"description": "When **true,** the `limitUseInterval` is enabled."
}
},
"x-ds-order": "80",
"description": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.",
"x-ms-summary": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.",
"x-ds-category": "PowerForms",
"x-ds-definition-name": "powerForm"
}
RecipientsGetRecipientInitialsImageResponse
{
"type": "string",
"format": "binary"
}
RecipientsGetRecipientSignatureImageResponse
{
"type": "string",
"format": "binary"
}
RequestLogs
{
"type": "object",
"properties": {
"apiRequestLogging": {
"type": "string",
"description": " When **true,** enables API request logging for the user. "
},
"apiRequestLogMaxEntries": {
"type": "string",
"description": "Specifies the maximum number of API requests to log."
},
"apiRequestLogRemainingEntries": {
"type": "string",
"description": "Indicates the remaining number of API requests that can be logged."
}
},
"x-ds-order": "10",
"description": "Request logs",
"x-ms-summary": "Request logs",
"x-ds-category": "Diagnostics",
"x-ds-definition-name": "diagnosticsSettingsInformation"
}
ReservedDomains
{
"description": "",
"x-ms-summary": "",
"x-ds-category": "Accounts"
}
Resources
{
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": ""
}
},
"x-ds-order": "20",
"description": "API resource information",
"x-ms-summary": "API resource information",
"x-ds-category": "Diagnostics",
"x-ds-definition-name": "resourceInformation"
}
ResponsiveHtml
{
"type": "object",
"properties": {
"htmlDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
}
},
"x-ds-order": "100",
"description": "",
"x-ms-summary": "",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
ResponsiveHtmlPreview
{
"type": "object",
"properties": {
"htmlDefinitions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
}
},
"x-ds-order": "250",
"description": "This resource is used to create a responsive preview of all of the documents in an envelope.",
"x-ms-summary": "This resource is used to create a responsive preview of all of the documents in an envelope.",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "documentHtmlDefinitions"
}
Services
{
"type": "object",
"properties": {
"buildSHA": {
"type": "string",
"description": "Reserved for DocuSign."
},
"buildBranch": {
"type": "string",
"description": "Reserved for DocuSign."
},
"linkedSites": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"buildVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"serviceVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/serviceVersion"
},
"description": ""
},
"buildBranchDeployedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"x-ds-order": "30",
"description": "API service information",
"x-ms-summary": "API service information",
"x-ds-category": "Diagnostics",
"x-ds-definition-name": "serviceInformation"
}
SigningGroupUsers
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signingGroupUser"
},
"description": "User management information."
}
},
"x-ds-order": "20",
"description": "Signing groups' users",
"x-ms-summary": "Signing groups' users",
"x-ds-category": "SigningGroups",
"x-ds-definition-name": "signingGroupUsers"
}
SigningGroups
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signingGroupUser"
},
"description": "User management information."
},
"created": {
"type": "string",
"description": "The UTC DateTime when the workspace user authorization was created."
},
"modified": {
"type": "string",
"description": "The date and time that the signing group was last modified."
},
"createdBy": {
"type": "string",
"description": "The name of the user who created the signing group."
},
"groupName": {
"type": "string",
"description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."
},
"groupType": {
"type": "string",
"description": "The group type. Possible values include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n- `sharedSigningGroup`\n\n<!-- More? To do -->"
},
"groupEmail": {
"type": "string",
"description": "The email address for the signing group. You can use a group email address to email all of the group members at the same time."
},
"modifiedBy": {
"type": "string",
"description": "The user ID (GUID) of the user who last modified this user record. This property is read-only."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
}
},
"x-ds-order": "10",
"description": "Signing groups",
"x-ms-summary": "Signing groups",
"x-ds-category": "SigningGroups",
"x-ds-definition-name": "signingGroup"
}
TabsBlob
{
"type": "object",
"properties": {
"allowTabOrder": {
"type": "string",
"description": "When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting."
},
"drawTabsEnabled": {
"type": "string",
"description": ""
},
"listTabsEnabled": {
"type": "string",
"description": "When **true,** list tabs are enabled."
},
"noteTabsEnabled": {
"type": "string",
"description": "When **true,** note tabs are enabled."
},
"tabScaleEnabled": {
"type": "string",
"description": "Reserved for DocuSign."
},
"textTabsEnabled": {
"type": "string",
"description": "When **true,** text tabs are enabled."
},
"drawTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"listTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"noteTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"radioTabsEnabled": {
"type": "string",
"description": "When **true,** radio button tabs are enabled."
},
"tabScaleMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"textTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"radioTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"tabLockingEnabled": {
"type": "string",
"description": "When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
},
"prefillTabsEnabled": {
"type": "string",
"description": ""
},
"tabLocationEnabled": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabLockingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"checkboxTabsEnabled": {
"type": "string",
"description": "When **true,** checkbox tabs are enabled."
},
"prefillTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"tabDataLabelEnabled": {
"type": "string",
"description": "When **true,** [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting.\n"
},
"tabLocationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"checkBoxTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dataFieldSizeEnabled": {
"type": "string",
"description": "When **true,** setting character limits for input fields is enabled."
},
"numericalTabsEnabled": {
"type": "string",
"description": ""
},
"tabDataLabelMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowTabOrderMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dataFieldRegexEnabled": {
"type": "string",
"description": "When **true,** regular expressions are enabled for tabs that contain data fields."
},
"dataFieldSizeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"numericalTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dataFieldRegexMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"calculatedFieldsEnabled": {
"type": "string",
"description": "When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs."
},
"savingCustomTabsEnabled": {
"type": "string",
"description": "When **true,** saving custom tabs is enabled."
},
"sharedCustomTabsEnabled": {
"type": "string",
"description": "When **true,** shared custom tabs are enabled."
},
"calculatedFieldsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"savingCustomTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"sharedCustomTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"tabTextFormattingEnabled": {
"type": "string",
"description": "When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** Only Admin users can change this setting.\n"
},
"approveDeclineTabsEnabled": {
"type": "string",
"description": "When **true,** approve and decline tabs are enabled."
},
"firstLastEmailTabsEnabled": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabTextFormattingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"approveDeclineTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"firstLastEmailTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"senderToChangeTabAssignmentsEnabled": {
"type": "string",
"description": "Reserved for DocuSign."
},
"senderToChangeTabAssignmentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
}
},
"x-ds-order": "120",
"description": "Reserved for DocuSign.",
"x-ms-summary": "Reserved for DocuSign.",
"x-ds-category": "Envelopes",
"x-ds-definition-name": "tabAccountSettings"
}
TemplateCustomFields
{
"type": "object",
"properties": {
"listCustomFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/listCustomField"
},
"description": "An array of list custom fields."
},
"textCustomFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/textCustomField"
},
"description": "An array of text custom fields."
}
},
"x-ds-order": "70",
"description": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.",
"x-ms-summary": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.",
"x-ds-category": "Templates",
"x-ds-definition-name": "customFields"
}
TemplateDocumentFields
{
"type": "object",
"properties": {
"documentFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "The array of name/value custom data strings to add to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the following elements: \n\n* `name` - A string that can be a maximum of 50 characters. \n* `value` - A string that can be a maximum of 200 characters.\n\n**Important:** If you are using XML, the name/value pair is contained in a `nameValue` element. \n"
}
},
"x-ds-order": "60",
"description": "Template document fields",
"x-ms-summary": "Template document fields",
"x-ds-category": "Templates",
"x-ds-definition-name": "documentFieldsInformation"
}
TemplateDocumentHtmlDefinitions
{
"type": "object",
"properties": {
"htmlDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
}
},
"x-ds-order": "300",
"description": "",
"x-ms-summary": "",
"x-ds-category": "Templates",
"x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
TemplateDocumentResponsiveHtmlPreview
{
"type": "object",
"properties": {
"htmlDefinitions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
}
},
"x-ds-order": "280",
"description": "This resource is used to create a responsive preview of a specific template document.",
"x-ms-summary": "This resource is used to create a responsive preview of a specific template document.",
"x-ds-category": "Templates",
"x-ds-definition-name": "documentHtmlDefinitions"
}
TemplateDocumentTabs
{
"type": "object",
"properties": {
"ssnTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssn"
},
"description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. 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\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"zipTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zip"
},
"description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"dateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date"
},
"description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, DocuSign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"drawTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/draw"
},
"description": "A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."
},
"listTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/list"
},
"description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"noteTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
},
"description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"textTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text"
},
"description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"viewTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view"
},
"description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"emailTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/email"
},
"description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"tabGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tabGroup"
},
"description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n"
},
"titleTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/title"
},
"description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"numberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/number"
},
"description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"approveTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/approve"
},
"description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"companyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/company"
},
"description": "A list of\n[Company tabs][company].\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n[company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company\n"
},
"declineTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/decline"
},
"description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"formulaTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/formulaTab"
},
"description": "A list of [Formula tabs][formulaTab].\n\nThe 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.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n[formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"prefillTabs": {
"$ref": "#/components/schemas/prefillTabs"
},
"checkboxTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkbox"
},
"description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"fullNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fullName"
},
"description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"lastNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lastName"
},
"description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"notarizeTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notarize"
},
"description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page.\n\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"signHereTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signHere"
},
"description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"firstNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/firstName"
},
"description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname\n"
},
"numericalTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/numerical"
},
"description": "A list of numerical tabs.\n\nNumerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. \n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."
},
"dateSignedTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dateSigned"
},
"description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"envelopeIdTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeId"
},
"description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid\n"
},
"notarySealTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notarySeal"
},
"description": "A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/"
},
"radioGroupTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/radioGroup"
},
"description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"initialHereTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/initialHere"
},
"description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"phoneNumberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/phoneNumber"
},
"description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"emailAddressTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailAddress"
},
"description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"smartSectionTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/smartSection"
},
"description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."
},
"commentThreadTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commentThread"
},
"description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set."
},
"commissionStateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionState"
},
"description": "A list of\n[Commission State tabs][cc].\n\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"polyLineOverlayTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/polyLineOverlay"
},
"description": "This type of tab enables the recipient to strike through document text. This value can't be set. "
},
"commissionCountyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionCounty"
},
"description": "A list of\n[Commission County tabs][cc].\n\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"commissionNumberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionNumber"
},
"description": "A list of\n[Commission Number tabs][tabref].\n\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"signerAttachmentTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signerAttachment"
},
"description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"commissionExpirationTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionExpiration"
},
"description": "A list of\n[Commission Expiration tabs][tabref].\n\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
}
},
"x-ds-order": "50",
"description": "",
"x-ms-summary": "",
"x-ds-category": "Templates",
"x-ds-definition-name": "tabs"
}
TemplateDocumentVisibility
{
"type": "object",
"properties": {
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients."
}
},
"x-ds-order": "180",
"description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
"x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
"x-ds-category": "Templates",
"x-ds-definition-name": "templateDocumentVisibilityList"
}
TemplateDocuments
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"description": "The ID of the template. If a value is not provided, DocuSign generates a value. "
},
"templateDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeDocument"
},
"description": "An array of document objects that contain information about the documents associated with the template."
}
},
"x-ds-order": "40",
"description": "Template documents",
"x-ms-summary": "Template documents",
"x-ds-category": "Templates",
"x-ds-definition-name": "templateDocumentsResult"
}
TemplateHtmlDefinitions
{
"type": "object",
"properties": {
"htmlDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
}
},
"x-ds-order": "310",
"description": "",
"x-ms-summary": "",
"x-ds-category": "Templates",
"x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
TemplateLocks
{
"type": "object",
"properties": {
"lockType": {
"type": "string",
"description": "The type of lock. Currently `edit` is the only supported type."
},
"lockToken": {
"type": "string",
"description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock."
},
"lockedByApp": {
"type": "string",
"description": "Specifies the friendly name of the application that is locking the envelope."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"lockedByUser": {
"$ref": "#/components/schemas/userInfo"
},
"useScratchPad": {
"type": "string",
"description": "When **true,** a scratchpad is used to edit information.\n "
},
"lockedUntilDateTime": {
"type": "string",
"description": "The date and time that the lock expires."
},
"lockDurationInSeconds": {
"type": "string",
"description": "The number of seconds until the lock expires when there is no activity on the template.\n\nIf no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n"
}
},
"x-ds-order": "80",
"description": "This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.",
"x-ms-summary": "This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.",
"x-ds-category": "Templates",
"x-ds-definition-name": "lockInformation"
}
TemplateRecipientTabs
{
"type": "object",
"properties": {
"ssnTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssn"
},
"description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. 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\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"zipTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zip"
},
"description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"dateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date"
},
"description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, DocuSign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"drawTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/draw"
},
"description": "A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."
},
"listTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/list"
},
"description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"noteTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/note"
},
"description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"textTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text"
},
"description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"viewTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view"
},
"description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"emailTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/email"
},
"description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"tabGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tabGroup"
},
"description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n"
},
"titleTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/title"
},
"description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"numberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/number"
},
"description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"approveTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/approve"
},
"description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"companyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/company"
},
"description": "A list of\n[Company tabs][company].\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n[company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company\n"
},
"declineTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/decline"
},
"description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"formulaTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/formulaTab"
},
"description": "A list of [Formula tabs][formulaTab].\n\nThe 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.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n[formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"prefillTabs": {
"$ref": "#/components/schemas/prefillTabs"
},
"checkboxTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkbox"
},
"description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"fullNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fullName"
},
"description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"lastNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/lastName"
},
"description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"notarizeTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notarize"
},
"description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page.\n\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"signHereTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signHere"
},
"description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"firstNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/firstName"
},
"description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname\n"
},
"numericalTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/numerical"
},
"description": "A list of numerical tabs.\n\nNumerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. \n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."
},
"dateSignedTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dateSigned"
},
"description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"envelopeIdTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeId"
},
"description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid\n"
},
"notarySealTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notarySeal"
},
"description": "A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/"
},
"radioGroupTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/radioGroup"
},
"description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"initialHereTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/initialHere"
},
"description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"phoneNumberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/phoneNumber"
},
"description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"emailAddressTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/emailAddress"
},
"description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"smartSectionTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/smartSection"
},
"description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."
},
"commentThreadTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commentThread"
},
"description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set."
},
"commissionStateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionState"
},
"description": "A list of\n[Commission State tabs][cc].\n\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"polyLineOverlayTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/polyLineOverlay"
},
"description": "This type of tab enables the recipient to strike through document text. This value can't be set. "
},
"commissionCountyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionCounty"
},
"description": "A list of\n[Commission County tabs][cc].\n\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"commissionNumberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionNumber"
},
"description": "A list of\n[Commission Number tabs][tabref].\n\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
},
"signerAttachmentTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signerAttachment"
},
"description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"commissionExpirationTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commissionExpiration"
},
"description": "A list of\n[Commission Expiration tabs][tabref].\n\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
}
},
"x-ds-order": "50",
"description": "Template tabs",
"x-ms-summary": "Template tabs",
"x-ds-category": "Templates",
"x-ds-definition-name": "tabs"
}
TemplateRecipients
{
"type": "object",
"properties": {
"seals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sealSign"
},
"description": "Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html"
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agent"
},
"description": "A list of agent recipients assigned to the documents."
},
"editors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/editor"
},
"description": "A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document."
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signer"
},
"description": "A list of signers on the envelope."
},
"notaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notaryRecipient"
},
"description": "A list of notary recipients on the envelope."
},
"witnesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/witness"
},
"description": "A list of signers who act as witnesses on the envelope."
},
"carbonCopies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carbonCopy"
},
"description": "A list of carbon copy recipients assigned to the documents."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/participant"
},
"description": ""
},
"intermediaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/intermediary"
},
"description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
},
"recipientCount": {
"type": "string",
"description": "The number of recipients in the envelope."
},
"inPersonSigners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inPersonSigner"
},
"description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
},
"certifiedDeliveries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/certifiedDelivery"
},
"description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
},
"currentRoutingOrder": {
"type": "string",
"description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
}
},
"x-ds-order": "20",
"description": "Template recipients",
"x-ms-summary": "Template recipients",
"x-ds-category": "Templates",
"x-ds-definition-name": "recipients"
}
TemplateResponsiveHtmlPreview
{
"type": "object",
"properties": {
"htmlDefinitions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
}
},
"x-ds-order": "290",
"description": "This resource is used to create a responsive preview of all of the documents associated with a template.",
"x-ms-summary": "This resource is used to create a responsive preview of all of the documents associated with a template.",
"x-ds-category": "Templates",
"x-ds-definition-name": "documentHtmlDefinitions"
}
TemplateViews
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL that you navigate to in order to start the view."
}
},
"x-ds-order": "55",
"description": "A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).",
"x-ms-summary": "A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).",
"x-ds-category": "Templates",
"x-ds-definition-name": "viewUrl"
}
Templates
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Contains a URI that you can use to retreve the template."
},
"name": {
"type": "string",
"description": "The name of the template."
},
"owner": {
"$ref": "#/components/schemas/userInfo"
},
"holder": {
"type": "string",
"description": "Reserved for DocuSign."
},
"sender": {
"$ref": "#/components/schemas/userInfo"
},
"shared": {
"type": "string",
"description": "When **true,** indicates the template is shared with the **Everyone** group,\nand is shared with all users on the account.\n\nWhen **false,** the template is shared only with the groups you specify."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
},
"brandId": {
"type": "string",
"description": "The ID of the brand."
},
"created": {
"type": "string",
"description": "The UTC DateTime when the workspace user authorization was created."
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "A list of folder objects."
},
"folderId": {
"type": "string",
"description": "The unique identifier for the folder that the template belongs to."
},
"lastUsed": {
"type": "string",
"description": "The date and time the template was last used."
},
"location": {
"type": "string",
"description": "Reserved for DocuSign."
},
"password": {
"type": "string",
"description": "The password for editing the template."
},
"workflow": {
"$ref": "#/components/schemas/workflow"
},
"anySigner": {
"type": "string",
"description": "Deprecated. This feature has been replaced by signing groups."
},
"autoMatch": {
"type": "string",
"description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching."
},
"brandLock": {
"type": "string",
"description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/document"
},
"description": "A complex element that contains details about the documents associated with the envelope."
},
"folderIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of folder IDs that the template is in."
},
"pageCount": {
"type": "string",
"description": "An integer value specifying the number of document pages in the template. "
},
"powerForm": {
"$ref": "#/components/schemas/powerForm"
},
"emailBlurb": {
"type": "string",
"description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients."
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"folderName": {
"type": "string",
"description": "The name of the folder the template belongs to."
},
"hasWavFile": {
"type": "string",
"description": "When **true,** indicates that the template includes a .wav file."
},
"powerForms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerForm"
},
"description": "An array of PowerForm objects that contain information about any PowerForms that are included in the template."
},
"purgeState": {
"type": "string",
"description": "Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](https://raw.githubusercontent.com)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n\n"
},
"recipients": {
"$ref": "#/components/schemas/EnvelopeRecipients"
},
"templateId": {
"type": "string",
"description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
},
"allowMarkup": {
"type": "string",
"description": "When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
},
"description": {
"type": "string",
"description": "A sender-defined description of the line item.\n"
},
"envelopeUri": {
"type": "string",
"description": "The URI for retrieving the envelope or envelopes."
},
"expireAfter": {
"type": "string",
"description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
},
"hasComments": {
"type": "string",
"description": "When **true,** indicates that users have added comments to the envelope."
},
"messageLock": {
"type": "string",
"description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
},
"newPassword": {
"type": "string",
"description": "The user's new password."
},
"asynchronous": {
"type": "string",
"description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
},
"customFields": {
"$ref": "#/components/schemas/AccountCustomFields"
},
"documentsUri": {
"type": "string",
"description": "The URI for retrieving all of the documents associated with the envelope as separate files."
},
"emailSubject": {
"type": "string",
"description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
},
"lastModified": {
"type": "string",
"description": "The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator."
},
"notification": {
"$ref": "#/components/schemas/notification"
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"templatesUri": {
"type": "string",
"description": "The URI for retrieving the templates."
},
"voidedReason": {
"type": "string",
"description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
},
"allowComments": {
"type": "string",
"description": "When **true,** indicates that comments are allowed on the envelope."
},
"allowReassign": {
"type": "string",
"description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
},
"emailSettings": {
"$ref": "#/components/schemas/emailSettings"
},
"enableWetSign": {
"type": "string",
"description": "When **true,** the signer is allowed to print the document and sign it on paper."
},
"expireEnabled": {
"type": "string",
"description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
},
"favoritedByMe": {
"type": "string",
"description": ""
},
"is21CFRPart11": {
"type": "string",
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
},
"recipientsUri": {
"type": "string",
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
},
"transactionId": {
"type": "string",
"description": " Used to identify an envelope. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."
},
"useDisclosure": {
"type": "string",
"description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
},
"attachmentsUri": {
"type": "string",
"description": "Contains a URL for retrieving the attachments that are associated with the envelope."
},
"autoNavigation": {
"type": "string",
"description": "When **true,** autonavigation is set for the recipient.\n"
},
"certificateUri": {
"type": "string",
"description": "The URI for retrieving certificate information."
},
"documentBase64": {
"type": "string",
"description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
},
"expireDateTime": {
"type": "string",
"description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
},
"lastModifiedBy": {
"$ref": "#/components/schemas/userInfo"
},
"recipientsLock": {
"type": "string",
"description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
},
"statusDateTime": {
"type": "string",
"description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
},
"voidedDateTime": {
"type": "string",
"description": "The date and time the envelope or template was voided."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
},
"customFieldsUri": {
"type": "string",
"description": "The URI for retrieving custom fields."
},
"deletedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lockInformation": {
"$ref": "#/components/schemas/EnvelopeLocks"
},
"notificationUri": {
"type": "string",
"description": "The URI for retrieving notifications."
},
"signingLocation": {
"type": "string",
"description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
},
"allowViewHistory": {
"type": "string",
"description": "When **true,** recipients can view the history of the envelope."
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"envelopeLocation": {
"type": "string",
"description": "Reserved for DocuSign."
},
"envelopeMetadata": {
"$ref": "#/components/schemas/envelopeMetadata"
},
"isAceGenTemplate": {
"type": "string",
"description": ""
},
"isDocGenTemplate": {
"type": "string",
"description": ""
},
"purgeRequestDate": {
"type": "string",
"description": "The date that a purge was requested."
},
"authoritativeCopy": {
"type": "string",
"description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
},
"completedDateTime": {
"type": "string",
"description": "Specifies the date and time this item was completed."
},
"copyRecipientData": {
"type": "string",
"description": ""
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"envelopeDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeDocument"
},
"description": "An array containing information about the documents that are included in the envelope."
},
"isDynamicEnvelope": {
"type": "string",
"description": "When **true,** indicates that the envelope is a dynamic envelope."
},
"passwordProtected": {
"type": "string",
"description": "When **true,** a password is required to edit the template."
},
"burnDefaultTabData": {
"type": "string",
"description": ""
},
"envelopeIdStamping": {
"type": "string",
"description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
},
"externalEnvelopeId": {
"type": "string",
"description": "May contain an external identifier for the envelope."
},
"hasFormDataChanged": {
"type": "string",
"description": "Specifies if the `EnvelopeFormData` associated with any forms in the template has changed."
},
"purgeCompletedDate": {
"type": "string",
"description": "The date that a purge was completed."
},
"envelopeAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachment"
},
"description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
},
"initialSentDateTime": {
"type": "string",
"description": "The date and time the envelope that used the template was initially sent."
},
"documentsCombinedUri": {
"type": "string",
"description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
},
"lastModifiedDateTime": {
"type": "string",
"description": "The date and time the template was last modified."
},
"signerCanSignOnMobile": {
"type": "string",
"description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
},
"statusChangedDateTime": {
"type": "string",
"description": "The data and time that the status changed."
},
"envelopeCustomMetadata": {
"$ref": "#/components/schemas/envelopeCustomMetadata"
},
"accessControlListBase64": {
"type": "string",
"description": "Reserved for DocuSign."
},
"enforceSignerVisibility": {
"type": "string",
"description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
},
"authoritativeCopyDefault": {
"type": "string",
"description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
},
"autoMatchSpecifiedByUser": {
"type": "string",
"description": "When **true,** the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property."
},
"disableResponsiveDocument": {
"type": "string",
"description": "When **true,** responsive documents are disabled for the envelope."
},
"isSignatureProviderEnvelope": {
"type": "string",
"description": "When **true,** indicates that the envelope is a signature-provided envelope."
}
},
"x-ds-order": "10",
"description": "Template management",
"x-ms-summary": "Template management",
"x-ds-category": "Templates",
"x-ds-definition-name": "envelopeTemplate"
}