documentTemplateList
{
"type": "object",
"properties": {
"documentTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentTemplate"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "documentTemplateList"
}
documentVisibility
{
"type": "object",
"properties": {
"rights": {
"type": "string",
"description": "Indicates whether the document is editable:\n\n- `editable`\n- `read_only`"
},
"visible": {
"type": "string",
"description": "When **true,** the document is visible to the recipient."
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.\n"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
}
},
"description": "This object configures a recipient's read/write access to a document.",
"x-ms-summary": "This object configures a recipient's read/write access to a document.",
"x-ds-definition-name": "documentVisibility"
}
documentVisibilityList
{
"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."
}
},
"description": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.",
"x-ms-summary": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.",
"x-ds-definition-name": "documentVisibilityList"
}
downgradRequestBillingInfoResponse
{
"type": "object",
"properties": {
"paymentMethod": {
"type": "string",
"description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
},
"downgradePlanInformation": {
"$ref": "#/components/schemas/downgradePlanUpdateResponse"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "downgradRequestBillingInfoResponse"
}
downgradeBillingPlanInformation
{
"type": "object",
"properties": {
"promoCode": {
"type": "string",
"description": ""
},
"saleDiscount": {
"type": "string",
"description": ""
},
"planInformation": {
"$ref": "#/components/schemas/planInformation"
},
"saleDiscountType": {
"type": "string",
"description": ""
},
"downgradeEventType": {
"type": "string",
"description": ""
},
"saleDiscountPeriods": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "downgradeBillingPlanInformation"
}
downgradePlanUpdateResponse
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": ""
},
"productId": {
"type": "string",
"description": "The Product ID from the AppStore."
},
"promoCode": {
"type": "string",
"description": ""
},
"saleDiscount": {
"type": "string",
"description": ""
},
"discountApplied": {
"type": "string",
"description": ""
},
"downgradePlanId": {
"type": "string",
"description": ""
},
"saleDiscountType": {
"type": "string",
"description": ""
},
"downgradePlanName": {
"type": "string",
"description": ""
},
"saleDiscountPeriods": {
"type": "string",
"description": "Reserved for DocuSign."
},
"accountPaymentMethod": {
"type": "string",
"description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- "
},
"downgradePaymentCycle": {
"type": "string",
"description": ""
},
"downgradeEffectiveDate": {
"type": "string",
"description": ""
},
"downgradeRequestStatus": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "downgradePlanUpdateResponse"
}
downgradeRequestInformation
{
"type": "object",
"properties": {
"downgradeRequestStatus": {
"type": "string",
"description": ""
},
"downgradeRequestCreation": {
"type": "string",
"description": ""
},
"downgradeRequestProductId": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "downgradeRequestInformation"
}
draw
{
"type": "object",
"properties": {
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** this custom tab is shared."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"required": {
"type": "string",
"description": "When **true,** the signer is required to fill out this tab."
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"allowSignerUpload": {
"type": "string",
"description": "When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.**"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"useBackgroundAsCanvas": {
"type": "string",
"description": ""
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows the recipient to add a free-form drawing to the document.",
"x-ms-summary": "A tab that allows the recipient to add a free-form drawing to the document.",
"x-ds-definition-name": "draw"
}
eNoteConfiguration
{
"type": "object",
"properties": {
"apiKey": {
"type": "string",
"description": ""
},
"password": {
"type": "string",
"description": "The user's encrypted password hash."
},
"userName": {
"type": "string",
"description": "The user's username."
},
"organization": {
"type": "string",
"description": "The name of the organization."
},
"eNoteConfigured": {
"type": "string",
"description": "When **false,** the user must configure eNote for the feature to work.\n\n**Note:** In the account settings, `allowENoteEOriginal` must be **true**\nto make changes to the configuration."
},
"connectConfigured": {
"type": "string",
"description": "When **false,** the user must configure Connect and eOriginal for the integration to work."
}
},
"description": "This object contains information used to\nconfigure [eNote][eNote] functionality.\nTo use eNote, the Allow eNote for eOriginal account plan item must be on,\nand the Connect configuration for eOriginal must be set correctly.\n\n[eNote]: https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=tsn1583277394951.html\n",
"x-ms-summary": "This object contains information used to\nconfigure [eNote][eNote] functionality.\nTo use eNote, the Allow eNote for eOriginal account plan item must be on,\nand the Connect configuration for eOriginal must be set correctly.\n\n[eNote]: https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=tsn1583277394951.html\n",
"x-ds-definition-name": "eNoteConfiguration"
}
editor
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set."
},
"note": {
"type": "string",
"description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
},
"email": {
"type": "string",
"description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. "
},
"status": {
"type": "string",
"description": "The recipient's status. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.\n"
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"fullName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lastName": {
"type": "string",
"description": "The recipient's last name."
},
"roleName": {
"type": "string",
"description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"firstName": {
"type": "string",
"description": "The recipient's first name. \n\nMaximum Length: 50 characters."
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"statusCode": {
"type": "string",
"description": "The code associated with the recipient's status. This property is read-only."
},
"phoneNumber": {
"$ref": "#/components/schemas/recipientPhoneNumber"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"designatorId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"noteMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"emailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientType": {
"type": "string",
"description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
},
"totalTabCount": {
"type": "string",
"description": "The total number of tabs in the documents. This property is read-only."
},
"completedCount": {
"type": "string",
"description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only."
},
"declinedReason": {
"type": "string",
"description": "The reason the recipient declined the document. This property is read-only."
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
},
"suppressEmails": {
"type": "string",
"description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"requireIdLookup": {
"type": "string",
"description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"designatorIdGuid": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fullNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lastNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"faxNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"firstNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "A complex type that contains information about users in the signing group."
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"accessCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"consentDetailsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consentDetails"
},
"description": ""
},
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
},
"autoRespondedReason": {
"type": "string",
"description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
},
"bulkSendV2Recipient": {
"type": "string",
"description": ""
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"addAccessCodeToEmail": {
"type": "string",
"description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"recipientAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAttachment"
},
"description": "Reserved for DocuSign."
},
"routingOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"deliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"additionalNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAdditionalNotification"
},
"description": "An array of additional notification objects."
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"requireIdLookupMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"recipientFeatureMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureAvailableMetadata"
},
"description": "Metadata about the features that are supported for the recipient type. This property is read-only."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"lockedRecipientSmsEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"emailRecipientPostSigningURL": {
"type": "string",
"description": ""
},
"recipientAuthenticationStatus": {
"$ref": "#/components/schemas/authenticationStatus"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedRecipientPhoneAuthEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowSystemOverrideForLockedRecipient": {
"type": "string",
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
},
"inheritEmailNotificationConfiguration": {
"type": "string",
"description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
}
},
"description": "A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.",
"x-ms-summary": "A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.",
"x-ds-definition-name": "editor"
}
email
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** this tab is shared."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n"
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"required": {
"type": "string",
"description": "When **true,** the signer is required to fill out this tab."
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"maxLength": {
"type": "string",
"description": "An optional value that describes the maximum length of the property when the property is a string."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."
},
"requireAll": {
"type": "string",
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"originalValue": {
"type": "string",
"description": "The initial value of the tab. "
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequired": {
"type": "string",
"description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope."
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"disableAutoSize": {
"type": "string",
"description": "When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes."
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"maxLengthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"shareToRecipients": {
"type": "string",
"description": "Reserved for DocuSign."
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationMessage": {
"type": "string",
"description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
},
"validationPattern": {
"type": "string",
"description": "A regular expression used to validate input for the tab."
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireAllMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"originalValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"concealValueOnDocument": {
"type": "string",
"description": "When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"disableAutoSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"shareToRecipientsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationMessageMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationPatternMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChange": {
"type": "string",
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
},
"concealValueOnDocumentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows 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.\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",
"x-ms-summary": "A tab that allows 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.\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",
"x-ds-definition-name": "email"
}
emailAddress
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n"
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "**Note:** Email Address tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.\n"
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the recipient's email as entered in the\nrecipient information.\n",
"x-ms-summary": "A tab that displays the recipient's email as entered in the\nrecipient information.\n",
"x-ds-definition-name": "emailAddress"
}
emailSettings
{
"type": "object",
"properties": {
"bccEmailAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bccEmailAddress"
},
"description": "An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note:** Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example:** if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address."
},
"replyEmailNameOverride": {
"type": "string",
"description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters."
},
"replyEmailAddressOverride": {
"type": "string",
"description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters."
}
},
"description": "A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT:** The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.",
"x-ms-summary": "A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT:** The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.",
"x-ds-definition-name": "emailSettings"
}
envelope
{
"type": "object",
"properties": {
"holder": {
"type": "string",
"description": "Reserved for DocuSign."
},
"sender": {
"$ref": "#/components/schemas/userInfo"
},
"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."
},
"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 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.\n\n The ID is a sender-generated value and is valid in the DocuSign system for 7 days.\n It is recommended that a transaction ID is used for offline\n signing to ensure that an envelope is not sent multiple times.\n The `transactionId` property can be used determine an envelope's\n status (i.e. was it created or not) in cases where the internet c\n onnection 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": "The date and time that the envelope is set to expire. This value is determined by the `InitialSentDateTime` of the envelope and the `expireAfter` property of the `notification` object. (Note that the `expireAfter` property of the envelope itself is not used.)\n"
},
"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": "When **true,** indicates that the data collected through form fields on a document 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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelope"
}
envelopeAttachment
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"label": {
"type": "string",
"description": ""
},
"attachmentId": {
"type": "string",
"description": "The unique identifier for the attachment."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"accessControl": {
"type": "string",
"description": "Valid values are `sender` and `senderAndAllRecipients`."
},
"attachmentType": {
"type": "string",
"description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeAttachment"
}
envelopeAttachmentsRequest
{
"type": "object",
"properties": {
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachment"
},
"description": "An object that contains information about the attachment."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeAttachmentsRequest"
}
envelopeAttachmentsResult
{
"type": "object",
"properties": {
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeAttachment"
},
"description": "An array of attachment objects that contain information about the attachments."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeAttachmentsResult"
}
envelopeAuditEvent
{
"type": "object",
"properties": {
"eventFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeAuditEvent"
}
envelopeAuditEventResponse
{
"type": "object",
"properties": {
"auditEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeAuditEvent"
},
"description": "Reserved for DocuSign."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeAuditEventResponse"
}
envelopeCustomMetadata
{
"type": "object",
"properties": {
"envelopeCustomMetadataDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeCustomMetadata"
}
envelopeDefinition
{
"type": "object",
"properties": {
"holder": {
"type": "string",
"description": "Reserved for DocuSign."
},
"sender": {
"$ref": "#/components/schemas/userInfo"
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values when creating an envelope are: \n\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n\nYou can query these additional statuses once the recipients have interacted with the envelope.\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\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, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account.\n\n**Note:** When creating an envelope using a branded template, include this value to ensure that the brand is applied."
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "An array of folders that the envelope belongs to."
},
"location": {
"type": "string",
"description": "Reserved for DocuSign."
},
"password": {
"type": "string",
"description": "The user's encrypted password hash."
},
"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."
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/document"
},
"description": "A complex element that contains details about the documents associated with the envelope."
},
"powerForm": {
"$ref": "#/components/schemas/powerForm"
},
"emailBlurb": {
"type": "string",
"description": "This optional element holds the body of the email message that is sent to all envelope recipients. \n\nMaximum Length: 10000 characters."
},
"envelopeId": {
"type": "string",
"description": "The envelope ID.\n\nWhen used as a request body in [Envelopes: create](https://raw.githubusercontent.com), this is the ID of the envelope to clone."
},
"hasWavFile": {
"type": "string",
"description": "When **true,** indicates that a wave file (voice recording) is part of the envelope."
},
"purgeState": {
"type": "string",
"description": "Initiates a purge request. Valid values are:\n\n- `documents_queued`: Places envelope documents in the purge queue.\n- `documents_and_metadata_queued`: Places envelope documents\n and metadata in the purge queue.\n- `documents_and_metadata_and_redact_queued`: Places envelope documents\n and metadata in the purge queue and redacts personal information.\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"
},
"recipients": {
"$ref": "#/components/schemas/EnvelopeRecipients"
},
"templateId": {
"type": "string",
"description": "The ID of the template. If a value is not provided, DocuSign generates 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"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attachment"
},
"description": "An array of attachment objects containing details about any envelope attachments."
},
"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 any templates associated with the envelope."
},
"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"
},
"accessibility": {
"type": "string",
"description": "Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account.\n\n**Note:** This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here."
},
"allowComments": {
"type": "string",
"description": "When **true,** 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."
},
"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."
},
"templateRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/templateRole"
},
"description": "This object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements:\n\n* `email`: The recipient's email address.\n* `name`: The recipient's name.\n* `roleName`: The template roleName associated with the recipient.\n* `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true,** an error is generated on sending.\n* `defaultRecipient`: Optional, When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.\n* `routingOrder`: This specifies the routing order of the recipient in the envelope.\n* `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters.\n* `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters.\n* `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients.\n* `tabs`: This property enables the tab values to be specified for matching to tabs in the template.\n"
},
"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. DocuSign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned."
},
"useDisclosure": {
"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": "The URI for retrieving the envelope attachments."
},
"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 date and time that the envelope was created."
},
"customFieldsUri": {
"type": "string",
"description": "The URI for retrieving custom fields."
},
"deletedDateTime": {
"type": "string",
"description": "The date and time that the envelope was deleted."
},
"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,** users can view the history of the envelope."
},
"declinedDateTime": {
"type": "string",
"description": "The date and time that the recipient declined the envelope."
},
"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": "The date and time that the envelope was completed."
},
"copyRecipientData": {
"type": "string",
"description": "This value is only applicable when copying an existing envelope. Provide the ID of the envelope to clone in `envelopeId`.\n\nWhen **true,** the recipient field values of the existing envelope are included. Only values from data entry fields, like checkboxes and radio buttons, will be copied. Fields that require an action, like signatures and initials, will not be included."
},
"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."
},
"eventNotification": {
"$ref": "#/components/schemas/eventNotification"
},
"isDynamicEnvelope": {
"type": "string",
"description": "When **true,** indicates that the envelope is a dynamic envelope."
},
"burnDefaultTabData": {
"type": "string",
"description": ""
},
"compositeTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/compositeTemplate"
},
"description": "A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope."
},
"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": "When **true,** indicates that the form data associated with the envelope has changed since it was sent. When **false,** this property does not appear in the response."
},
"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 that the envelope was first 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."
},
"recipientViewRequest": {
"$ref": "#/components/schemas/recipientViewRequest"
},
"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."
},
"allowRecipientRecursion": {
"type": "string",
"description": "When **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order."
},
"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,** the responsive document feature is turned off for the envelope."
},
"isSignatureProviderEnvelope": {
"type": "string",
"description": "When **true,** indicates that the envelope is a signature-provided envelope."
}
},
"description": "Envelope object definition.",
"x-ms-summary": "Envelope object definition.",
"x-ds-definition-name": "envelopeDefinition"
}
envelopeDelayRule
{
"type": "object",
"properties": {
"delay": {
"type": "string",
"description": "A string timespan representing the duration of the sending delay. The timespan is in the format `d.hh:mm:ss` where `d` is the number of days, `hh` is the number of hours (measured on a 24-hour clock), `mm` is minutes, and `ss` is seconds. The maximum delay is 30 days."
},
"resumeDate": {
"type": "string",
"description": "An ISO 8601 formatted datetime string indicating the date and time that the envelope will be sent. The specified datetime must occur in the future. It must not exceed 30 days from the time that the request is made."
}
},
"description": "A user-specified object that describes the envelope delay.\n\nTo indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used.",
"x-ms-summary": "A user-specified object that describes the envelope delay.\n\nTo indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used.",
"x-ds-definition-name": "envelopeDelayRule"
}
envelopeDocument
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The URI for retrieving the document."
},
"name": {
"type": "string",
"description": "The document's file name. \n\nExample: `Q1-Report.docx`"
},
"type": {
"type": "string",
"description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
},
"order": {
"type": "string",
"description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
},
"pages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/page"
},
"description": "An array of page objects that contain information about the pages in the document."
},
"display": {
"type": "string",
"description": "This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n* `modal`<br>\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `inline`<br>\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n"
},
"sizeBytes": {
"type": "string",
"description": ""
},
"documentId": {
"type": "string",
"description": "The ID of the document that the tab is placed on. This value must refer to the ID of an existing document."
},
"docGenErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/docGenSyntaxError"
},
"description": ""
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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."
},
"documentFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "An object containing information about the custom fields on the document."
},
"documentIdGuid": {
"type": "string",
"description": "The GUID of the document."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"attachmentTabId": {
"type": "string",
"description": "If this document is an attachment to another document in the envelope, this is the ID of the attachment tab it is associated with on the other document."
},
"displayMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"docGenFormFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/docGenFormField"
},
"description": ""
},
"isAceGenDocument": {
"type": "string",
"description": ""
},
"isDocGenDocument": {
"type": "string",
"description": ""
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"addedRecipientIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only."
},
"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.**"
},
"includeInDownload": {
"type": "string",
"description": "When **true,**\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true.**\n"
},
"docGenDocumentStatus": {
"type": "string",
"description": ""
},
"containsPdfFormFields": {
"type": "string",
"description": "When **true,** the document has editable form fields that are made available through a PDF format."
},
"signerMustAcknowledge": {
"type": "string",
"description": "Sets how the signer interacts with the supplemental document.\nValid values:\n\n* `no_interaction`<br>\n No recipient action is required.\n\n* `view`<br>\n The recipient is required to view the document.\n\n* `accept`<br>\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.\n\n* `view_accept`<br>\n The recipient is required to view and accept the document.\n\n"
},
"availableDocumentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signatureType"
},
"description": ""
},
"authoritativeCopyMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"includeInDownloadMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signerMustAcknowledgeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "This object contains details about the envelope document.",
"x-ms-summary": "This object contains details about the envelope document.",
"x-ds-definition-name": "envelopeDocument"
}
envelopeDocumentsResult
{
"type": "object",
"properties": {
"envelopeId": {
"type": "string",
"description": "The envelope ID."
},
"envelopeDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeDocument"
},
"description": "An array containing information about the documents that are included in the envelope."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeDocumentsResult"
}
envelopeEvent
{
"type": "object",
"properties": {
"includeDocuments": {
"type": "string",
"description": "When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."
},
"envelopeEventStatusCode": {
"type": "string",
"description": "An envelope status for which your webhook should be called. Valid values:\n\n* `Sent` \n* `Delivered`\n* `Completed`\n* `Declined`\n* `Voided`"
}
},
"description": "For which envelope events should your webhook be called?",
"x-ms-summary": "For which envelope events should your webhook be called?",
"x-ds-definition-name": "envelopeEvent"
}
envelopeFormData
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"formData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/formDataItem"
},
"description": "An array of `formDataItem` objects. \n"
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"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"
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"prefillFormData": {
"$ref": "#/components/schemas/prefillFormData"
},
"recipientFormData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientFormData"
},
"description": "An array of form data for each recipient of the envelope."
}
},
"description": "Describes the form data of the envelope.",
"x-ms-summary": "Describes the form data of the envelope.",
"x-ds-definition-name": "envelopeFormData"
}
envelopeId
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the envelope ID.\n\n**Note:** The eSignature API uses the name `envelopeId` two ways:\n\n- As a _property_ of type `string` used to identify an envelope by its GUID.\n- As an _object_ used to represent an envelope tab that displays\n the envelope's GUID.\n",
"x-ms-summary": "A tab that displays the envelope ID.\n\n**Note:** The eSignature API uses the name `envelopeId` two ways:\n\n- As a _property_ of type `string` used to identify an envelope by its GUID.\n- As an _object_ used to represent an envelope tab that displays\n the envelope's GUID.\n",
"x-ds-definition-name": "envelopeId"
}
envelopeIdsRequest
{
"type": "object",
"properties": {
"envelopeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of envelope IDs to include in the results."
},
"transactionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days."
}
},
"description": "Lists of envelope and transaction IDs to use in the results.\n\nIf you use this request body with Envelopes: listStatus,\nyou must set one or both of the following query parameters\nto the special value `request_body`:\n\n- `envelope_ids=request_body`\n- `transaction_ids=request_body`\n",
"x-ms-summary": "Lists of envelope and transaction IDs to use in the results.\n\nIf you use this request body with Envelopes: listStatus,\nyou must set one or both of the following query parameters\nto the special value `request_body`:\n\n- `envelope_ids=request_body`\n- `transaction_ids=request_body`\n",
"x-ds-definition-name": "envelopeIdsRequest"
}
envelopeMetadata
{
"type": "object",
"properties": {
"allowCorrect": {
"type": "string",
"description": "Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information."
},
"allowAdvancedCorrect": {
"type": "string",
"description": "Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature."
},
"enableSignWithNotary": {
"type": "string",
"description": "Specifies if DocuSign eNotary service is enabled for the envelope."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeMetadata"
}
envelopeNotificationRequest
{
"type": "object",
"properties": {
"reminders": {
"$ref": "#/components/schemas/reminders"
},
"expirations": {
"$ref": "#/components/schemas/expirations"
},
"useAccountDefaults": {
"type": "string",
"description": "When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"
}
},
"description": "A complex element that specifies the notification settings for the envelope.",
"x-ms-summary": "A complex element that specifies the notification settings for the envelope.",
"x-ds-definition-name": "envelopeNotificationRequest"
}
envelopePublishTransaction
{
"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": "The status of the transaction. Valid values:\n\n* `unprocessed`\n* `processing`\n* `complete`\n* `fatal_error`\n"
},
"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": "The ID of the publish transaction."
},
"noActionRequiredEnvelopeCount": {
"type": "string",
"description": ""
},
"submittedForPublishingEnvelopeCount": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopePublishTransaction"
}
envelopePublishTransactionErrorRollup
{
"type": "object",
"properties": {
"count": {
"type": "string",
"description": "The maximum number of results to return."
},
"errorType": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopePublishTransactionErrorRollup"
}
envelopePurgeConfiguration
{
"type": "object",
"properties": {
"redactPII": {
"type": "string",
"description": "When **true,** the system also redacts personally identifiable information (PII).\n\n**Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.**"
},
"retentionDays": {
"type": "string",
"description": "The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`."
},
"purgeEnvelopes": {
"type": "string",
"description": "When **true,** purging is enabled."
},
"removeTabsAndEnvelopeAttachments": {
"type": "string",
"description": "When **true,** the system also purges the tabs and attachments associated with the envelopes. "
}
},
"description": "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ",
"x-ms-summary": "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ",
"x-ds-definition-name": "envelopePurgeConfiguration"
}
envelopeSummary
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "A URI containing the user ID."
},
"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"
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"statusDateTime": {
"type": "string",
"description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
},
"bulkEnvelopeStatus": {
"$ref": "#/components/schemas/bulkEnvelopeStatus"
},
"recipientSigningUri": {
"type": "string",
"description": ""
},
"recipientSigningUriError": {
"type": "string",
"description": ""
}
},
"description": " This object describes an envelope.",
"x-ms-summary": " This object describes an envelope.",
"x-ds-definition-name": "envelopeSummary"
}
envelopeTemplate
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "A URI containing the user ID."
},
"name": {
"type": "string",
"description": ""
},
"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,\nwhich includes all users on the account.\n\nWhen **false,** the template is shared only with the groups you specify.\n"
},
"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 ID of the folder."
},
"lastUsed": {
"type": "string",
"description": ""
},
"location": {
"type": "string",
"description": "Reserved for DocuSign."
},
"password": {
"type": "string",
"description": "The user's encrypted password hash."
},
"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": ""
},
"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 an envelope that you want to use as\nthe basis for the template. The state of the envelope\ncan be `draft`, `sent`, or `completed`.\n\n"
},
"folderName": {
"type": "string",
"description": ""
},
"hasWavFile": {
"type": "string",
"description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. "
},
"powerForms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerForm"
},
"description": "An array of PowerForm objects."
},
"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,** 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."
},
"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.\n\n The ID is a sender-generated value and is valid in the DocuSign system for 7 days.\n It is recommended that a transaction ID is used for offline\n signing to ensure that an envelope is not sent multiple times.\n The `transactionId` property can be used determine an envelope's\n status (i.e. was it created or not) in cases where the internet c\n onnection 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": ""
},
"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": "When **true,** indicates that the data collected through form fields on a document 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`."
},
"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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeTemplate"
}
envelopeTemplateResults
{
"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. "
},
"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."
},
"envelopeTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeTemplate"
},
"description": "The list of requested templates."
}
},
"description": "Information about templates.",
"x-ms-summary": "Information about templates.",
"x-ds-definition-name": "envelopeTemplateResults"
}
envelopeTransactionStatus
{
"type": "object",
"properties": {
"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"
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeTransactionStatus"
}
envelopeTransferRule
{
"type": "object",
"properties": {
"toUser": {
"$ref": "#/components/schemas/userInformation"
},
"enabled": {
"type": "string",
"description": "When **true,** the envelope transfer rule is active."
},
"fromUser": {
"$ref": "#/components/schemas/userInformation"
},
"toFolder": {
"$ref": "#/components/schemas/folder"
},
"eventType": {
"type": "string",
"description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`"
},
"fromGroup": {
"$ref": "#/components/schemas/group"
},
"modifiedDate": {
"type": "string",
"description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read-only."
},
"modifiedUser": {
"$ref": "#/components/schemas/userInformation"
},
"envelopeTransferRuleId": {
"type": "string",
"description": "The ID of the envelope transfer rule. The system generates this ID when the rule is first created."
},
"carbonCopyOriginalOwner": {
"type": "string",
"description": "When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**"
}
},
"description": "This object contains details about an envelope transfer rule.",
"x-ms-summary": "This object contains details about an envelope transfer rule.",
"x-ds-definition-name": "envelopeTransferRule"
}
envelopeTransferRuleInformation
{
"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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeTransferRuleInformation"
}
envelopeTransferRuleRequest
{
"type": "object",
"properties": {
"toUser": {
"$ref": "#/components/schemas/userInformation"
},
"enabled": {
"type": "string",
"description": "When **true,** the envelope transfer rule is active."
},
"toFolder": {
"$ref": "#/components/schemas/folder"
},
"eventType": {
"type": "string",
"description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`"
},
"fromUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInformation"
},
"description": "Information about the user who triggers the transfer."
},
"fromGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
},
"description": "Information about the group that triggers the transfer."
},
"modifiedDate": {
"type": "string",
"description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read-only."
},
"modifiedUser": {
"$ref": "#/components/schemas/userInformation"
},
"envelopeTransferRuleId": {
"type": "string",
"description": "The ID of the envelope transfer rule. The system generates this ID when the rule is first created."
},
"carbonCopyOriginalOwner": {
"type": "string",
"description": "When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**"
}
},
"description": "This object contains details about the envelope transfer rule that you want to create.",
"x-ms-summary": "This object contains details about the envelope transfer rule that you want to create.",
"x-ds-definition-name": "envelopeTransferRuleRequest"
}
envelopeUpdateSummary
{
"type": "object",
"properties": {
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"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"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"lockInformation": {
"$ref": "#/components/schemas/EnvelopeLocks"
},
"tabUpdateResults": {
"$ref": "#/components/schemas/EnvelopeRecipientTabs"
},
"bulkEnvelopeStatus": {
"$ref": "#/components/schemas/bulkEnvelopeStatus"
},
"recipientUpdateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientUpdateResponse"
},
"description": "An array of `recipientUpdateResults` objects that contain details about the recipients."
},
"listCustomFieldUpdateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/listCustomField"
},
"description": ""
},
"textCustomFieldUpdateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/textCustomField"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "envelopeUpdateSummary"
}
envelopesInformation
{
"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/envelope"
},
"description": "Array of envelope information."
},
"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."
},
"continuationToken": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lastQueriedDateTime": {
"type": "string",
"description": "The last time that a query was performed."
},
"envelopeSearchSource": {
"type": "string",
"description": ""
},
"envelopeTransactionStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeTransactionStatus"
},
"description": "Array of envelope statuses and transaction IDs in the result set."
}
},
"description": "Result set for the Envelopes: listStatusChanges method",
"x-ms-summary": "Result set for the Envelopes: listStatusChanges method",
"x-ds-definition-name": "envelopesInformation"
}
errorDetails
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A brief message describing the error condition."
},
"errorCode": {
"type": "string",
"description": "The code associated with the error condition."
}
},
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests.",
"x-ms-summary": "This object describes errors that occur. It is only valid for responses and ignored in requests.",
"x-ds-definition-name": "errorDetails"
}
eventNotification
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.\n\nThe maximum length of this property is 4096 bytes.\n"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](https://raw.githubusercontent.com). If you are instead using any of [the legacy event message formats](https://raw.githubusercontent.com), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/improved-json-sim-event-model/#eventreference) are:\n\n* `envelope-created`\n* `envelope-sent`\n* `envelope-resent`\n* `envelope-delivered`\n* `envelope-completed`\n* `envelope-declined`\n* `envelope-voided`\n* `recipient-authenticationfailed`\n* `recipient-autoresponded`\n* `recipient-declined`\n* `recipient-delivered`\n* `recipient-completed`\n* `recipient-sent`\n* `recipient-resent`\n* `template-created`\n* `template-modified`\n* `template-deleted`\n* `envelope-corrected`\n* `envelope-purge`\n* `envelope-deleted`\n* `envelope-discard`\n* `recipient-reassign`\n* `recipient-delegate`\n* `recipient-finish-later`\n* `click-agreed`\n* `click-declined`\n"
},
"eventData": {
"$ref": "#/components/schemas/connectEventData"
},
"includeHMAC": {
"type": "string",
"description": "When **true,** HMAC headers will be included with the webhook notifications.\n\n**Note:** [HMAC must enabled](https://raw.githubusercontent.com) at the account level with [one or more HMAC secrets](https://raw.githubusercontent.com)."
},
"deliveryMode": {
"type": "string",
"description": ""
},
"includeOAuth": {
"type": "string",
"description": ""
},
"soapNameSpace": {
"type": "string",
"description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true."
},
"envelopeEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeEvent"
},
"description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both."
},
"loggingEnabled": {
"type": "string",
"description": "When **true,** the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://raw.githubusercontent.com)."
},
"includeTimeZone": {
"type": "string",
"description": "When **true,** the envelope's time zone information is included in the webhook messages. "
},
"recipientEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientEvent"
},
"description": "A list of recipient event statuses that will trigger Connect to send updates to the endpoint specified in the URL property.\n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both."
},
"includeDocuments": {
"type": "string",
"description": "When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."
},
"useSoapInterface": {
"type": "string",
"description": "When **true,** this tells the Connect service that the user's endpoint has implemented a SOAP interface. "
},
"integratorManaged": {
"type": "string",
"description": ""
},
"includeDocumentFields": {
"type": "string",
"description": "When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. "
},
"requireAcknowledgment": {
"type": "string",
"description": "When **true,** the DocuSign Connect service checks that the message was received and retries on failures. "
},
"signMessageWithX509Cert": {
"type": "string",
"description": "When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. "
},
"includeEnvelopeVoidReason": {
"type": "string",
"description": "When **true,** this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. "
},
"includeCertificateWithSoap": {
"type": "string",
"description": "When **true,**\nthe Connect service will digitally sign\nthe data.\nThe signature will be included in the message."
},
"includeCertificateOfCompletion": {
"type": "string",
"description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. "
},
"includeSenderAccountAsCustomField": {
"type": "string",
"description": "When **true,** Connect will include the sender account as Custom Field in the data."
}
},
"description": "Use this object to configure a [DocuSign Connect webhook](https://raw.githubusercontent.com).",
"x-ms-summary": "Use this object to configure a [DocuSign Connect webhook](https://raw.githubusercontent.com).",
"x-ds-definition-name": "eventNotification"
}
eventResult
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Event status."
},
"eventTimestamp": {
"type": "string",
"description": "Date/time of the event."
},
"failureDescription": {
"type": "string",
"description": "Reason for failure, if the event failed."
},
"vendorFailureStatusCode": {
"type": "string",
"description": "Failure status code, if the event failed."
}
},
"description": "Information about the result of an event.",
"x-ms-summary": "Information about the result of an event.",
"x-ds-definition-name": "eventResult"
}
expirations
{
"type": "object",
"properties": {
"expireWarn": {
"type": "string",
"description": "An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent."
},
"expireAfter": {
"type": "string",
"description": "An integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**"
},
"expireEnabled": {
"type": "string",
"description": "When **true,** the envelope expires in the number of days set by `expireAfter`. When **false** or not set, the envelope expires in the number of days specified by the [default expiration account setting](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html)."
}
},
"description": "A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided.\n",
"x-ms-summary": "A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided.\n",
"x-ds-definition-name": "expirations"
}
externalDocServiceErrorDetails
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": ""
},
"errorCode": {
"type": "string",
"description": "A code associated with the error condition."
},
"authenticationUrl": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "externalDocServiceErrorDetails"
}
externalDocumentSources
{
"type": "object",
"properties": {
"boxnetEnabled": {
"type": "string",
"description": "The account is enabled to allow external documents to be attached from BoxNet."
},
"boxnetMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dropboxEnabled": {
"type": "string",
"description": "The account is enabled to allow external documents to be attached from DropBox."
},
"dropboxMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"oneDriveEnabled": {
"type": "string",
"description": "The account is enabled to allow external documents to be attached from OneDrive."
},
"oneDriveMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"salesforceEnabled": {
"type": "string",
"description": "The account is enabled to allow external documents to be attached from Salesforce."
},
"googleDriveEnabled": {
"type": "string",
"description": "The account is enabled to allow external documents to be attached from Google Drive."
},
"salesforceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"googleDriveMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
}
},
"description": "A complex object specifying the external document sources.",
"x-ms-summary": "A complex object specifying the external document sources.",
"x-ds-definition-name": "externalDocumentSources"
}
externalFile
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The storage provider's ID for the file or folder."
},
"img": {
"type": "string",
"description": "The file extension for a file.\n\n**Note:** If the item is a folder, this value is null."
},
"uri": {
"type": "string",
"description": "The URI for the file or folder."
},
"date": {
"type": "string",
"description": "The UTC date and time that the file or folder was last modified."
},
"name": {
"type": "string",
"description": "The full name of a file."
},
"size": {
"type": "string",
"description": "The size of the file. The file size limit varies based on the cloud storage provider."
},
"type": {
"type": "string",
"description": "The type of cloud storage item. Valid values are:\n\n- `file`\n- `folder`"
},
"ownerName": {
"type": "string",
"description": ""
},
"supported": {
"type": "string",
"description": "When **true,** DocuSign supports the file type for upload."
},
"hasCompositeTemplate": {
"type": "string",
"description": ""
}
},
"description": "This object contains information about a file or folder in cloud storage.",
"x-ms-summary": "This object contains information about a file or folder in cloud storage.",
"x-ds-definition-name": "externalFile"
}
externalFolder
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Salesforce object."
},
"name": {
"type": "string",
"description": ""
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/externalFile"
},
"description": "If the tab is a list, this represents the values that are possible for the tab."
},
"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. "
},
"errorDetails": {
"$ref": "#/components/schemas/externalDocServiceErrorDetails"
},
"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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "externalFolder"
}