Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"buttonText": {
"description": " Specifies the approval text that displays in the tab. ",
"type": "string"
},
"buttonTextMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `buttonText` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"description": "The Docusign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "**Note:** Approve 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",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "approve",
"x-ms-summary": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n"
},
"askAnAdmin": {
"description": "",
"properties": {
"email": {
"description": "",
"type": "string"
},
"message": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"phone": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "askAnAdmin",
"x-ms-summary": ""
},
"attachment": {
"description": "Contains information about an attachment.",
"properties": {
"accessControl": {
"description": "Valid values are `sender` and `senderAndAllRecipients`.",
"type": "string"
},
"attachmentId": {
"description": "The unique identifier for the attachment.",
"type": "string"
},
"attachmentType": {
"description": "Specifies the type of the attachment for the recipient.",
"type": "string"
},
"data": {
"description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.",
"type": "string"
},
"label": {
"description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. \n",
"type": "string"
},
"name": {
"description": "The name of the attachment.",
"type": "string"
},
"remoteUrl": {
"description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "attachment",
"x-ms-summary": "Contains information about an attachment."
},
"authenticationMethod": {
"description": "Contains information about the method used for authentication.",
"properties": {
"authenticationType": {
"description": "Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. ",
"type": "string"
},
"lastProvider": {
"description": "The last provider that authenticated the user. ",
"type": "string"
},
"lastTimestamp": {
"description": " The data and time the user last used the authentication method. ",
"type": "string"
},
"totalCount": {
"description": "The number of times the authentication method was used. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "authenticationMethod",
"x-ms-summary": "Contains information about the method used for authentication."
},
"authenticationStatus": {
"description": "A complex element that contains information about a user's authentication status.",
"properties": {
"accessCodeResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of a user's attempt to authenticate by using an access code. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"ageVerifyResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of an age verification check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"anySocialIDResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"facebookResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"googleResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"idLookupResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of an ID lookup authentication check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"idQuestionsResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of the user's answers to ID challenge questions. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"identityVerificationResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of an [Identity Verification][IDV] workflow.\n\n[IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/"
},
"linkedinResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"liveIDResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"ofacResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of an Office of Foreign Asset Control (OFAC) check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"openIDResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"phoneAuthResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"sTANPinResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of a Student Authentication Network (STAN) authentication check. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"salesforceResult": {
"$ref": "#/definitions/eventResult",
"description": "Success/failure result of authentication using sign-in with a Salesforce account. It returns:\n\n- `Status`: `Pass` or `Fail`.\n- `dateTime`: The date and time that the event occurred.\n- `FailureDescription`: A string containing the details about a failed authentication.\n- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication. "
},
"signatureProviderResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of the user's attempt to authenticate by using a signature provider."
},
"smsAuthResult": {
"$ref": "#/definitions/eventResult",
"description": "The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone."
},
"twitterResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
},
"yahooResult": {
"$ref": "#/definitions/eventResult",
"description": "Deprecated."
}
},
"type": "object",
"x-ds-definition-name": "authenticationStatus",
"x-ms-summary": "A complex element that contains information about a user's authentication status."
},
"authorizationUser": {
"description": "",
"properties": {
"accountId": {
"description": "The account ID.",
"type": "string"
},
"email": {
"description": "The email address of the authorization user.",
"type": "string"
},
"name": {
"description": "The name of the authorization user.",
"type": "string"
},
"userId": {
"description": "The ID of the authorization user.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "authorizationUser",
"x-ms-summary": ""
},
"authorizedSignatory": {
"description": "",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"agentCanEditEmail": {
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.",
"type": "string"
},
"agentCanEditName": {
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkRecipientsUri": {
"description": "Reserved for Docusign.",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"canSignOffline": {
"description": "When **true,** specifies that the signer can perform the signing ceremony offline.",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"creationReason": {
"description": "The reason why the item was created.",
"type": "string"
},
"customFields": {
"description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"defaultRecipient": {
"description": "When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.",
"type": "string"
},
"delegatedBy": {
"$ref": "#/definitions/delegationInfo",
"description": ""
},
"delegatedTo": {
"description": "",
"items": {
"$ref": "#/definitions/delegationInfo"
},
"type": "array"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"excludedDocuments": {
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.",
"items": {
"type": "string"
},
"type": "array"
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The user's first name. \nMaximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"description": "The Docusign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "This property does not apply to `checkbox` tabs.\n\nTo require users to check\nat least one, or at most some number\nof checkboxes,\nassociate the checkbox tabs\nwith a [`tabGroup`][tabGroup].\nThen set the following `tabGroup` properties:\n\n- [`maximumAllowed`][maximumAllowed]\n- [`minimumRequired`][minimumRequired]\n- [`groupRule`][groupRule] specifies how the other two properties are interpreted.\n\nYou can find an example\nat [Stack Overflow][so].\n\n[so]: https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277\n[tabGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups\n[groupRule]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule\n[maximumAllowed]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed\n[minimumRequired]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired\n",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"selected": {
"description": "When **true,** the checkbox is selected.",
"type": "string"
},
"selectedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `selected` property is editable."
},
"selectedOriginal": {
"description": "",
"type": "string"
},
"selectedOriginalMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": ""
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable.\n"
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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 (-7, -6)\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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 (-7, -6)\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "checkbox",
"x-ms-summary": "A tab that allows the recipient to select a yes/no (on/off) option.\n"
},
"chunkedUploadPart": {
"description": "An object that contains information about the chunked upload part.",
"properties": {
"sequence": {
"description": "The order of the part in the chunked upload.",
"type": "string"
},
"size": {
"description": "The size of the part in bytes. \n\nDocusign recommends that a chunked upload part is no larger than a few MB in size.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "chunkedUploadPart",
"x-ms-summary": "An object that contains information about the chunked upload part."
},
"chunkedUploadRequest": {
"description": "This is the request object for uploading a chunked upload.",
"properties": {
"chunkedUploadId": {
"description": "The ID of the chunked upload.\n\n**Note:** This property is ignored in requests, and overridden with an auto-generated value in responses.",
"type": "string"
},
"data": {
"description": "A base64-encoded representation of the content that is used to upload the file. \n\nMaximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "chunkedUploadRequest",
"x-ms-summary": "This is the request object for uploading a chunked upload."
},
"chunkedUploadResponse": {
"description": "This response object is returned after you upload a chunked upload.",
"properties": {
"checksum": {
"description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused.",
"type": "string"
},
"chunkedUploadId": {
"description": "The ID of the chunked upload. ",
"type": "string"
},
"chunkedUploadParts": {
"description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload.",
"items": {
"$ref": "#/definitions/chunkedUploadPart"
},
"type": "array"
},
"chunkedUploadUri": {
"description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. ",
"type": "string"
},
"committed": {
"description": "When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. ",
"type": "string"
},
"expirationDateTime": {
"description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note:** You must fully upload and use a chunked upload within 20 minutes of initializing it.\n",
"type": "string"
},
"maxChunkedUploadParts": {
"description": "The maximum number of parts allowed for a chunked upload. This value is configurable per Docusign environment, account, or integrator. The default value is 128. The maximum possible value is 256. ",
"type": "string"
},
"maxTotalSize": {
"description": "The maximum total size allowed for a chunked upload. This value is configured per Docusign environment, account, or integrator. The default value is 50 MB.",
"type": "string"
},
"totalSize": {
"description": "The total size of the parts of the chunked upload.\n\n**Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "chunkedUploadResponse",
"x-ms-summary": "This response object is returned after you upload a chunked upload."
},
"cloudStorageProvider": {
"description": "Contains details about a specific cloud storage provider.",
"properties": {
"authenticationUrl": {
"description": "The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"redirectUrl": {
"description": "The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.",
"type": "string"
},
"service": {
"description": "The service name for the cloud storage provider.",
"type": "string"
},
"serviceId": {
"description": "The Docusign-generated ID for the cloud storage provider.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "cloudStorageProvider",
"x-ms-summary": "Contains details about a specific cloud storage provider."
},
"cloudStorageProviders": {
"description": "",
"properties": {
"storageProviders": {
"description": "An Array containing the storage providers associated with the user.",
"items": {
"$ref": "#/definitions/cloudStorageProvider"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "cloudStorageProviders",
"x-ms-summary": ""
},
"comment": {
"description": "",
"properties": {
"envelopeId": {
"description": "The Guid of the envelope the comment thread belongs to.",
"type": "string"
},
"hmac": {
"description": "Reserved for Docusign.",
"type": "string"
},
"id": {
"description": "The unique identifier for the comment.",
"type": "string"
},
"mentions": {
"description": "An array of userIds that are mentioned directly in the body of a comment.",
"items": {
"type": "string"
},
"type": "array"
},
"read": {
"description": "When **true,** indicates that the comment was read.",
"type": "boolean"
},
"sentByEmail": {
"description": "The email address of the user who created the comment.",
"type": "string"
},
"sentByFullName": {
"description": "The full name of the user who created the comment.",
"type": "string"
},
"sentByImageId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"sentByInitials": {
"description": "The initials of the user who created the comment.",
"type": "string"
},
"sentByRecipientId": {
"description": "The recipient ID of the user who created the comment.",
"type": "string"
},
"sentByUserId": {
"description": "The user ID of the user who created the comment.",
"type": "string"
},
"signingGroupId": {
"description": "The ID of the signing group that can view the comment or that created the comment.",
"type": "string"
},
"signingGroupName": {
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ",
"type": "string"
},
"subject": {
"description": "The subject of the envelope.",
"type": "string"
},
"tabId": {
"description": "The unique identifier for the tab that represents the comment thread.",
"type": "string"
},
"text": {
"description": "The content of the comment, as UTF-8 text. \n\nMaximum Length: 500 characters.\n\n**Note:** The maximum size allowed for the entire message body is 32 KB. ",
"type": "string"
},
"threadId": {
"description": "The unique identifier for the comment thread.",
"type": "string"
},
"threadOriginatorId": {
"description": "The userId of the user who created the thread.",
"type": "string"
},
"timeStampFormatted": {
"description": "The time the comment was created, formatted according to the format of the user who created the comment.",
"type": "string"
},
"timestamp": {
"description": "The time the comment was created.",
"type": "string"
},
"visibleTo": {
"description": "The user IDs of the users that the comment is visible to.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "comment",
"x-ms-summary": ""
},
"commentHistoryResult": {
"description": "",
"properties": {
"comments": {
"description": "An array of comment tabs that contain information about users' comments on documents.",
"items": {
"$ref": "#/definitions/comment"
},
"type": "array"
},
"count": {
"description": "The maximum number of results to return.",
"format": "int32",
"type": "integer"
},
"endTimetoken": {
"description": "",
"type": "string"
},
"startTimetoken": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "commentHistoryResult",
"x-ms-summary": ""
},
"commentPublish": {
"description": "",
"properties": {
"id": {
"description": "A unique ID for the Salesforce object.",
"type": "string"
},
"mentions": {
"description": "An array of userIds that are mentioned directly in the body of a comment.",
"items": {
"type": "string"
},
"type": "array"
},
"text": {
"description": "Specifies the text that is shown in the dropdown list. ",
"type": "string"
},
"threadAnchorKeys": {
"additionalProperties": {
"type": "string"
},
"description": "",
"type": "object"
},
"threadId": {
"description": "The unique identifier for the comment thread.",
"type": "string"
},
"visibleTo": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "commentPublish",
"x-ms-summary": ""
},
"commentThread": {
"description": "",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"comments": {
"description": "An array of comment tabs that contain information about users' comments on documents.",
"items": {
"$ref": "#/definitions/comment"
},
"type": "array"
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"threadId": {
"description": "The unique identifier for the comment thread.",
"type": "string"
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "commentThread",
"x-ms-summary": ""
},
"commentsPublish": {
"description": "",
"properties": {
"commentsToPublish": {
"description": "",
"items": {
"$ref": "#/definitions/commentPublish"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "commentsPublish",
"x-ms-summary": ""
},
"commissionCounty": {
"description": "A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/).\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "commissionCounty",
"x-ms-summary": "A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/).\n"
},
"commissionExpiration": {
"description": "A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/).\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "commissionExpiration",
"x-ms-summary": "A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/).\n"
},
"commissionNumber": {
"description": "A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "commissionNumber",
"x-ms-summary": "A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/\n"
},
"commissionState": {
"description": "A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "commissionState",
"x-ms-summary": "A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/\n"
},
"company": {
"description": "A tab that displays the recipient's company name.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "company",
"x-ms-summary": "A tab that displays the recipient's company name.\n"
},
"compositeTemplate": {
"description": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/",
"properties": {
"compositeTemplateId": {
"description": "The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.",
"type": "string"
},
"document": {
"$ref": "#/definitions/document",
"description": "An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically."
},
"inlineTemplates": {
"description": " Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.",
"items": {
"$ref": "#/definitions/inlineTemplate"
},
"type": "array"
},
"pdfMetaDataTemplateSequence": {
"description": "A number representing the sequence in which to apply the template that contains the PDF metadata.\n\nExample: `4`",
"type": "string"
},
"serverTemplates": {
"description": "Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.",
"items": {
"$ref": "#/definitions/serverTemplate"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "compositeTemplate",
"x-ms-summary": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/"
},
"conditionalRecipientRule": {
"description": "A rule that defines a set of recipients and the conditions under which they will be used for the envelope.",
"properties": {
"conditions": {
"description": "An array of conditions that define when the recipients will be used.",
"items": {
"$ref": "#/definitions/conditionalRecipientRuleCondition"
},
"type": "array"
},
"order": {
"description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values.",
"type": "string"
},
"recipientGroup": {
"$ref": "#/definitions/recipientGroup",
"description": "A set of recipients that may be used for the envelope, depending on the `conditions` defined."
},
"recipientId": {
"description": "The ID of the recipient to whom the condition will be applied. This value should match the `recipientId` defined in the recipient object.\n",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "conditionalRecipientRule",
"x-ms-summary": "A rule that defines a set of recipients and the conditions under which they will be used for the envelope."
},
"conditionalRecipientRuleCondition": {
"description": "",
"properties": {
"filters": {
"description": "",
"items": {
"$ref": "#/definitions/conditionalRecipientRuleFilter"
},
"type": "array"
},
"order": {
"description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values.",
"type": "string"
},
"recipientLabel": {
"description": "An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/).\n",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "conditionalRecipientRuleCondition",
"x-ms-summary": ""
},
"conditionalRecipientRuleFilter": {
"description": "",
"properties": {
"operator": {
"description": "How the tab value is compared to the `value` property. Valid values:\n\n* `equals`\n* `greaterThan`\n* `greaterThanEquals`\n* `lessThan`\n* `lessThanEquals`\n* `filled`\n* `selected`",
"type": "string"
},
"recipientId": {
"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",
"type": "string"
},
"scope": {
"description": "The scope under which the condition is evaluated. Valid values:\n\n* `tabs`",
"type": "string"
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabLabel": {
"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",
"type": "string"
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"value": {
"description": "A set value to which the tab's actual value is compared.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "conditionalRecipientRuleFilter",
"x-ms-summary": ""
},
"connectConfigResults": {
"description": "This object contains the results of a ConnectConfigurations::GET method.",
"properties": {
"configurations": {
"description": "An array of Docusign Connect configurations.",
"items": {
"$ref": "#/definitions/connectCustomConfiguration"
},
"type": "array"
},
"totalRecords": {
"description": "The number of results.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectConfigResults",
"x-ms-summary": "This object contains the results of a ConnectConfigurations::GET method."
},
"connectCustomConfiguration": {
"description": "The `connectCustomConfiguration` object describes a Connect configuration for your account.",
"properties": {
"allUsers": {
"description": "When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.**\n\n**Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"allUsersExcept": {
"description": "This flag enables you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.**\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"allowEnvelopePublish": {
"description": "Set this value to **true** to enable the webhook. The default property is **false.**",
"type": "string"
},
"allowSalesforcePublish": {
"description": "When **true,** Docusign sends data to the designated Salesforce account through Connect. The default value is **true.**\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"configurationType": {
"description": "The type of the configuration. Valid values:\n\n* `custom`: Creates an account-level configuration\n* `customrecipient`: Creates a Recipient Connect configuration\n* `salesforce`\n* `eOriginal`\n\nThis property is required.",
"type": "string"
},
"connectId": {
"description": "The Docusign-generated ID for the Connect configuration.\n\nThis property is read-only.",
"type": "string"
},
"deliveryMode": {
"description": "The delivery mode of the configuration. Valid values:\n\n* `SIM`\n* `Aggregate`\n\nThis property is required.",
"type": "string"
},
"disabledBy": {
"description": "",
"type": "string"
},
"enableLog": {
"description": "When **true,** Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console.\n\nThis property is required.",
"type": "string"
},
"enableOAuthPerConfiguration": {
"description": "",
"type": "string"
},
"envelopeEvents": {
"description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.\n\nWhen using any of\n[the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/),\nyou must include either the `envelopeEvents` property\nor the `recipientEvents` property.\nIf you are instead using the\n[JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/),\nuse the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property.\n\nThe [possible event statuses](/platform/webhooks/connect/event-triggers/) are:\n\n* `Sent`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `Voided`\n\n**Note:** These values are case-sensitive.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"eventData": {
"$ref": "#/definitions/connectEventData",
"description": "Allows you to specify the format of the information the Connect webhooks returns.\n\nThis property is required."
},
"events": {
"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](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) 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\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"externalFolderId": {
"description": "The ID of an external folder.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"externalFolderLabel": {
"description": "The label for an external folder.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"groupIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"includeCertSoapHeader": {
"description": "",
"type": "string"
},
"includeCertificateOfCompletion": {
"description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"includeDocumentFields": {
"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.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"includeDocuments": {
"description": "Reserved for Docusign.",
"type": "string"
},
"includeEnvelopeVoidReason": {
"description": "When **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"includeHMAC": {
"description": "When **true,** Connect will use HMAC to verify the request.\n\nThis property is required. ",
"type": "string"
},
"includeOAuth": {
"description": "",
"type": "string"
},
"includeSenderAccountasCustomField": {
"description": "When **true,** Connect will include the sender account as custom field in the data.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"includeTimeZoneInformation": {
"description": "When **true,** Connect will include the envelope time zone information.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"integratorManaged": {
"description": "",
"type": "string"
},
"name": {
"description": "The name of the Connect configuration.\n\nThis property is required.",
"type": "string"
},
"oAuthConfiguration": {
"$ref": "#/definitions/connectOAuthConfig",
"description": ""
},
"password": {
"description": "The password for the Connect configuration.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.\n",
"type": "string"
},
"pausePublish": {
"description": "",
"type": "string"
},
"recipientEvents": {
"description": "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the `url` property.\n\nWhen using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the `events` property.\n\nThe [possible event statuses](/platform/webhooks/connect/event-triggers/) are:\n\n* `Sent`\n* `AutoResponded`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `AuthenticationFailed`\n\n**Note:** These values are case-sensitive.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"requireMutualTls": {
"description": "When **true,** [Mutual TLS](/platform/webhooks/mutual-tls/) authentication is enabled.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"requiresAcknowledgement": {
"description": "When **true,** event delivery acknowledgements are enabled for your Connect configuration.\n\nDocusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead, they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\nThis property is required.",
"type": "string"
},
"salesforceApiVersion": {
"description": "The version of the Salesforce API that you are using.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"salesforceAuthcode": {
"description": "",
"type": "string"
},
"salesforceCallBackUrl": {
"description": "",
"type": "string"
},
"salesforceDocumentsAsContentFiles": {
"description": "When **true,** Docusign can use documents in your Salesforce account for sending and signing.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"senderOverride": {
"description": "",
"type": "string"
},
"senderSelectableItems": {
"description": "This property sets the items that are available for selection when adding or editing Connect objects.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"sfObjects": {
"description": "An array of Salesforce objects.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"items": {
"$ref": "#/definitions/connectSalesforceObject"
},
"type": "array"
},
"signMessageWithX509Certificate": {
"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.\n\nThis property is required.",
"type": "string"
},
"soapNamespace": {
"description": "The namespace of the SOAP interface.\n\n**Note:** If `useSoapInterface` is set to **true,** you must set this value.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"urlToPublishTo": {
"description": "The web address of the listener or retrieving service endpoint. It must be an HTTPS URL.\n\nThis property is required.",
"type": "string"
},
"useSoapInterface": {
"description": "When **true,** the notifications are sent to your endpoint as SOAP requests.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
},
"userIds": {
"description": "A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\nBy default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.**\n\n**Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"userName": {
"description": "The name of the user.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectCustomConfiguration",
"x-ms-summary": "The `connectCustomConfiguration` object describes a Connect configuration for your account."
},
"connectDebugLog": {
"description": "",
"properties": {
"connectConfig": {
"description": "The name of the Connect configuration.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"eventDateTime": {
"description": "The UTC date and time of the event.",
"type": "string"
},
"eventDescription": {
"description": "A description of the event.",
"type": "string"
},
"payload": {
"description": "Log output.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectDebugLog",
"x-ms-summary": ""
},
"connectDeleteFailureResult": {
"description": "",
"type": "object",
"x-ds-definition-name": "connectDeleteFailureResult",
"x-ms-summary": ""
},
"connectEventData": {
"description": "This object lets you choose the data format of your Connect response.",
"properties": {
"format": {
"description": "Reserved for Docusign.",
"type": "string"
},
"includeData": {
"description": "A string array of the data to be included.\nThe default is the empty array `[]`.\n\n- `attachments`: Include attachments associated with the envelope.\n- `custom_fields`: Include the custom fields associated with the envelope.\n- `documents`: Include the documents associated with the envelope.\n- `extensions`: Include information about the email settings associated with the envelope.\n- `folders`: Include the folder where the envelope exists.\n- `payment_tabs`: Include the payment tabs associated with the envelope.\n- `powerform`: Include the PowerForms associated with the envelope.\n- `prefill_tabs`: Include the [pre-filled tabs](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope.\n- `recipients`: Include the recipients associated with the envelope.\n- `tabs`: Include the tabs associated with the envelope.\n",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "Set this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectEventData",
"x-ms-summary": "This object lets you choose the data format of your Connect response."
},
"connectFailureFilter": {
"description": "A list of failed envelope IDs to retry.",
"properties": {
"envelopeIds": {
"description": "An array of envelope GUIDs.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"items": {
"type": "string"
},
"type": "array"
},
"synchronous": {
"description": "Must be **false.** Setting this property to any other value will result in errors.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectFailureFilter",
"x-ms-summary": "A list of failed envelope IDs to retry."
},
"connectFailureResult": {
"description": "This object contains details about a Connect failure result.",
"properties": {
"configId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"configUrl": {
"description": "Reserved for Docusign.\n",
"type": "string"
},
"envelopeId": {
"description": "The envelope ID of the envelope status that failed to post.",
"type": "string"
},
"status": {
"description": "The connection status.",
"type": "string"
},
"statusMessage": {
"description": "A human-readable message describing the connection status.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectFailureResult",
"x-ms-summary": "This object contains details about a Connect failure result."
},
"connectFailureResults": {
"description": "",
"properties": {
"retryQueue": {
"description": "Details about a Connect failure result.",
"items": {
"$ref": "#/definitions/connectFailureResult"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "connectFailureResults",
"x-ms-summary": ""
},
"connectHistoricalEnvelopeRepublish": {
"description": "The request body for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"properties": {
"config": {
"$ref": "#/definitions/connectCustomConfiguration",
"description": "An object describing the ad hoc Connect configuration data. This object is required.\n\n**Note:** Regardless of the `eventData.version` parameter on this object, envelope data will always be transmitted in JSON format. XML is not supported."
},
"envelopes": {
"description": "An array of envelope IDs as comma-separated strings. This property is required.\n\nFor example: `[\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\",\"9586h293-xxxx-xxxx-xxxx-m923b8opre71\",\"2347w948-xxxx-xxxx-xxxx-t096b8krno89\"]`",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "connectHistoricalEnvelopeRepublish",
"x-ms-summary": "The request body for the `createHistoricalEnvelopePublishTransaction` endpoint."
},
"connectLog": {
"description": "Contains information about a Connect log entry.",
"properties": {
"accountId": {
"description": "The account ID associated with the envelope.",
"type": "string"
},
"configUrl": {
"description": "The web address of the listener or retrieving service endpoint for Connect.",
"type": "string"
},
"connectDebugLog": {
"description": "A complex element containing information about the Connect configuration, error details, date/time, description and payload.\nThis information is included in the response only when the `additional_info` query is set to **true.**\nThis additional information is only available when retrieving general logs with [ConnectEvents:get](/docs/esign-rest-api/reference/connect/connectevents/get/), but not when retrieving failure logs with [ConnectEvents:listFailures](/docs/esign-rest-api/reference/connect/connectevents/listfailures/).",
"items": {
"$ref": "#/definitions/connectDebugLog"
},
"type": "array"
},
"connectId": {
"description": "The ID of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.",
"type": "string"
},
"created": {
"description": "The UTC DateTime when the Connect post was created.",
"type": "string"
},
"email": {
"description": "The email address of the envelope sender.",
"type": "string"
},
"envelopeId": {
"description": "The ID of the envelope that failed to post.",
"type": "string"
},
"error": {
"description": "The error that caused the Connect post to fail.",
"type": "string"
},
"failureId": {
"description": "The failure log ID for the failure.",
"type": "string"
},
"failureUri": {
"description": "The URI for the Connect post failure.",
"type": "string"
},
"lastTry": {
"description": "The UTC DateTime of the last attempt to post.",
"type": "string"
},
"logId": {
"description": "The Connect log ID for the entry.",
"type": "string"
},
"logUri": {
"description": "The URI for the Connect log entry.",
"type": "string"
},
"retryCount": {
"description": "The number of times the Connect post has been retried.",
"type": "string"
},
"retryUri": {
"description": "A URI that you can use to retry to publish the Connect post.",
"type": "string"
},
"status": {
"description": "The envelope status for the Connect post. Possible values are:\n- `Any`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Template`\n- `Processing`\n\nFor details about these statuses, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/).",
"type": "string"
},
"subject": {
"description": "The subject of the envelope.",
"type": "string"
},
"userName": {
"description": "The name of the sender of the envelope.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectLog",
"x-ms-summary": "Contains information about a Connect log entry."
},
"connectLogs": {
"description": "",
"properties": {
"failures": {
"description": "An array of containing failure information from the Connect failure log.",
"items": {
"$ref": "#/definitions/connectLog"
},
"type": "array"
},
"logs": {
"description": "A list of Connect general logs.",
"items": {
"$ref": "#/definitions/connectLog"
},
"type": "array"
},
"totalRecords": {
"description": "The count of records in the log list.",
"type": "string"
},
"type": {
"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",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectLogs",
"x-ms-summary": ""
},
"connectOAuthConfig": {
"description": "A complex object describing a Connect OAuth configuration.",
"properties": {
"authorizationServerUrl": {
"description": "The token URL for your authorization server or OAuth service.\n\nThis property is required.",
"type": "string"
},
"clientId": {
"description": "The client ID assigned to your app by your authorization server or OAuth service.\n\nThis property is required.",
"type": "string"
},
"clientSecret": {
"description": "The secret value provided by your authorization server.\n\nThis property is required.",
"type": "string"
},
"customParameters": {
"additionalProperties": {
"type": "string"
},
"description": "",
"type": "object"
},
"scope": {
"description": "The scopes that your app will request from the authorization server.\n\nThis property is optional.\n\n**Note:** If you are using Azure, this value is the application ID URI of the secified resource affixed with the `.default`. For example: `api://{{clientId}}/.default`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectOAuthConfig",
"x-ms-summary": "A complex object describing a Connect OAuth configuration."
},
"connectSalesforceField": {
"description": "This object is used to match a Docusign field to a Salesforce field so that Docusign can send information to your Salesforce account.",
"properties": {
"dsAttribute": {
"description": "",
"type": "string"
},
"dsLink": {
"description": "A URL that links to the information in the Docusign field.",
"type": "string"
},
"dsNode": {
"description": "",
"type": "string"
},
"id": {
"description": "A unique ID for the Salesforce object.",
"type": "string"
},
"sfField": {
"description": "",
"type": "string"
},
"sfFieldName": {
"description": "The name of the Salesforce field.",
"type": "string"
},
"sfFolder": {
"description": "The name of the Salesforce folder.",
"type": "string"
},
"sfLockedValue": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectSalesforceField",
"x-ms-summary": "This object is used to match a Docusign field to a Salesforce field so that Docusign can send information to your Salesforce account."
},
"connectSalesforceObject": {
"description": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install Docusign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize Docusign Connect for Salesforce by associating Docusign objects with Salesforce objects so that Docusign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[Docusign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).",
"properties": {
"active": {
"description": "When **true,** the `connectSalesforceObject` is active.",
"type": "string"
},
"description": {
"description": "A description of the `connectSalesforceObject`.",
"type": "string"
},
"id": {
"description": "The ID of the `connectSalesforceObject`.",
"type": "string"
},
"insert": {
"description": "",
"type": "string"
},
"onCompleteOnly": {
"description": "When **true,** Salesforce is updated only when the envelope is complete.",
"type": "string"
},
"selectFields": {
"description": "The Docusign and Salesforce fields that you want to use to match a Salesforce object with Docusign information. This information tells Connect when to send updates to Salesforce.",
"items": {
"$ref": "#/definitions/connectSalesforceField"
},
"type": "array"
},
"sfObject": {
"description": "The Salesforce.com object type, such as `case`, `contact`, or `opportunity`.",
"type": "string"
},
"sfObjectName": {
"description": "A name for the Salesforce object.\n\n**Note:** You can enter any name for the object. It does not have to match the `sfObject` property.",
"type": "string"
},
"updateFields": {
"description": "The Docusign and Salesforce fields that you want to update. \n\n**Note:** You can choose to update SalesForce (with information from Docusign) only, update Docusign only, or both.",
"items": {
"$ref": "#/definitions/connectSalesforceField"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "connectSalesforceObject",
"x-ms-summary": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install Docusign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize Docusign Connect for Salesforce by associating Docusign objects with Salesforce objects so that Docusign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[Docusign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New)."
},
"connectUserInfo": {
"description": "",
"properties": {
"email": {
"description": "",
"type": "string"
},
"isIncluded": {
"description": "",
"type": "string"
},
"userId": {
"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.",
"type": "string"
},
"userName": {
"description": "The name of the user.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectUserInfo",
"x-ms-summary": ""
},
"connectUserObject": {
"description": "",
"properties": {
"configurationtype": {
"description": "The type of custom Connect configuration being accessed.",
"type": "string"
},
"connectId": {
"description": "The ID of the custom Connect configuration being accessed.",
"type": "string"
},
"enabled": {
"description": "Boolean value that indicates whether the custom Connect configuration is enabled or not.",
"type": "string"
},
"hasAccess": {
"description": "",
"type": "string"
},
"senderSearchableItems": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "connectUserObject",
"x-ms-summary": ""
},
"connectedData": {
"description": "",
"properties": {
"propertyName": {
"description": "",
"type": "string"
},
"supportedOperation": {
"description": "",
"type": "string"
},
"supportedUri": {
"description": "",
"type": "string"
},
"typeName": {
"description": "",
"type": "string"
},
"typeSystemNamespace": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectedData",
"x-ms-summary": ""
},
"connectedObjectDetails": {
"description": "",
"properties": {
"recordId": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectedObjectDetails",
"x-ms-summary": ""
},
"connectionInstance": {
"description": "",
"properties": {
"connectionKey": {
"description": "",
"type": "string"
},
"connectionValue": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "connectionInstance",
"x-ms-summary": ""
},
"consentDetails": {
"description": "",
"properties": {
"consentKey": {
"description": "",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"signerConsentStatus": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "consentDetails",
"x-ms-summary": ""
},
"consoleViewRequest": {
"description": "The request object for the [EnvelopeViews: createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) method.",
"properties": {
"envelopeId": {
"description": "The ID of an envelope. If the envelope has been sent, the endpoint returns a URL for a view of the documents. If the envelope has not yet been sent, the endpoint returns a URL for the sender view.\n\nThis property is optional. If no value is provided, the endpoint returns a URL for the front page of the demo UI.",
"type": "string"
},
"returnUrl": {
"description": "The URL to which the user should be redirected. This is only used when the `envelopeId` is specified as a draft envelope. In this case, the endpoint returns a URL for the sender view. When the user exits the sender view, they will be redirected to the `returnUrl` value. If no value is provided, there is no option to leave the sender view.\n\nIn other cases, the user is not redirected out of the console view.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "consoleViewRequest",
"x-ms-summary": "The request object for the [EnvelopeViews: createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) method."
},
"consumerDisclosure": {
"description": "Details about consumer disclosures.",
"properties": {
"accountEsignId": {
"description": "The GUID of the account associated with the consumer disclosure.",
"type": "string"
},
"allowCDWithdraw": {
"description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting.",
"type": "string"
},
"allowCDWithdrawMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `allowCDWithdraw` property is editable.\n"
},
"changeEmail": {
"description": "If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters.",
"type": "string"
},
"changeEmailOther": {
"description": "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`",
"type": "string"
},
"companyName": {
"description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**",
"type": "string"
},
"companyPhone": {
"description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string.",
"type": "string"
},
"copyCostPerPage": {
"description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`",
"type": "string"
},
"copyFeeCollectionMethod": {
"description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`",
"type": "string"
},
"copyRequestEmail": {
"description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters.",
"type": "string"
},
"custom": {
"description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**",
"type": "string"
},
"enableEsign": {
"description": "When **true** (default), indicates that eSign is enabled.",
"type": "string"
},
"esignAgreement": {
"description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting.",
"type": "string"
},
"esignText": {
"description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.",
"type": "string"
},
"languageCode": {
"description": "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.",
"type": "string"
},
"mustAgreeToEsign": {
"description": "When **true,** the recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions.",
"type": "string"
},
"pdfId": {
"description": "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. ",
"type": "string"
},
"useBrand": {
"description": "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. ",
"type": "string"
},
"useConsumerDisclosureWithinAccount": {
"description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.",
"type": "string"
},
"useConsumerDisclosureWithinAccountMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.\n"
},
"withdrawAddressLine1": {
"description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ",
"type": "string"
},
"withdrawAddressLine2": {
"description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ",
"type": "string"
},
"withdrawByEmail": {
"description": "When **true** (default), indicates that the customer can withdraw consent by email.",
"type": "string"
},
"withdrawByMail": {
"description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**",
"type": "string"
},
"withdrawByPhone": {
"description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**",
"type": "string"
},
"withdrawCity": {
"description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. ",
"type": "string"
},
"withdrawConsequences": {
"description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters.",
"type": "string"
},
"withdrawEmail": {
"description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. ",
"type": "string"
},
"withdrawOther": {
"description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`",
"type": "string"
},
"withdrawPhone": {
"description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. ",
"type": "string"
},
"withdrawPostalCode": {
"description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. ",
"type": "string"
},
"withdrawState": {
"description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "consumerDisclosure",
"x-ms-summary": "Details about consumer disclosures."
},
"contact": {
"description": "",
"properties": {
"canManage": {
"description": "",
"type": "string"
},
"cloudProvider": {
"description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n",
"type": "string"
},
"cloudProviderContainerId": {
"description": "The ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room.",
"type": "string"
},
"contactId": {
"description": "The ID of a contact person in the account's address book.",
"type": "string"
},
"contactPhoneNumbers": {
"description": "A list of the contact's phone numbers.\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box.",
"items": {
"$ref": "#/definitions/contactPhoneNumber"
},
"type": "array"
},
"contactUri": {
"description": "The URI for retrieving information about the contact.",
"type": "string"
},
"emails": {
"description": "An array of email addresses.",
"items": {
"type": "string"
},
"type": "array"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"isOwner": {
"description": "",
"type": "boolean"
},
"name": {
"description": "The name of the contact.",
"type": "string"
},
"notaryContactDetails": {
"$ref": "#/definitions/notaryContactDetails",
"description": ""
},
"organization": {
"description": "",
"type": "string"
},
"roomContactType": {
"description": "",
"type": "string"
},
"shared": {
"description": "When **true,** this contact is shared.",
"type": "string"
},
"signingGroup": {
"description": "The ID of the signing group.",
"type": "string"
},
"signingGroupName": {
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "contact",
"x-ms-summary": ""
},
"contactGetResponse": {
"description": "This response object contains information about the contacts associated with an account.",
"properties": {
"contacts": {
"description": "A list of contacts.",
"items": {
"$ref": "#/definitions/contact"
},
"type": "array"
},
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "contactGetResponse",
"x-ms-summary": "This response object contains information about the contacts associated with an account."
},
"contactModRequest": {
"description": "The request object containing the new information for the contacts.",
"properties": {
"contactList": {
"description": "A list of contacts.",
"items": {
"$ref": "#/definitions/contact"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "contactModRequest",
"x-ms-summary": "The request object containing the new information for the contacts."
},
"contactPhoneNumber": {
"description": "Details about the phone numbers associated with a specific contact.",
"properties": {
"phoneNumber": {
"description": "The contact's phone number.\n\nExample: `+12223334444`",
"type": "string"
},
"phoneType": {
"description": "The type of phone number. Valid values are:\n\n- `home`\n- `mobile`\n- `work`\n- `other`\n- `fax`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "contactPhoneNumber",
"x-ms-summary": "Details about the phone numbers associated with a specific contact."
},
"contactUpdateResponse": {
"description": "This response objects shows the updated details for the contacts.",
"properties": {
"contacts": {
"description": "A list of contacts.",
"items": {
"$ref": "#/definitions/contact"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "contactUpdateResponse",
"x-ms-summary": "This response objects shows the updated details for the contacts."
},
"correctViewRequest": {
"description": "The request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method.",
"properties": {
"beginOnTagger": {
"description": "",
"type": "string"
},
"returnUrl": {
"description": "(Required) The URL to which the user should be redirected after\nthe view session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\nWhen Docusign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n* `send`: User corrected and sent the envelope.\n* `save`: User saved the envelope.\n* `cancel`: User canceled the transaction.\n* `error`: There was an error when performing the correct or send.\n* `sessionEnd`: The session ended before the user completed a different action.\n",
"type": "string"
},
"suppressNavigation": {
"description": "Specifies whether the window is displayed with or without dressing.",
"type": "string"
},
"viewUrl": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "correctViewRequest",
"x-ms-summary": "The request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method."
},
"country": {
"description": "",
"properties": {
"isoCode": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"provinceValidated": {
"description": "",
"type": "string"
},
"provinces": {
"description": "",
"items": {
"$ref": "#/definitions/province"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "country",
"x-ms-summary": ""
},
"creditCardInformation": {
"description": "This object contains information about a credit card that is associated with an account.",
"properties": {
"address": {
"$ref": "#/definitions/addressInformation",
"description": "A complex element containing the credit card billing address information."
},
"cardLastDigits": {
"description": "",
"type": "string"
},
"cardNumber": {
"description": "The credit card number.",
"type": "string"
},
"cardType": {
"description": "The type of credit card. Valid values are: \n\n- `visa` \n- `mastercard` \n- `amex`",
"type": "string"
},
"cvNumber": {
"description": "The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs).",
"type": "string"
},
"expirationMonth": {
"description": "The month that the credit card expires, expressed as a number from 1 to 12.",
"type": "string"
},
"expirationYear": {
"description": "The year in which the credit card expires, in 4-digit format.",
"type": "string"
},
"nameOnCard": {
"description": "The exact name as it appears on the credit card.",
"type": "string"
},
"tokenizedCard": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "creditCardInformation",
"x-ms-summary": "This object contains information about a credit card that is associated with an account."
},
"creditCardTypes": {
"description": "",
"properties": {
"cardTypes": {
"description": "An array containing supported credit card types.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "creditCardTypes",
"x-ms-summary": ""
},
"currencyFeatureSetPrice": {
"description": "Information about the price and currency associated with the feature set. Reserved for internal Docusign use only.",
"properties": {
"currencyCode": {
"description": "Specifies the alternate ISO currency code for the account. ",
"type": "string"
},
"currencySymbol": {
"description": "Reserved for Docusign.",
"type": "string"
},
"envelopeFee": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fixedFee": {
"description": "Reserved for Docusign.",
"type": "string"
},
"seatFee": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "currencyFeatureSetPrice",
"x-ms-summary": "Information about the price and currency associated with the feature set. Reserved for internal Docusign use only."
},
"currencyPlanPrice": {
"description": "",
"properties": {
"currencyCode": {
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.",
"type": "string"
},
"currencySymbol": {
"description": "Specifies the currency symbol.\nValid values:\n\n- `AED` Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "date",
"x-ms-summary": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, Docusign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n"
},
"dateSigned": {
"description": "A tab that displays the date that the recipient signed the\ndocument.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"timestampStandardized": {
"description": "",
"type": "string"
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "**Note:** Date Signed 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",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "dateSigned",
"x-ms-summary": "A tab that displays the date that the recipient signed the\ndocument.\n"
},
"dateStampProperties": {
"description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.",
"properties": {
"dateAreaHeight": {
"description": "The height of the rectangle.",
"type": "string"
},
"dateAreaWidth": {
"description": "The width of the rectangle.",
"type": "string"
},
"dateAreaX": {
"description": "The X axis position of the top-left corner.",
"type": "string"
},
"dateAreaY": {
"description": "The Y axis position of the top-left corner.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "dateStampProperties",
"x-ms-summary": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle."
},
"decline": {
"description": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"buttonText": {
"description": " Specifies the decline text displayed in the tab.",
"type": "string"
},
"buttonTextMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `buttonText` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"declineReason": {
"description": "The reason the recipient declined the document.",
"type": "string"
},
"declineReasonMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `declineReason` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "**Note:** Decline 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",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "decline",
"x-ms-summary": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n"
},
"delayedRouting": {
"description": "A complex element that specifies the delayed routing settings for the workflow step.",
"properties": {
"resumeDate": {
"description": "The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is `null` if the workflow step has not been initiated.\n\nThis property is read-only.\n",
"type": "string"
},
"rules": {
"description": "User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.",
"items": {
"$ref": "#/definitions/envelopeDelayRule"
},
"type": "array"
},
"status": {
"description": "Status of the delayed routing step. Valid values:\n\n* `pending`: The workflow step has not been reached and the delay has not been initiated.\n* `started`: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients.\n* `completed`: The delay has elapsed and the envelope has been sent to the workflow step's recipients.\n\nThis property is read-only.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "delayedRouting",
"x-ms-summary": "A complex element that specifies the delayed routing settings for the workflow step."
},
"delegationInfo": {
"description": "",
"properties": {
"email": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"userAuthorizationId": {
"description": "",
"type": "string"
},
"userId": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "delegationInfo",
"x-ms-summary": ""
},
"diagnosticsSettingsInformation": {
"description": "",
"properties": {
"apiRequestLogMaxEntries": {
"description": "Specifies the maximum number of API requests to log.",
"type": "string"
},
"apiRequestLogRemainingEntries": {
"description": "Indicates the remaining number of API requests that can be logged.",
"type": "string"
},
"apiRequestLogging": {
"description": " When **true,** enables API request logging for the user. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "diagnosticsSettingsInformation",
"x-ms-summary": ""
},
"directDebitProcessorInformation": {
"description": "Contains information about a bank that processes a customer's direct debit payments.",
"properties": {
"bankBranchCode": {
"description": "The branch code of the bank used for direct debit.\n\nMaximum Length: 10 characters.",
"type": "string"
},
"bankCheckDigit": {
"description": "The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account.\n\nMaximum Length: 4 characters.",
"type": "string"
},
"bankCode": {
"description": "The code or number that identifies the bank. This is also known as the sort code.\n\nExample: `200000`\n\nMaximum Length: 18 characters.",
"type": "string"
},
"bankName": {
"description": "The name of the direct debit bank.\n\nMaximum Length: 80 characters.",
"type": "string"
},
"bankTransferAccountName": {
"description": "The name on the direct debit bank account. This field is required for POST and PUT requests.\n\nMaximum Length: 60 characters.",
"type": "string"
},
"bankTransferAccountNumber": {
"description": "The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters.",
"type": "string"
},
"bankTransferType": {
"description": "Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are:\n\n- `DirectDebitUK`\n- `DirectEntryAU`\n- `SEPA`",
"type": "string"
},
"country": {
"description": "The user's country. The system populates this value automatically.\n\n",
"type": "string"
},
"email": {
"description": "The email address of the user who is associated with the payment method. This field is required for POST and PUT requests.\n\nMaximum Length: 80 characters.",
"type": "string"
},
"firstName": {
"description": "The user's first name. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters.",
"type": "string"
},
"iBAN": {
"description": "The International Bank Account Number (IBAN). \n\nExample: `DE89370400440532013000`\n\nFor more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm).\n\n**Note:** This number will be obfuscated.",
"type": "string"
},
"lastName": {
"description": "The user's last name. This field is required for POST and PUT requests.\n\nMaximum Length: 70 characters.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "directDebitProcessorInformation",
"x-ms-summary": "Contains information about a bank that processes a customer's direct debit payments."
},
"dobInformationInput": {
"description": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse",
"properties": {
"dateOfBirth": {
"description": "Specifies the recipient's date, month, and year of birth.",
"type": "string"
},
"displayLevelCode": {
"description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`",
"type": "string"
},
"receiveInResponse": {
"description": "A Boolean value that specifies whether the information must be returned in the response.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "dobInformationInput",
"x-ms-summary": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse"
},
"docGenFormField": {
"description": "The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT). When used with [DocumentGeneration: updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) (PUT), the `name` and `value` / `rowValues` properties are required and any other values are ignored.\n",
"properties": {
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"defaultValue": {
"description": "",
"type": "string"
},
"description": {
"description": "A description of the field. Displayed with the label.",
"type": "string"
},
"filter": {
"description": "An object used to present a filtered view of the items in a folder.",
"type": "string"
},
"format": {
"$ref": "#/definitions/docGenFormat",
"description": ""
},
"fullyQualifiedPath": {
"description": "",
"type": "string"
},
"hidden": {
"description": "",
"type": "string"
},
"label": {
"description": "A label displayed near the field.",
"type": "string"
},
"name": {
"description": "The name of the sender field.\n\nRequired for PUT requests.\n",
"type": "string"
},
"options": {
"description": "When `type` is `Select`, this array describes the available options.",
"items": {
"$ref": "#/definitions/docGenFormFieldOption"
},
"type": "array"
},
"order": {
"description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ",
"type": "string"
},
"predefinedValidation": {
"description": "Reserved for Docusign.",
"type": "string"
},
"readOnly": {
"description": "",
"type": "string"
},
"required": {
"description": "When **true,** the field is required.",
"type": "string"
},
"rowValues": {
"description": "For fields of type `TableRow`, this property represents the sender fields in the row.\n\nFor GET requests, this array contains a single `docGenFormFieldRowValue` object. That object contains a list of sender fields that will appear in each row.\n\nFor PUT requests, you must supply a `docGenFormFieldRowValue` object for each row in the table. This populates the data in the table.\n",
"items": {
"$ref": "#/definitions/docGenFormFieldRowValue"
},
"type": "array"
},
"type": {
"description": "The kind of data the sender field holds. Valid values:\n\n- `TextBox`\n- `Date`\n- `Number`\n- `Select`\n- `TableRow`\n",
"type": "string"
},
"validation": {
"$ref": "#/definitions/docGenFormFieldValidation",
"description": "Describes how values are validated."
},
"value": {
"description": "The value of the sender field.\n\nFor PUT requests, you must supply either this property (for all fields except `TableRow` types) or `rowValues` (for `TableRow` fields).",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormField",
"x-ms-summary": "The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT). When used with [DocumentGeneration: updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) (PUT), the `name` and `value` / `rowValues` properties are required and any other values are ignored.\n"
},
"docGenFormFieldOption": {
"description": "Specifies an individual option setting when type is `Select`.",
"properties": {
"description": {
"description": "Description of the selectable option.",
"type": "string"
},
"label": {
"description": "The label for the selectable option.",
"type": "string"
},
"selected": {
"description": "When **true,** the option is selected.",
"type": "string"
},
"value": {
"description": "Specifies the value of the option. This is the value of the form field when this option is selected.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormFieldOption",
"x-ms-summary": "Specifies an individual option setting when type is `Select`."
},
"docGenFormFieldRequest": {
"description": "This object maps the document generation fields to their values.",
"properties": {
"docGenFormFields": {
"description": "A list of `docGenFormFields` objects.",
"items": {
"$ref": "#/definitions/docGenFormFields"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormFieldRequest",
"x-ms-summary": "This object maps the document generation fields to their values."
},
"docGenFormFieldResponse": {
"description": "An object for document generation responses.",
"properties": {
"docGenFormFields": {
"description": "A list of `docGenFormFields` objects.",
"items": {
"$ref": "#/definitions/docGenFormFields"
},
"type": "array"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
}
},
"type": "object",
"x-ds-definition-name": "docGenFormFieldResponse",
"x-ms-summary": "An object for document generation responses."
},
"docGenFormFieldRowValue": {
"description": "An object representing a row of a dynamic table.",
"properties": {
"docGenFormFieldList": {
"description": "The sender fields in each row of the table.\n\nFor GET requests, the `label`, `type`, `required`, and `name` properties will be returned.\n\nFor POST requests, supply the `name` and `value` for each child object. These correspond to the values in each column.",
"items": {
"$ref": "#/definitions/docGenFormField"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormFieldRowValue",
"x-ms-summary": "An object representing a row of a dynamic table."
},
"docGenFormFieldValidation": {
"description": "Describes how values are validated.",
"properties": {
"errorMessage": {
"description": "The error message when validation fails.",
"type": "string"
},
"expression": {
"description": "The expression used to validate values.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormFieldValidation",
"x-ms-summary": "Describes how values are validated."
},
"docGenFormFields": {
"description": "A collection of document generation fields.",
"properties": {
"docGenDocumentStatus": {
"description": "The status of the document. This is a read-only property, and not used in [updateEnvelopeDocGenFormFields][docgen update].\nValid values:\n\n- `mergesucceeded`\n- `created`\n- `hassyntaxerror`\n\n[docgen update]: /docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/\n\n",
"type": "string"
},
"docGenErrors": {
"description": "A list of `docGenSyntaxError` objects.",
"items": {
"$ref": "#/definitions/docGenSyntaxError"
},
"type": "array"
},
"docGenFormFieldList": {
"description": "A list of `docGenFormField` objects.",
"items": {
"$ref": "#/definitions/docGenFormField"
},
"type": "array"
},
"documentId": {
"description": "The GUID of the document.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormFields",
"x-ms-summary": "A collection of document generation fields."
},
"docGenFormat": {
"description": "",
"properties": {
"expression": {
"description": "",
"type": "string"
},
"locale": {
"description": "The user's locale code. Valid values are:\n- `zh_CN`\n- `zh_TW`\n- `nl`\n- `en`\n- `fr`\n- `de`\n- `it`\n- `ja`\n- `ko`\n- `pt`\n- `pt_BR`\n- `ru`\n- `es`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "docGenFormat",
"x-ms-summary": ""
},
"docGenSyntaxError": {
"description": "Describes document generation errors.",
"properties": {
"errorCode": {
"description": "A code associated with the error condition.",
"type": "string"
},
"message": {
"description": "The error message.",
"type": "string"
},
"tagIdentifier": {
"description": "The tag that caused the syntax error.\nSee [Document Generation Syntax](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ftc1679700030026.html)\nto learn more about document generation syntax rules.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "docGenSyntaxError",
"x-ms-summary": "Describes document generation errors."
},
"document": {
"description": "A document object.",
"properties": {
"applyAnchorTabs": {
"description": "Reserved for Docusign.",
"type": "string"
},
"assignTabsToRecipientId": {
"description": "",
"type": "string"
},
"authoritativeCopy": {
"description": "When **true,** this document is considered an authoritative copy.\n\nIf this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property.\n\nWhen **false,** this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property.",
"type": "boolean"
},
"display": {
"description": "This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n* `modal`hello world
\"\n```\n\nIf the value of this property is the string `document`,\nthe HTML signing page is generated from the provided document.\n\n```\nsource: \"document\"\n```\n\n**Related topics**\n\n- [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/)\n- [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)\n- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)\n\n\n[smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html", "type": "string" } }, "type": "object", "x-ds-definition-name": "documentHtmlDefinition", "x-ms-summary": "Holds the properties that define how to generate the responsive-formatted HTML for the document.\nSee [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)\nin the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)." }, "documentHtmlDefinitionOriginal": { "description": "", "properties": { "documentId": { "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentIdGuid": { "description": "The GUID of the document.", "type": "string" }, "htmlDefinition": { "$ref": "#/definitions/documentHtmlDefinition", "description": "Defines how to generate the responsive-formatted HTML for the document." } }, "type": "object", "x-ds-definition-name": "documentHtmlDefinitionOriginal", "x-ms-summary": "" }, "documentHtmlDefinitionOriginals": { "description": "", "properties": { "htmlDefinitions": { "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "items": { "$ref": "#/definitions/documentHtmlDefinitionOriginal" }, "type": "array" } }, "type": "object", "x-ds-definition-name": "documentHtmlDefinitionOriginals", "x-ms-summary": "" }, "documentHtmlDefinitions": { "description": "", "properties": { "htmlDefinitions": { "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-ds-definition-name": "documentHtmlDefinitions", "x-ms-summary": "" }, "documentHtmlDisplayAnchor": { "description": "", "properties": { "caseSensitive": { "description": "When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content.", "type": "boolean" }, "displaySettings": { "$ref": "#/definitions/documentHtmlDisplaySettings", "description": "This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays." }, "endAnchor": { "description": "Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required.", "type": "string" }, "removeEndAnchor": { "description": "When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.", "type": "boolean" }, "removeStartAnchor": { "description": "When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.", "type": "boolean" }, "startAnchor": { "description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required.", "type": "string" } }, "type": "object", "x-ds-definition-name": "documentHtmlDisplayAnchor", "x-ms-summary": "" }, "documentHtmlDisplaySettings": { "description": "This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`.", "properties": { "cellStyle": { "description": "Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.", "type": "string" }, "collapsibleSettings": { "$ref": "#/definitions/documentHtmlCollapsibleDisplaySettings", "description": "This object defines the appearance and function of a collapsible section or item." }, "display": { "description": "Sets the display and behavior properties. Possible values are:\n\n- `inline`:\n Leaves the HTML where it is in the document.\n This property lets you add a label or present on a separate page.\n\n- `collapsible`:\n The HTML in this section may be expanded or collapsed.\n Initially this section is expanded.\n\n- `collapsed`:\n The HTML in this section may be expanded or collapsed.\n Initially this section is collapsed.\n\n- `continue_button`:\n Creates a stop point in the document to draw the reader's\n attention before proceeding to the next section.\n\n- `responsive_table`:\n Turns this section into a responsive table.\n Note that this is only used on HTML tables that fall within the anchor start and end positions.\n\n- `responsive_table_single_column`:\n Turns this section into a responsive single-column table.\n Note this is only used on HTML tables that fall within the anchor start and end positions.\n The table will be converted to one single column where each current column will become a row, then stacked.\n\n- `print_only`:\n Do not show this portion of the HTML in the responsive signing view.\n\n\n", "type": "string" }, "displayLabel": { "description": "The label to add to this display section in the signing page.\n", "type": "string" }, "displayOrder": { "description": "The position on the page where the display section appears.", "format": "int32", "type": "integer" }, "displayPageNumber": { "description": "The number of the page on which the display section appears.", "format": "int32", "type": "integer" }, "hideLabelWhenOpened": { "description": "When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.", "type": "boolean" }, "inlineOuterStyle": { "description": "Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.", "type": "string" }, "labelWhenOpened": { "description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.", "type": "string" }, "preLabel": { "description": "Enables you to add descriptive text that appears before a collapsed section or continue button.", "type": "string" }, "scrollToTopWhenOpened": { "description": "When **true** and the section is expanded,\nthe position of the section-close control\nscrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.\n", "type": "boolean" }, "tableStyle": { "description": "Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.", "type": "string" } }, "type": "object", "x-ds-definition-name": "documentHtmlDisplaySettings", "x-ms-summary": "This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`." }, "documentTemplate": { "description": "", "properties": { "documentEndPage": { "description": "", "type": "string" }, "documentId": { "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "documentStartPage": { "description": "", "type": "string" }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "templateId": { "description": "The unique identifier of the template. If this is not provided, Docusign generates an error and the call fails.", "type": "string" } }, "type": "object", "x-ds-definition-name": "documentTemplate", "x-ms-summary": "" }, "documentTemplateList": { "description": "", "properties": { "documentTemplates": { "description": "", "items": { "$ref": "#/definitions/documentTemplate" }, "type": "array" } }, "type": "object", "x-ds-definition-name": "documentTemplateList", "x-ms-summary": "" }, "documentVisibility": { "description": "This object configures a recipient's read/write access to a document.", "properties": { "documentId": { "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.", "type": "string" }, "errorDetails": { "$ref": "#/definitions/errorDetails", "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "recipientId": { "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", "type": "string" }, "rights": { "description": "Indicates whether the document is editable:\n\n- `editable`\n- `read_only`", "type": "string" }, "visible": { "description": "When **true,** the document is visible to the recipient.", "type": "string" } }, "type": "object", "x-ds-definition-name": "documentVisibility", "x-ms-summary": "This object configures a recipient's read/write access to a document." }, "documentVisibilityList": { "description": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.", "properties": { "documentVisibility": { "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.", "items": { "$ref": "#/definitions/documentVisibility" }, "type": "array" } }, "type": "object", "x-ds-definition-name": "documentVisibilityList", "x-ms-summary": "A list of `documentVisibility` objects that specify whether documents are visible to recipients." }, "downgradRequestBillingInfoResponse": { "description": "", "properties": { "downgradePlanInformation": { "$ref": "#/definitions/downgradePlanUpdateResponse", "description": "" }, "paymentMethod": { "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`", "type": "string" } }, "type": "object", "x-ds-definition-name": "downgradRequestBillingInfoResponse", "x-ms-summary": "" }, "downgradeBillingPlanInformation": { "description": "", "properties": { "downgradeEventType": { "description": "", "type": "string" }, "planInformation": { "$ref": "#/definitions/planInformation", "description": "An object used to identify the features and attributes of the account being created." }, "promoCode": { "description": "", "type": "string" }, "saleDiscount": { "description": "", "type": "string" }, "saleDiscountPeriods": { "description": "Reserved for Docusign.", "type": "string" }, "saleDiscountType": { "description": "", "type": "string" } }, "type": "object", "x-ds-definition-name": "downgradeBillingPlanInformation", "x-ms-summary": "" }, "downgradePlanUpdateResponse": { "description": "", "properties": { "accountPaymentMethod": { "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- ", "type": "string" }, "discountApplied": { "description": "", "type": "string" }, "downgradeEffectiveDate": { "description": "", "type": "string" }, "downgradePaymentCycle": { "description": "", "type": "string" }, "downgradePlanId": { "description": "", "type": "string" }, "downgradePlanName": { "description": "", "type": "string" }, "downgradeRequestStatus": { "description": "", "type": "string" }, "message": { "description": "", "type": "string" }, "productId": { "description": "The Product ID from the AppStore.", "type": "string" }, "promoCode": { "description": "", "type": "string" }, "saleDiscount": { "description": "", "type": "string" }, "saleDiscountPeriods": { "description": "Reserved for Docusign.", "type": "string" }, "saleDiscountType": { "description": "", "type": "string" } }, "type": "object", "x-ds-definition-name": "downgradePlanUpdateResponse", "x-ms-summary": "" }, "downgradeRequestInformation": { "description": "", "properties": { "downgradeRequestCreation": { "description": "", "type": "string" }, "downgradeRequestProductId": { "description": "", "type": "string" }, "downgradeRequestStatus": { "description": "", "type": "string" } }, "type": "object", "x-ds-definition-name": "downgradeRequestInformation", "x-ms-summary": "" }, "draw": { "description": "A tab that allows the recipient to add a free-form drawing to the document.", "properties": { "agreementAttribute": { "description": "", "type": "string" }, "agreementAttributeLocked": { "description": "", "type": "string" }, "allowSignerUpload": { "description": "When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.**", "type": "string" }, "anchorAllowWhiteSpaceInCharacters": { "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,Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"useBackgroundAsCanvas": {
"description": "",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "draw",
"x-ms-summary": "A tab that allows the recipient to add a free-form drawing to the document."
},
"eNoteConfiguration": {
"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",
"properties": {
"apiKey": {
"description": "",
"type": "string"
},
"connectConfigured": {
"description": "When **false,** the user must configure Connect and eOriginal for the integration to work.",
"type": "string"
},
"eNoteConfigured": {
"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.",
"type": "string"
},
"organization": {
"description": "The name of the organization.",
"type": "string"
},
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
},
"userName": {
"description": "The user's username.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "eNoteConfiguration",
"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"
},
"editor": {
"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.",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"customFields": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. ",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The recipient's first name. \n\nMaximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "email",
"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"
},
"emailAddress": {
"description": "A tab that displays the recipient's email as entered in the\nrecipient information.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"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",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "emailAddress",
"x-ms-summary": "A tab that displays the recipient's email as entered in the\nrecipient information.\n"
},
"emailSettings": {
"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.",
"properties": {
"bccEmailAddresses": {
"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.",
"items": {
"$ref": "#/definitions/bccEmailAddress"
},
"type": "array"
},
"replyEmailAddressOverride": {
"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.",
"type": "string"
},
"replyEmailNameOverride": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "emailSettings",
"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."
},
"envelope": {
"description": "",
"properties": {
"accessControlListBase64": {
"description": "Reserved for Docusign.",
"type": "string"
},
"allowComments": {
"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.",
"type": "string"
},
"allowMarkup": {
"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",
"type": "string"
},
"allowReassign": {
"description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient.",
"type": "string"
},
"allowViewHistory": {
"description": "When **true,** recipients can view the history of the envelope.",
"type": "string"
},
"anySigner": {
"description": "Deprecated. This feature has been replaced by signing groups.",
"type": "string"
},
"asynchronous": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the\nConnect notification.",
"type": "string"
},
"attachmentsUri": {
"description": "Contains a URL for retrieving the attachments that are associated with the envelope.",
"type": "string"
},
"authoritativeCopy": {
"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.**",
"type": "string"
},
"authoritativeCopyDefault": {
"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`.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"brandId": {
"description": "The ID of the brand.",
"type": "string"
},
"brandLock": {
"description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.",
"type": "string"
},
"burnDefaultTabData": {
"description": "",
"type": "string"
},
"certificateUri": {
"description": "The URI for retrieving certificate information.",
"type": "string"
},
"completedDateTime": {
"description": "Specifies the date and time this item was completed.",
"type": "string"
},
"copyRecipientData": {
"description": "",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"customFields": {
"$ref": "#/definitions/AccountCustomFields",
"description": "An optional array of strings that enables the sender to provide custom data about the envelope. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters."
},
"customFieldsUri": {
"description": "The URI for retrieving custom fields.",
"type": "string"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"deletedDateTime": {
"description": "Reserved for Docusign.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"disableResponsiveDocument": {
"description": "When **true,** responsive documents are disabled for the envelope.",
"type": "string"
},
"documentBase64": {
"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.",
"type": "string"
},
"documentsCombinedUri": {
"description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.",
"type": "string"
},
"documentsUri": {
"description": "The URI for retrieving all of the documents associated with the envelope as separate files.",
"type": "string"
},
"emailBlurb": {
"description": "This is the same as the email body. If specified it is included in email body for all envelope recipients.",
"type": "string"
},
"emailSettings": {
"$ref": "#/definitions/emailSettings",
"description": "A complex type that contains email settings."
},
"emailSubject": {
"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",
"type": "string"
},
"enableWetSign": {
"description": "When **true,** the signer is allowed to print the document and sign it on paper.",
"type": "string"
},
"enforceSignerVisibility": {
"description": "When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.\n\n**Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan.\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/\n[sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending\n[fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html\n[support]: https://support.docusign.com/en/contactSupport#",
"type": "string"
},
"envelopeAttachments": {
"description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.",
"items": {
"$ref": "#/definitions/attachment"
},
"type": "array"
},
"envelopeCustomMetadata": {
"$ref": "#/definitions/envelopeCustomMetadata",
"description": ""
},
"envelopeDocuments": {
"description": "An array containing information about the documents that are included in the envelope.",
"items": {
"$ref": "#/definitions/envelopeDocument"
},
"type": "array"
},
"envelopeId": {
"description": "The envelope ID of the envelope status that failed to post.",
"type": "string"
},
"envelopeIdStamping": {
"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.",
"type": "string"
},
"envelopeLocation": {
"description": "Reserved for Docusign.",
"type": "string"
},
"envelopeMetadata": {
"$ref": "#/definitions/envelopeMetadata",
"description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and Docusign eNotary service."
},
"envelopeUri": {
"description": "The URI for retrieving the envelope or envelopes.",
"type": "string"
},
"expireAfter": {
"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.",
"type": "string"
},
"expireDateTime": {
"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",
"type": "string"
},
"expireEnabled": {
"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.",
"type": "string"
},
"externalEnvelopeId": {
"description": "May contain an external identifier for the envelope.",
"type": "string"
},
"folders": {
"description": "A list of folder objects.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"hasComments": {
"description": "When **true,** indicates that users have added comments to the envelope.",
"type": "string"
},
"hasFormDataChanged": {
"description": "When **true,** indicates that the data collected through form fields on a document has changed.",
"type": "string"
},
"hasWavFile": {
"description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. ",
"type": "string"
},
"holder": {
"description": "Reserved for Docusign.",
"type": "string"
},
"initialSentDateTime": {
"description": "The date and time the envelope was initially sent.",
"type": "string"
},
"is21CFRPart11": {
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).",
"type": "string"
},
"isDynamicEnvelope": {
"description": "When **true,** indicates that the envelope is a dynamic envelope.",
"type": "string"
},
"isSignatureProviderEnvelope": {
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
},
"location": {
"description": "Reserved for Docusign.",
"type": "string"
},
"lockInformation": {
"$ref": "#/definitions/EnvelopeLocks",
"description": "Provides lock information about an envelope that a user has locked."
},
"messageLock": {
"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.",
"type": "string"
},
"notification": {
"$ref": "#/definitions/notification",
"description": ""
},
"notificationUri": {
"description": "The URI for retrieving notifications.",
"type": "string"
},
"powerForm": {
"$ref": "#/definitions/powerForm",
"description": "Information about any PowerForms that are included in the envelope."
},
"purgeCompletedDate": {
"description": "The date that a purge was completed.",
"type": "string"
},
"purgeRequestDate": {
"description": "The date that a purge was requested.",
"type": "string"
},
"purgeState": {
"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)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n\n",
"type": "string"
},
"recipients": {
"$ref": "#/definitions/EnvelopeRecipients",
"description": "An array of recipient objects that provides details about the recipients of the envelope."
},
"recipientsLock": {
"description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.",
"type": "string"
},
"recipientsUri": {
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients.",
"type": "string"
},
"sender": {
"$ref": "#/definitions/userInfo",
"description": "Information about the sender of the envelope."
},
"sentDateTime": {
"description": "The UTC DateTime when the envelope was sent. This property is read-only.",
"type": "string"
},
"signerCanSignOnMobile": {
"description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"signingLocation": {
"description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusChangedDateTime": {
"description": "The data and time that the status changed.",
"type": "string"
},
"templatesUri": {
"description": "The URI for retrieving the templates.",
"type": "string"
},
"transactionId": {
"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.",
"type": "string"
},
"uSigState": {
"description": "",
"type": "string"
},
"useDisclosure": {
"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.",
"type": "string"
},
"voidedDateTime": {
"description": "The date and time the envelope or template was voided.",
"type": "string"
},
"voidedReason": {
"description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n",
"type": "string"
},
"workflow": {
"$ref": "#/definitions/workflow",
"description": ""
}
},
"type": "object",
"x-ds-definition-name": "envelope",
"x-ms-summary": ""
},
"envelopeAttachment": {
"description": "",
"properties": {
"accessControl": {
"description": "Valid values are `sender` and `senderAndAllRecipients`.",
"type": "string"
},
"attachmentId": {
"description": "The unique identifier for the attachment.",
"type": "string"
},
"attachmentType": {
"description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"label": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeAttachment",
"x-ms-summary": ""
},
"envelopeAttachmentsRequest": {
"description": "",
"properties": {
"attachments": {
"description": "An object that contains information about the attachment.",
"items": {
"$ref": "#/definitions/attachment"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeAttachmentsRequest",
"x-ms-summary": ""
},
"envelopeAttachmentsResult": {
"description": "",
"properties": {
"attachments": {
"description": "An array of attachment objects that contain information about the attachments.",
"items": {
"$ref": "#/definitions/envelopeAttachment"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeAttachmentsResult",
"x-ms-summary": ""
},
"envelopeAuditEvent": {
"description": "",
"properties": {
"eventFields": {
"description": "",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeAuditEvent",
"x-ms-summary": ""
},
"envelopeAuditEventResponse": {
"description": "",
"properties": {
"auditEvents": {
"description": "Reserved for Docusign.",
"items": {
"$ref": "#/definitions/envelopeAuditEvent"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeAuditEventResponse",
"x-ms-summary": ""
},
"envelopeCustomMetadata": {
"description": "",
"properties": {
"envelopeCustomMetadataDetails": {
"description": "",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeCustomMetadata",
"x-ms-summary": ""
},
"envelopeDefinition": {
"description": "Envelope object definition.",
"properties": {
"accessControlListBase64": {
"description": "Reserved for Docusign.",
"type": "string"
},
"accessibility": {
"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.",
"type": "string"
},
"allowComments": {
"description": "When **true,** comments are allowed on the envelope.",
"type": "string"
},
"allowMarkup": {
"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",
"type": "string"
},
"allowReassign": {
"description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient.",
"type": "string"
},
"allowRecipientRecursion": {
"description": "When **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.",
"type": "string"
},
"allowViewHistory": {
"description": "When **true,** users can view the history of the envelope.",
"type": "string"
},
"anySigner": {
"description": "Deprecated. This feature has been replaced by signing groups.",
"type": "string"
},
"asynchronous": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the\nConnect notification.",
"type": "string"
},
"attachments": {
"description": "An array of attachment objects containing details about any envelope attachments.",
"items": {
"$ref": "#/definitions/attachment"
},
"type": "array"
},
"attachmentsUri": {
"description": "The URI for retrieving the envelope attachments.",
"type": "string"
},
"authoritativeCopy": {
"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.**",
"type": "string"
},
"authoritativeCopyDefault": {
"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`.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"brandId": {
"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.",
"type": "string"
},
"brandLock": {
"description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.",
"type": "string"
},
"burnDefaultTabData": {
"description": "",
"type": "string"
},
"certificateUri": {
"description": "The URI for retrieving certificate information.",
"type": "string"
},
"completedDateTime": {
"description": "The date and time that the envelope was completed.",
"type": "string"
},
"compositeTemplates": {
"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.",
"items": {
"$ref": "#/definitions/compositeTemplate"
},
"type": "array"
},
"copyRecipientData": {
"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.",
"type": "string"
},
"createdDateTime": {
"description": "The date and time that the envelope was created.",
"type": "string"
},
"customFields": {
"$ref": "#/definitions/AccountCustomFields",
"description": "An optional array of strings that enables the sender to provide\ncustom data about the recipient. This information is returned in\nthe envelope status but otherwise not used by Docusign. Each\n`customField` string can be a maximum of 100 characters.\n\n\n**Note:** Any custom fields you set with this API method\nwill _replace_ custom fields you have defined with\n[Envelope Custom Fields in Admin](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html),\nwhether the\n**Show field to envelope creators**\nor\n**Make fields required for envelopes**\noptions are checked or not.\n"
},
"customFieldsUri": {
"description": "The URI for retrieving custom fields.",
"type": "string"
},
"declinedDateTime": {
"description": "The date and time that the recipient declined the envelope.",
"type": "string"
},
"deletedDateTime": {
"description": "The date and time that the envelope was deleted.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"disableResponsiveDocument": {
"description": "When **true,** the responsive document feature is turned off for the envelope.",
"type": "string"
},
"documentBase64": {
"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.",
"type": "string"
},
"documents": {
"description": "A complex element that contains details about the documents associated with the envelope.",
"items": {
"$ref": "#/definitions/document"
},
"type": "array"
},
"documentsCombinedUri": {
"description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.",
"type": "string"
},
"documentsUri": {
"description": "The URI for retrieving all of the documents associated with the envelope as separate files.",
"type": "string"
},
"emailBlurb": {
"description": "This optional element holds the body of the email message that is sent to all envelope recipients. \n\nMaximum Length: 10000 characters.",
"type": "string"
},
"emailSettings": {
"$ref": "#/definitions/emailSettings",
"description": "This optional complex element enables 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, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope.\n\n**Important Note:** The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings."
},
"emailSubject": {
"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",
"type": "string"
},
"enableWetSign": {
"description": "When **true,** the signer is allowed to print the document and sign it on paper.",
"type": "string"
},
"enforceSignerVisibility": {
"description": "When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.\n\n**Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan.\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/\n[sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending\n[fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html\n[support]: https://support.docusign.com/en/contactSupport#",
"type": "string"
},
"envelopeAttachments": {
"description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.",
"items": {
"$ref": "#/definitions/attachment"
},
"type": "array"
},
"envelopeCustomMetadata": {
"$ref": "#/definitions/envelopeCustomMetadata",
"description": ""
},
"envelopeDocuments": {
"description": "An array containing information about the documents that are included in the envelope.",
"items": {
"$ref": "#/definitions/envelopeDocument"
},
"type": "array"
},
"envelopeId": {
"description": "The envelope ID.\n\nWhen used as a request body in [Envelopes: create](/docs/esign-rest-api/reference/envelopes/envelopes/create/), this is the ID of the envelope to clone.",
"type": "string"
},
"envelopeIdStamping": {
"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.",
"type": "string"
},
"envelopeLocation": {
"description": "Reserved for Docusign.",
"type": "string"
},
"envelopeMetadata": {
"$ref": "#/definitions/envelopeMetadata",
"description": "Metadata about the features that are enabled for the envelope."
},
"envelopeUri": {
"description": "The URI for retrieving the envelope or envelopes.",
"type": "string"
},
"eventNotification": {
"$ref": "#/definitions/eventNotification",
"description": "This optional object is used to register a webhook that will receive status changes for this envelope."
},
"expireAfter": {
"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.",
"type": "string"
},
"expireDateTime": {
"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.",
"type": "string"
},
"expireEnabled": {
"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.",
"type": "string"
},
"externalEnvelopeId": {
"description": "May contain an external identifier for the envelope.",
"type": "string"
},
"folders": {
"description": "An array of folders that the envelope belongs to.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"hasComments": {
"description": "When **true,** indicates that users have added comments to the envelope.",
"type": "string"
},
"hasFormDataChanged": {
"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.",
"type": "string"
},
"hasWavFile": {
"description": "When **true,** indicates that a wave file (voice recording) is part of the envelope.",
"type": "string"
},
"holder": {
"description": "Reserved for Docusign.",
"type": "string"
},
"initialSentDateTime": {
"description": "The date and time that the envelope was first sent.",
"type": "string"
},
"is21CFRPart11": {
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).",
"type": "string"
},
"isDynamicEnvelope": {
"description": "When **true,** indicates that the envelope is a dynamic envelope.",
"type": "string"
},
"isSignatureProviderEnvelope": {
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
},
"location": {
"description": "Reserved for Docusign.",
"type": "string"
},
"lockInformation": {
"$ref": "#/definitions/EnvelopeLocks",
"description": "Provides lock information about an envelope that a user has locked."
},
"messageLock": {
"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.",
"type": "string"
},
"notification": {
"$ref": "#/definitions/notification",
"description": "An optional complex element that specifies the notification options for the envelope."
},
"notificationUri": {
"description": "The URI for retrieving notifications.",
"type": "string"
},
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
},
"powerForm": {
"$ref": "#/definitions/powerForm",
"description": "Information about any PowerForms that are included in the envelope."
},
"purgeCompletedDate": {
"description": "The date that a purge was completed.",
"type": "string"
},
"purgeRequestDate": {
"description": "The date that a purge was requested.",
"type": "string"
},
"purgeState": {
"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)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n",
"type": "string"
},
"recipientViewRequest": {
"$ref": "#/definitions/recipientViewRequest",
"description": ""
},
"recipients": {
"$ref": "#/definitions/EnvelopeRecipients",
"description": "Specifies the envelope recipients."
},
"recipientsLock": {
"description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.",
"type": "string"
},
"recipientsUri": {
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients.",
"type": "string"
},
"sender": {
"$ref": "#/definitions/userInfo",
"description": "Information about the sender of the envelope."
},
"sentDateTime": {
"description": "The UTC DateTime when the envelope was sent. This property is read-only.",
"type": "string"
},
"signerCanSignOnMobile": {
"description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"signingLocation": {
"description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusChangedDateTime": {
"description": "The data and time that the status changed.",
"type": "string"
},
"templateId": {
"description": "The ID of the template. If a value is not provided, Docusign generates a value. ",
"type": "string"
},
"templateRoles": {
"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",
"items": {
"$ref": "#/definitions/templateRole"
},
"type": "array"
},
"templatesUri": {
"description": "The URI for retrieving any templates associated with the envelope.",
"type": "string"
},
"transactionId": {
"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.",
"type": "string"
},
"uSigState": {
"description": "",
"type": "string"
},
"useDisclosure": {
"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.",
"type": "string"
},
"voidedDateTime": {
"description": "The date and time the envelope or template was voided.",
"type": "string"
},
"voidedReason": {
"description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n",
"type": "string"
},
"workflow": {
"$ref": "#/definitions/workflow",
"description": "Describes the workflow for this envelope."
}
},
"type": "object",
"x-ds-definition-name": "envelopeDefinition",
"x-ms-summary": "Envelope object definition."
},
"envelopeDelayRule": {
"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.",
"properties": {
"delay": {
"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.",
"type": "string"
},
"resumeDate": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeDelayRule",
"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."
},
"envelopeDocument": {
"description": "This object contains details about the envelope document.",
"properties": {
"addedRecipientIds": {
"description": "If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only.",
"items": {
"type": "string"
},
"type": "array"
},
"agreementType": {
"description": "",
"type": "string"
},
"agreementTypeSource": {
"description": "",
"type": "string"
},
"attachmentTabId": {
"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.",
"type": "string"
},
"authoritativeCopy": {
"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.**",
"type": "string"
},
"authoritativeCopyMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents."
},
"availableDocumentTypes": {
"description": "",
"items": {
"$ref": "#/definitions/signatureType"
},
"type": "array"
},
"containsPdfFormFields": {
"description": "When **true,** the document has editable form fields that are made available through a PDF format.",
"type": "string"
},
"display": {
"description": "This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n* `modal`Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "envelopeId",
"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"
},
"envelopeIdsRequest": {
"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",
"properties": {
"envelopeIds": {
"description": "A comma-separated list of envelope IDs to include in the results.",
"items": {
"type": "string"
},
"type": "array"
},
"transactionIds": {
"description": "A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeIdsRequest",
"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"
},
"envelopeMetadata": {
"description": "",
"properties": {
"allowAdvancedCorrect": {
"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.",
"type": "string"
},
"allowCorrect": {
"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.",
"type": "string"
},
"enableSignWithNotary": {
"description": "Specifies if Docusign eNotary service is enabled for the envelope.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeMetadata",
"x-ms-summary": ""
},
"envelopeNotificationRequest": {
"description": "A complex element that specifies the notification settings for the envelope.",
"properties": {
"expirations": {
"$ref": "#/definitions/expirations",
"description": "A complex element that specifies the expiration settings for the envelope."
},
"reminders": {
"$ref": "#/definitions/reminders",
"description": "A complex element that specifies reminder settings for the envelope."
},
"useAccountDefaults": {
"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.**",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeNotificationRequest",
"x-ms-summary": "A complex element that specifies the notification settings for the envelope."
},
"envelopePublishTransaction": {
"description": "",
"properties": {
"applyConnectSettings": {
"description": "",
"type": "string"
},
"envelopeCount": {
"description": "",
"type": "string"
},
"envelopeLevelErrorRollups": {
"description": "",
"items": {
"$ref": "#/definitions/envelopePublishTransactionErrorRollup"
},
"type": "array"
},
"envelopePublishTransactionId": {
"description": "The ID of the publish transaction.",
"type": "string"
},
"errorCount": {
"description": "",
"type": "string"
},
"fileLevelErrors": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"noActionRequiredEnvelopeCount": {
"description": "",
"type": "string"
},
"processedEnvelopeCount": {
"description": "",
"type": "string"
},
"processingStatus": {
"description": "The status of the transaction. Valid values:\n\n* `unprocessed`\n* `processing`\n* `complete`\n* `fatal_error`\n",
"type": "string"
},
"resultsUri": {
"description": "",
"type": "string"
},
"submissionDate": {
"description": "",
"type": "string"
},
"submittedByUserInfo": {
"$ref": "#/definitions/userInfo",
"description": ""
},
"submittedForPublishingEnvelopeCount": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopePublishTransaction",
"x-ms-summary": ""
},
"envelopePublishTransactionErrorRollup": {
"description": "",
"properties": {
"count": {
"description": "The maximum number of results to return.",
"type": "string"
},
"errorType": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopePublishTransactionErrorRollup",
"x-ms-summary": ""
},
"envelopePurgeConfiguration": {
"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`). ",
"properties": {
"purgeEnvelopes": {
"description": "When **true,** purging is enabled.",
"type": "string"
},
"redactPII": {
"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.**",
"type": "string"
},
"removeTabsAndEnvelopeAttachments": {
"description": "When **true,** the system also purges the tabs and attachments associated with the envelopes. ",
"type": "string"
},
"retentionDays": {
"description": "The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopePurgeConfiguration",
"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`). "
},
"envelopeSummary": {
"description": " This object describes an envelope.",
"properties": {
"bulkEnvelopeStatus": {
"$ref": "#/definitions/bulkEnvelopeStatus",
"description": "An object that describes the status of the bulk send envelopes."
},
"envelopeId": {
"description": "The envelope ID of the envelope status that failed to post.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"recipientSigningUri": {
"description": "",
"type": "string"
},
"recipientSigningUriError": {
"description": "",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusDateTime": {
"description": "The DateTime that the envelope changed status (i.e. was created or sent.)",
"type": "string"
},
"uri": {
"description": "A URI containing the user ID.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeSummary",
"x-ms-summary": " This object describes an envelope."
},
"envelopeTemplate": {
"description": "",
"properties": {
"accessControlListBase64": {
"description": "Reserved for Docusign.",
"type": "string"
},
"allowComments": {
"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.",
"type": "string"
},
"allowMarkup": {
"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",
"type": "string"
},
"allowReassign": {
"description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient.",
"type": "string"
},
"allowViewHistory": {
"description": "When **true,** recipients can view the history of the envelope.",
"type": "string"
},
"anySigner": {
"description": "Deprecated. This feature has been replaced by signing groups.",
"type": "string"
},
"asynchronous": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the\nConnect notification.",
"type": "string"
},
"attachmentsUri": {
"description": "Contains a URL for retrieving the attachments that are associated with the envelope.",
"type": "string"
},
"authoritativeCopy": {
"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.**",
"type": "string"
},
"authoritativeCopyDefault": {
"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`.",
"type": "string"
},
"autoMatch": {
"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.",
"type": "string"
},
"autoMatchSpecifiedByUser": {
"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.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"brandId": {
"description": "The ID of the brand.",
"type": "string"
},
"brandLock": {
"description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.",
"type": "string"
},
"burnDefaultTabData": {
"description": "",
"type": "string"
},
"certificateUri": {
"description": "The URI for retrieving certificate information.",
"type": "string"
},
"completedDateTime": {
"description": "Specifies the date and time this item was completed.",
"type": "string"
},
"copyRecipientData": {
"description": "",
"type": "string"
},
"created": {
"description": "The UTC DateTime when the workspace user authorization was created.",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"customFields": {
"$ref": "#/definitions/AccountCustomFields",
"description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters."
},
"customFieldsUri": {
"description": "The URI for retrieving custom fields.",
"type": "string"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"deletedDateTime": {
"description": "Reserved for Docusign.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"description": {
"description": "A sender-defined description of the line item.\n",
"type": "string"
},
"disableResponsiveDocument": {
"description": "When **true,** responsive documents are disabled for the envelope.",
"type": "string"
},
"documentBase64": {
"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.",
"type": "string"
},
"documents": {
"description": "A complex element that contains details about the documents associated with the envelope.",
"items": {
"$ref": "#/definitions/document"
},
"type": "array"
},
"documentsCombinedUri": {
"description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file.",
"type": "string"
},
"documentsUri": {
"description": "The URI for retrieving all of the documents associated with the envelope as separate files.",
"type": "string"
},
"emailBlurb": {
"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.",
"type": "string"
},
"emailSettings": {
"$ref": "#/definitions/emailSettings",
"description": "A complex type that contains email settings."
},
"emailSubject": {
"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",
"type": "string"
},
"enableWetSign": {
"description": "When **true,** the signer is allowed to print the document and sign it on paper.",
"type": "string"
},
"enforceSignerVisibility": {
"description": "When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.\n\n**Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan.\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/\n[sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending\n[fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html\n[support]: https://support.docusign.com/en/contactSupport#",
"type": "string"
},
"envelopeAttachments": {
"description": "An array of attachment objects that provide information about the attachments that are associated with the envelope.",
"items": {
"$ref": "#/definitions/attachment"
},
"type": "array"
},
"envelopeCustomMetadata": {
"$ref": "#/definitions/envelopeCustomMetadata",
"description": ""
},
"envelopeDocuments": {
"description": "An array containing information about the documents that are included in the envelope.",
"items": {
"$ref": "#/definitions/envelopeDocument"
},
"type": "array"
},
"envelopeId": {
"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",
"type": "string"
},
"envelopeIdStamping": {
"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.",
"type": "string"
},
"envelopeLocation": {
"description": "Reserved for Docusign.",
"type": "string"
},
"envelopeMetadata": {
"$ref": "#/definitions/envelopeMetadata",
"description": "Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and Docusign eNotary service."
},
"envelopeUri": {
"description": "The URI for retrieving the envelope or envelopes.",
"type": "string"
},
"expireAfter": {
"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.",
"type": "string"
},
"expireDateTime": {
"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.",
"type": "string"
},
"expireEnabled": {
"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.",
"type": "string"
},
"externalEnvelopeId": {
"description": "May contain an external identifier for the envelope.",
"type": "string"
},
"favoritedByMe": {
"description": "",
"type": "string"
},
"folderId": {
"description": "The ID of the folder.",
"type": "string"
},
"folderIds": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"folderName": {
"description": "",
"type": "string"
},
"folders": {
"description": "A list of folder objects.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"hasComments": {
"description": "When **true,** indicates that users have added comments to the envelope.",
"type": "string"
},
"hasFormDataChanged": {
"description": "When **true,** indicates that the data collected through form fields on a document has changed.",
"type": "string"
},
"hasWavFile": {
"description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. ",
"type": "string"
},
"holder": {
"description": "Reserved for Docusign.",
"type": "string"
},
"initialSentDateTime": {
"description": "The date and time the envelope was initially sent.",
"type": "string"
},
"is21CFRPart11": {
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).",
"type": "string"
},
"isAceGenTemplate": {
"description": "",
"type": "string"
},
"isDocGenTemplate": {
"description": "",
"type": "string"
},
"isDynamicEnvelope": {
"description": "When **true,** indicates that the envelope is a dynamic envelope.",
"type": "string"
},
"isSignatureProviderEnvelope": {
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModified": {
"description": "The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator.",
"type": "string"
},
"lastModifiedBy": {
"$ref": "#/definitions/userInfo",
"description": ""
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
},
"lastUsed": {
"description": "",
"type": "string"
},
"location": {
"description": "Reserved for Docusign.",
"type": "string"
},
"lockInformation": {
"$ref": "#/definitions/EnvelopeLocks",
"description": "Provides lock information about an envelope that a user has locked."
},
"messageLock": {
"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.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"newPassword": {
"description": "The user's new password.",
"type": "string"
},
"notification": {
"$ref": "#/definitions/notification",
"description": ""
},
"notificationUri": {
"description": "The URI for retrieving notifications.",
"type": "string"
},
"owner": {
"$ref": "#/definitions/userInfo",
"description": "Information about the user who owns the template."
},
"pageCount": {
"description": "An integer value specifying the number of document pages in the template. ",
"type": "string"
},
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
},
"passwordProtected": {
"description": "",
"type": "string"
},
"powerForm": {
"$ref": "#/definitions/powerForm",
"description": "Information about any PowerForms that are included in the envelope."
},
"powerForms": {
"description": "An array of PowerForm objects.",
"items": {
"$ref": "#/definitions/powerForm"
},
"type": "array"
},
"purgeCompletedDate": {
"description": "The date that a purge was completed.",
"type": "string"
},
"purgeRequestDate": {
"description": "The date that a purge was requested.",
"type": "string"
},
"purgeState": {
"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)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n\n",
"type": "string"
},
"recipients": {
"$ref": "#/definitions/EnvelopeRecipients",
"description": "An array of recipient objects that provides details about the recipients of the envelope."
},
"recipientsLock": {
"description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.",
"type": "string"
},
"recipientsUri": {
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients.",
"type": "string"
},
"sender": {
"$ref": "#/definitions/userInfo",
"description": "Information about the sender of the envelope."
},
"sentDateTime": {
"description": "The UTC DateTime when the envelope was sent. This property is read-only.",
"type": "string"
},
"shared": {
"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",
"type": "string"
},
"signerCanSignOnMobile": {
"description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"signingLocation": {
"description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusChangedDateTime": {
"description": "The data and time that the status changed.",
"type": "string"
},
"templateId": {
"description": "The unique identifier of the template. If this is not provided, Docusign will generate a value. ",
"type": "string"
},
"templatesUri": {
"description": "The URI for retrieving the templates.",
"type": "string"
},
"transactionId": {
"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.",
"type": "string"
},
"uSigState": {
"description": "",
"type": "string"
},
"uri": {
"description": "A URI containing the user ID.",
"type": "string"
},
"useDisclosure": {
"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.",
"type": "string"
},
"voidedDateTime": {
"description": "The date and time the envelope or template was voided.",
"type": "string"
},
"voidedReason": {
"description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n",
"type": "string"
},
"workflow": {
"$ref": "#/definitions/workflow",
"description": ""
}
},
"type": "object",
"x-ds-definition-name": "envelopeTemplate",
"x-ms-summary": ""
},
"envelopeTemplateResults": {
"description": "Information about templates.",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"envelopeTemplates": {
"description": "The list of requested templates.",
"items": {
"$ref": "#/definitions/envelopeTemplate"
},
"type": "array"
},
"folders": {
"description": "A list of folder objects.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeTemplateResults",
"x-ms-summary": "Information about templates."
},
"envelopeTransactionStatus": {
"description": "",
"properties": {
"envelopeId": {
"description": "The envelope ID of the envelope status that failed to post.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"status": {
"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",
"type": "string"
},
"transactionId": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeTransactionStatus",
"x-ms-summary": ""
},
"envelopeTransferRule": {
"description": "This object contains details about an envelope transfer rule.",
"properties": {
"carbonCopyOriginalOwner": {
"description": "When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**",
"type": "string"
},
"enabled": {
"description": "When **true,** the envelope transfer rule is active.",
"type": "string"
},
"envelopeTransferRuleId": {
"description": "The ID of the envelope transfer rule. The system generates this ID when the rule is first created.",
"type": "string"
},
"eventType": {
"description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`",
"type": "string"
},
"fromGroup": {
"$ref": "#/definitions/group",
"description": "Information about the group that triggers the transfer."
},
"fromUser": {
"$ref": "#/definitions/userInformation",
"description": "Information about the user who triggers the transfer."
},
"modifiedDate": {
"description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read-only.",
"type": "string"
},
"modifiedUser": {
"$ref": "#/definitions/userInformation",
"description": "Information about the user who last modified the envelope transfer rule."
},
"toFolder": {
"$ref": "#/definitions/folder",
"description": "Information about the destination folder to which the envelope is transferred."
},
"toUser": {
"$ref": "#/definitions/userInformation",
"description": "Information about the user to which the envelope is transferred."
}
},
"type": "object",
"x-ds-definition-name": "envelopeTransferRule",
"x-ms-summary": "This object contains details about an envelope transfer rule."
},
"envelopeTransferRuleInformation": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"envelopeTransferRules": {
"description": "Contains information about a specific envelope transfer rule.",
"items": {
"$ref": "#/definitions/envelopeTransferRule"
},
"type": "array"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeTransferRuleInformation",
"x-ms-summary": ""
},
"envelopeTransferRuleRequest": {
"description": "This object contains details about the envelope transfer rule that you want to create.",
"properties": {
"carbonCopyOriginalOwner": {
"description": "When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**",
"type": "string"
},
"enabled": {
"description": "When **true,** the envelope transfer rule is active.",
"type": "string"
},
"envelopeTransferRuleId": {
"description": "The ID of the envelope transfer rule. The system generates this ID when the rule is first created.",
"type": "string"
},
"eventType": {
"description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`",
"type": "string"
},
"fromGroups": {
"description": "Information about the group that triggers the transfer.",
"items": {
"$ref": "#/definitions/group"
},
"type": "array"
},
"fromUsers": {
"description": "Information about the user who triggers the transfer.",
"items": {
"$ref": "#/definitions/userInformation"
},
"type": "array"
},
"modifiedDate": {
"description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read-only.",
"type": "string"
},
"modifiedUser": {
"$ref": "#/definitions/userInformation",
"description": "Information about the user who last modified the envelope transfer rule."
},
"toFolder": {
"$ref": "#/definitions/folder",
"description": "Information about the destination folder to which the envelope is transferred."
},
"toUser": {
"$ref": "#/definitions/userInformation",
"description": "Information about the user to which the envelope is transferred."
}
},
"type": "object",
"x-ds-definition-name": "envelopeTransferRuleRequest",
"x-ms-summary": "This object contains details about the envelope transfer rule that you want to create."
},
"envelopeUpdateSummary": {
"description": "",
"properties": {
"bulkEnvelopeStatus": {
"$ref": "#/definitions/bulkEnvelopeStatus",
"description": "An object that describes the status of the bulk send envelopes."
},
"envelopeId": {
"description": "The envelope ID of the envelope status that failed to post.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"listCustomFieldUpdateResults": {
"description": "",
"items": {
"$ref": "#/definitions/listCustomField"
},
"type": "array"
},
"lockInformation": {
"$ref": "#/definitions/EnvelopeLocks",
"description": "Provides lock information about an envelope that a user has locked."
},
"purgeState": {
"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)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n\n",
"type": "string"
},
"recipientUpdateResults": {
"description": "An array of `recipientUpdateResults` objects that contain details about the recipients.",
"items": {
"$ref": "#/definitions/recipientUpdateResponse"
},
"type": "array"
},
"tabUpdateResults": {
"$ref": "#/definitions/EnvelopeRecipientTabs",
"description": ""
},
"textCustomFieldUpdateResults": {
"description": "",
"items": {
"$ref": "#/definitions/textCustomField"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopeUpdateSummary",
"x-ms-summary": ""
},
"envelopeViewDocumentSettings": {
"description": "",
"properties": {
"showEditDocumentVisibility": {
"description": "When `false`, prevents the user from modifying document visibility settings. The default value is `true`.",
"type": "string"
},
"showEditDocuments": {
"description": "When **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.**",
"type": "string"
},
"showEditPages": {
"description": "When `false`, prevents the user from deleting or rotating individual document pages via the thumbnail images. The default value is `true`. If `true` and `showEditDocuments` is `false`, the pages can be rotated but not deleted.",
"type": "string"
},
"showSaveAsDocumentCustomField": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewDocumentSettings",
"x-ms-summary": ""
},
"envelopeViewEnvelopeCustomFieldSettings": {
"description": "",
"properties": {
"showEnvelopeCustomFields": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewEnvelopeCustomFieldSettings",
"x-ms-summary": ""
},
"envelopeViewRecipientSettings": {
"description": "",
"properties": {
"showBulkSend": {
"description": "Reserved for Docusign.",
"type": "string"
},
"showContactsList": {
"description": "Reserved for Docusign.",
"type": "string"
},
"showEditMessage": {
"description": "Reserved for Docusign.",
"type": "string"
},
"showEditRecipients": {
"description": "When `false`, prevents the user from changing the recipients from the **Tagger** page. The default value is `true`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewRecipientSettings",
"x-ms-summary": ""
},
"envelopeViewRequest": {
"description": "",
"properties": {
"returnUrl": {
"description": "**Required**\n\nIdentifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: \n\n* send (user sends the envelope)\n* save (user saves the envelope)\n* cancel (user cancels the sending transaction. No envelopeId is returned in this case.)\n* error (there is an error when performing the send)\n* sessionEnd (the sending session ends before the user completes another action).",
"type": "string"
},
"settings": {
"$ref": "#/definitions/envelopeViewSettings",
"description": "Sets the UX for the resulting embedded view."
},
"viewAccess": {
"description": "**Required** . Set to `envelope`\n",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewRequest",
"x-ms-summary": ""
},
"envelopeViewSettings": {
"description": "",
"properties": {
"backButtonAction": {
"description": "Sets the behavior of the back button when clicked. Valid values:\n* `previousPage`: Navigate to browser's previous page\n* `redirect`: Redirect to the `returnUrl` specified in the request",
"type": "string"
},
"documentSettings": {
"$ref": "#/definitions/envelopeViewDocumentSettings",
"description": "Sets the custom document settings."
},
"envelopeCustomFieldSettings": {
"$ref": "#/definitions/envelopeViewEnvelopeCustomFieldSettings",
"description": "Reserved for Docusign."
},
"lockToken": {
"description": "If your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.",
"type": "string"
},
"recipientSettings": {
"$ref": "#/definitions/envelopeViewRecipientSettings",
"description": ""
},
"sendButtonAction": {
"description": "Sets the behavior of the send button when clicked. Valid values:\n* `send`: send the envelope and redirect with query parameter `event=Send` (default)\n* `redirect`: Change the Tagger page's button text to 'Continue'; when clicked, redirect to the `returnUrl` with query parameter `event=Save`. Set `showBackButton` to `false` and `startingScreen` to `Tagger`.",
"type": "string"
},
"showAdvancedOptions": {
"description": "Reserved for Docusign.",
"type": "string"
},
"showBackButton": {
"description": "Determines whether the Tagger's back button is shown. Valid values:\n\n* `true`: The back button is shown. This is the default value.\n* `false`: Prevents access to the Prepare screen by hiding the back button.",
"type": "string"
},
"showDiscardAction": {
"description": "When **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**",
"type": "string"
},
"showHeaderActions": {
"description": "Determines whether the Actions menu displays advanced actions. Valid values:\n\n* `true`: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value.\n* `false`: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set `startingScreen` to `Tagger` and `showBackButton` to `false`.",
"type": "string"
},
"showSignNow": {
"description": "",
"type": "string"
},
"startingScreen": {
"description": "Determines the starting screen for the sender view. Valid values:\n\n* `Prepare` (default)\n* `Tagger`",
"type": "string"
},
"taggerSettings": {
"$ref": "#/definitions/envelopeViewTaggerSettings",
"description": "Sets the custom tagger settings."
},
"templateSettings": {
"$ref": "#/definitions/envelopeViewTemplateSettings",
"description": "Reserved for Docusign."
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewSettings",
"x-ms-summary": ""
},
"envelopeViewTaggerSettings": {
"description": "",
"properties": {
"paletteDefault": {
"description": "When `paletteSections` is set to `custom`, this property selects the default tagger palette. \nValid values: \n* `custom`\n* `merge`\n* `notary`\n* `seals`\n* `smartContracts`\n* `annotations`\n* `smartSections`",
"type": "string"
},
"paletteSections": {
"description": "Valid values:\n\n* `default` (default): The default tagger palette UX\n* `none`: No tagger palette\n* `custom`: Set by `paletteDefault`",
"type": "string"
},
"paletteSettings": {
"$ref": "#/definitions/paletteSettings",
"description": "Reserved for Docusign."
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewTaggerSettings",
"x-ms-summary": ""
},
"envelopeViewTemplateSettings": {
"description": "",
"properties": {
"showMatchingTemplatesPrompt": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopeViewTemplateSettings",
"x-ms-summary": ""
},
"envelopesInformation": {
"description": "Result set for the Envelopes: listStatusChanges method",
"properties": {
"continuationToken": {
"description": "Reserved for Docusign.",
"type": "string"
},
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"envelopeSearchSource": {
"description": "",
"type": "string"
},
"envelopeTransactionStatuses": {
"description": "Array of envelope statuses and transaction IDs in the result set.",
"items": {
"$ref": "#/definitions/envelopeTransactionStatus"
},
"type": "array"
},
"envelopes": {
"description": "Array of envelope information.",
"items": {
"$ref": "#/definitions/envelope"
},
"type": "array"
},
"folders": {
"description": "A list of folder objects.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"lastQueriedDateTime": {
"description": "The last time that a query was performed.",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopesInformation",
"x-ms-summary": "Result set for the Envelopes: listStatusChanges method"
},
"envelopesSharePermissionRequest": {
"description": "",
"properties": {
"customMessage": {
"description": "",
"type": "string"
},
"permission": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopesSharePermissionRequest",
"x-ms-summary": ""
},
"envelopesShareRequest": {
"description": "",
"properties": {
"agentUser": {
"$ref": "#/definitions/authorizationUser",
"description": ""
},
"customMessage": {
"description": "",
"type": "string"
},
"permission": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopesShareRequest",
"x-ms-summary": ""
},
"envelopesShareResponse": {
"description": "",
"properties": {
"agentUser": {
"$ref": "#/definitions/authorizationUser",
"description": ""
},
"createdTimestamp": {
"description": "",
"type": "string"
},
"envelopeId": {
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"modifiedTimestamp": {
"description": "",
"type": "string"
},
"permission": {
"description": "",
"type": "string"
},
"senderInfo": {
"$ref": "#/definitions/authorizationUser",
"description": ""
},
"shareId": {
"description": "",
"type": "string"
},
"subject": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "envelopesShareResponse",
"x-ms-summary": ""
},
"envelopesSharesRequest": {
"description": "",
"properties": {
"shares": {
"description": "",
"items": {
"$ref": "#/definitions/envelopesShareRequest"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopesSharesRequest",
"x-ms-summary": ""
},
"envelopesSharesResponse": {
"description": "",
"properties": {
"shares": {
"description": "",
"items": {
"$ref": "#/definitions/envelopesShareResponse"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "envelopesSharesResponse",
"x-ms-summary": ""
},
"errorDetails": {
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests.",
"properties": {
"errorCode": {
"description": "The code associated with the error condition.",
"type": "string"
},
"message": {
"description": "A brief message describing the error condition.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "errorDetails",
"x-ms-summary": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"eventNotification": {
"description": "Use this object to configure a [Docusign Connect webhook](/platform/webhooks/connect/).",
"properties": {
"deliveryMode": {
"description": "",
"type": "string"
},
"envelopeEvents": {
"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.",
"items": {
"$ref": "#/definitions/envelopeEvent"
},
"type": "array"
},
"eventData": {
"$ref": "#/definitions/connectEventData",
"description": "Allows you to specify the format of the information the Connect webhooks returns."
},
"events": {
"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](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) 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",
"items": {
"type": "string"
},
"type": "array"
},
"includeCertificateOfCompletion": {
"description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. ",
"type": "string"
},
"includeCertificateWithSoap": {
"description": "When **true,**\nthe Connect service will digitally sign\nthe data.\nThe signature will be included in the message.",
"type": "string"
},
"includeDocumentFields": {
"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. ",
"type": "string"
},
"includeDocuments": {
"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.",
"type": "string"
},
"includeEnvelopeVoidReason": {
"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. ",
"type": "string"
},
"includeHMAC": {
"description": "When **true,** HMAC headers will be included with the webhook notifications.\n\n**Note:** [HMAC must enabled](/platform/webhooks/connect/hmac/) at the account level with [one or more HMAC secrets](/platform/webhooks/connect/setting-up-hmac/).",
"type": "string"
},
"includeOAuth": {
"description": "",
"type": "string"
},
"includeSenderAccountAsCustomField": {
"description": "When **true,** Connect will include the sender account as Custom Field in the data.",
"type": "string"
},
"includeTimeZone": {
"description": "When **true,** the envelope's time zone information is included in the webhook messages. ",
"type": "string"
},
"integratorManaged": {
"description": "",
"type": "string"
},
"loggingEnabled": {
"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](/docs/esign-rest-api/reference/connect/connectevents/).",
"type": "string"
},
"recipientEvents": {
"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.",
"items": {
"$ref": "#/definitions/recipientEvent"
},
"type": "array"
},
"requireAcknowledgment": {
"description": "When **true,** the Docusign Connect service checks that the message was received and retries on failures. ",
"type": "string"
},
"signMessageWithX509Cert": {
"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. ",
"type": "string"
},
"soapNameSpace": {
"description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.",
"type": "string"
},
"url": {
"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",
"type": "string"
},
"useSoapInterface": {
"description": "When **true,** this tells the Connect service that the user's endpoint has implemented a SOAP interface. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "eventNotification",
"x-ms-summary": "Use this object to configure a [Docusign Connect webhook](/platform/webhooks/connect/)."
},
"eventResult": {
"description": "Information about the result of an event.",
"properties": {
"eventTimestamp": {
"description": "Date/time of the event.",
"type": "string"
},
"failureDescription": {
"description": "Reason for failure, if the event failed.",
"type": "string"
},
"status": {
"description": "Event status.",
"type": "string"
},
"vendorFailureStatusCode": {
"description": "Failure status code, if the event failed.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "eventResult",
"x-ms-summary": "Information about the result of an event."
},
"expirations": {
"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",
"properties": {
"expireAfter": {
"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.**",
"type": "string"
},
"expireEnabled": {
"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).",
"type": "string"
},
"expireWarn": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "expirations",
"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"
},
"extensionData": {
"description": "",
"properties": {
"actionContract": {
"description": "",
"type": "string"
},
"actionInputKey": {
"description": "",
"type": "string"
},
"actionName": {
"description": "",
"type": "string"
},
"applicationId": {
"description": "",
"type": "string"
},
"applicationName": {
"description": "",
"type": "string"
},
"connectedFieldsData": {
"$ref": "#/definitions/connectedData",
"description": ""
},
"connectionInstances": {
"description": "",
"items": {
"$ref": "#/definitions/connectionInstance"
},
"type": "array"
},
"extensionContract": {
"description": "",
"type": "string"
},
"extensionGroupId": {
"description": "",
"type": "string"
},
"extensionName": {
"description": "",
"type": "string"
},
"extensionPolicy": {
"description": "",
"type": "string"
},
"publisherName": {
"description": "",
"type": "string"
},
"requiredForExtension": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "extensionData",
"x-ms-summary": ""
},
"externalDocServiceErrorDetails": {
"description": "",
"properties": {
"authenticationUrl": {
"description": "Reserved for Docusign.",
"type": "string"
},
"errorCode": {
"description": "A code associated with the error condition.",
"type": "string"
},
"message": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "externalDocServiceErrorDetails",
"x-ms-summary": ""
},
"externalDocumentSources": {
"description": "A complex object specifying the external document sources.",
"properties": {
"boxnetEnabled": {
"description": "The account is enabled to allow external documents to be attached from BoxNet.",
"type": "string"
},
"boxnetMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata indicating whether the `boxnetEnabled` property is editable."
},
"dropboxEnabled": {
"description": "The account is enabled to allow external documents to be attached from DropBox.",
"type": "string"
},
"dropboxMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata indicating whether the `dropboxEnabled` property is editable."
},
"googleDriveEnabled": {
"description": "The account is enabled to allow external documents to be attached from Google Drive.",
"type": "string"
},
"googleDriveMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata indicating whether the `googleDriveEnabled` property is editable."
},
"oneDriveEnabled": {
"description": "The account is enabled to allow external documents to be attached from OneDrive.",
"type": "string"
},
"oneDriveMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata indicating whether the `oneDriveEnabled` property is editable."
},
"salesforceEnabled": {
"description": "The account is enabled to allow external documents to be attached from Salesforce.",
"type": "string"
},
"salesforceMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata indicating whether the `salesforceEnabled` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "externalDocumentSources",
"x-ms-summary": "A complex object specifying the external document sources."
},
"externalFile": {
"description": "This object contains information about a file or folder in cloud storage.",
"properties": {
"date": {
"description": "The UTC date and time that the file or folder was last modified.",
"type": "string"
},
"hasCompositeTemplate": {
"description": "",
"type": "string"
},
"id": {
"description": "The storage provider's ID for the file or folder.",
"type": "string"
},
"img": {
"description": "The file extension for a file.\n\n**Note:** If the item is a folder, this value is null.",
"type": "string"
},
"name": {
"description": "The full name of a file.",
"type": "string"
},
"ownerName": {
"description": "",
"type": "string"
},
"size": {
"description": "The size of the file. The file size limit varies based on the cloud storage provider.",
"type": "string"
},
"supported": {
"description": "When **true,** Docusign supports the file type for upload.",
"type": "string"
},
"type": {
"description": "The type of cloud storage item. Valid values are:\n\n- `file`\n- `folder`",
"type": "string"
},
"uri": {
"description": "The URI for the file or folder.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "externalFile",
"x-ms-summary": "This object contains information about a file or folder in cloud storage."
},
"externalFolder": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/externalDocServiceErrorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"id": {
"description": "A unique ID for the Salesforce object.",
"type": "string"
},
"items": {
"description": "If the tab is a list, this represents the values that are possible for the tab.",
"items": {
"$ref": "#/definitions/externalFile"
},
"type": "array"
},
"name": {
"description": "",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"skyDriveSkipToken": {
"description": "",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "externalFolder",
"x-ms-summary": ""
},
"externalPrimaryAccountRecipientAuthRequirements": {
"description": "",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"idVerification": {
"description": "",
"type": "string"
},
"kba": {
"description": "",
"type": "string"
},
"phone": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "externalPrimaryAccountRecipientAuthRequirements",
"x-ms-summary": ""
},
"favoriteTemplatesContentItem": {
"description": "",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"favoritedDate": {
"description": "Time at which the template was marked as favorite.",
"type": "string"
},
"templateId": {
"description": "The ID of the template.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "favoriteTemplatesContentItem",
"x-ms-summary": ""
},
"favoriteTemplatesInfo": {
"description": "",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"favoriteTemplates": {
"description": "The favorite templates acted upon by the call.",
"items": {
"$ref": "#/definitions/favoriteTemplatesContentItem"
},
"type": "array"
},
"templatesUpdatedCount": {
"description": "The number of templates successfully updated by the call. This property is read-only.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"x-ds-definition-name": "favoriteTemplatesInfo",
"x-ms-summary": ""
},
"featureAvailableMetadata": {
"description": "",
"properties": {
"availabilty": {
"description": "",
"type": "string"
},
"featureName": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "featureAvailableMetadata",
"x-ms-summary": ""
},
"featureSet": {
"description": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for Docusign internal use only.",
"properties": {
"currencyFeatureSetPrices": {
"description": "Reserved for Docusign.",
"items": {
"$ref": "#/definitions/currencyFeatureSetPrice"
},
"type": "array"
},
"envelopeFee": {
"description": "Reserved for Docusign.",
"type": "string"
},
"featureSetId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fixedFee": {
"description": "Reserved for Docusign.",
"type": "string"
},
"is21CFRPart11": {
"description": "Reserved for Docusign.",
"type": "string"
},
"isActive": {
"description": "Reserved for Docusign.",
"type": "string"
},
"isEnabled": {
"description": "When **true,** the feature set is actively enabled as part of the plan.",
"type": "string"
},
"name": {
"description": "Reserved for Docusign.",
"type": "string"
},
"seatFee": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "featureSet",
"x-ms-summary": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for Docusign internal use only."
},
"fileType": {
"description": "",
"properties": {
"fileExtension": {
"description": "",
"type": "string"
},
"mimeType": {
"description": "The mime-type of a file type listed in a fileTypes collection.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "fileType",
"x-ms-summary": ""
},
"fileTypeList": {
"description": "",
"properties": {
"fileTypes": {
"description": "A collection of file types.",
"items": {
"$ref": "#/definitions/fileType"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "fileTypeList",
"x-ms-summary": ""
},
"filter": {
"description": "Use this object to create a filtered view of the items in a folder.",
"properties": {
"actionRequired": {
"description": "When **true,** the current user needs to take action on the item.",
"type": "string"
},
"expires": {
"description": "The number of days a sent envelope remains active before it expires.",
"type": "string"
},
"folderIds": {
"description": "Filters for any combination of folder IDs and folder types. The possible folder types are:\n\n- `awaiting_my_signature`\n- `completed`\n- `draft`\n- `drafts`\n- `expiring_soon`\n- `inbox`\n- `out_for_signature`\n- `recyclebin`\n- `sentitems`\n- `waiting_for_others`",
"type": "string"
},
"fromDateTime": {
"description": "The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days.",
"type": "string"
},
"isTemplate": {
"description": "When **true,** the item is a template.",
"type": "string"
},
"order": {
"description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. ",
"type": "string"
},
"orderBy": {
"description": "The field used to sort the results.\n\nExample: `Created`",
"type": "string"
},
"searchTarget": {
"description": "Reserved for Docusign.",
"type": "string"
},
"searchText": {
"description": "A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject.",
"type": "string"
},
"status": {
"description": "The status of the envelope. By default, all statuses are returned.\n\nFor details, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/).",
"type": "string"
},
"toDateTime": {
"description": "The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "filter",
"x-ms-summary": "Use this object to create a filtered view of the items in a folder."
},
"firstName": {
"description": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "firstName",
"x-ms-summary": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n"
},
"folder": {
"description": "This object contains details about a folder.",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"filter": {
"$ref": "#/definitions/filter",
"description": "An object used to present a filtered view of the items in a folder."
},
"folderId": {
"description": "The ID of the folder.",
"type": "string"
},
"folderItems": {
"description": "A list of envelopes and templates that the folder contains.",
"items": {
"$ref": "#/definitions/folderItem_v2"
},
"type": "array"
},
"folders": {
"description": "A collection of folder objects returned in a response.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"hasAccess": {
"description": "When **true,** the current user has access to the folder.",
"type": "string"
},
"hasSubFolders": {
"description": "When **true,** the folder has subfolders.",
"type": "string"
},
"itemCount": {
"description": "The number of items in the folder.",
"type": "string"
},
"name": {
"description": "The name of the folder.",
"type": "string"
},
"owner": {
"$ref": "#/definitions/userInfo",
"description": "Information about the user who owns the folder."
},
"parentFolderId": {
"description": "The ID of the parent folder, or the special value `root` for the root folder.",
"type": "string"
},
"parentFolderUri": {
"description": "The URI of the parent folder.",
"type": "string"
},
"subFolderCount": {
"description": "The number of subfolders.",
"type": "string"
},
"type": {
"description": "The type of folder. Possible values include:\n\n- `draft`\n- `inbox`\n- `normal` (a system-generated folder)\n- `recyclebin`\n- `sentitems`\n- `custom` (a custom folder created by a user)",
"type": "string"
},
"uri": {
"description": "The URI for the folder.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "folder",
"x-ms-summary": "This object contains details about a folder."
},
"folderItemResponse": {
"description": "Results from a folder item request.",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"folderItems": {
"description": "A list of the envelopes in the specified folder or folders. ",
"items": {
"$ref": "#/definitions/folderItem_v2"
},
"type": "array"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalRows": {
"description": "The total number of items in the result.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "folderItemResponse",
"x-ms-summary": "Results from a folder item request."
},
"folderItem_v2": {
"description": "Information about folder item results.",
"properties": {
"completedDateTime": {
"description": "If the item is an envelope, this is the UTC DateTime when the envelope was completed.",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"envelopeId": {
"description": "If the item is an envelope, this is the ID of the envelope.",
"type": "string"
},
"envelopeUri": {
"description": "If the item is an envelope, this is the URI for retrieving it.",
"type": "string"
},
"expireDateTime": {
"description": "The date and time the envelope is set to expire.",
"type": "string"
},
"folderId": {
"description": "The ID of the folder.",
"type": "string"
},
"folderUri": {
"description": "If the item is a subfolder, this is the URI for retrieving it.",
"type": "string"
},
"is21CFRPart11": {
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
},
"ownerName": {
"description": "The name of the user who owns the folder.",
"type": "string"
},
"recipients": {
"$ref": "#/definitions/EnvelopeRecipients",
"description": "An array of recipient objects that provides details about the recipients of the envelope."
},
"recipientsUri": {
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients.",
"type": "string"
},
"senderCompany": {
"description": "The name of the sender's company.",
"type": "string"
},
"senderEmail": {
"description": "The sender's email address.",
"type": "string"
},
"senderName": {
"description": "The sender's name.",
"type": "string"
},
"senderUserId": {
"description": "The sender's id.",
"type": "string"
},
"sentDateTime": {
"description": "The UTC DateTime when the envelope was sent. This property is read-only.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"subject": {
"description": "The subject of the envelope.",
"type": "string"
},
"templateId": {
"description": "The unique identifier of the template. If this is not provided, Docusign will generate a value. ",
"type": "string"
},
"templateUri": {
"description": "The URI for retrieving the template.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "folderItem_v2",
"x-ms-summary": "Information about folder item results."
},
"folderItemsResponse": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"envelopes": {
"description": "",
"items": {
"$ref": "#/definitions/envelopeSummary"
},
"type": "array"
},
"folders": {
"description": "A list of folder objects.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "folderItemsResponse",
"x-ms-summary": ""
},
"folderSharedItem": {
"description": "",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"folderId": {
"description": "The ID of the folder.",
"type": "string"
},
"name": {
"description": "The name of the folder.",
"type": "string"
},
"owner": {
"$ref": "#/definitions/userInfo",
"description": "Information about the user who owns the folder."
},
"parentFolderId": {
"description": "The ID of the parent folder.",
"type": "string"
},
"parentFolderUri": {
"description": "The URI for the parent folder.",
"type": "string"
},
"shared": {
"description": "Indicates how the folder is shared. Valid values are:\n\n- `not_shared`\n- `shared_to`",
"type": "string"
},
"sharedGroups": {
"description": "A list of groups that share the folder.",
"items": {
"$ref": "#/definitions/memberGroupSharedItem"
},
"type": "array"
},
"sharedUsers": {
"description": "A list of users that share the folder.",
"items": {
"$ref": "#/definitions/userSharedItem"
},
"type": "array"
},
"uri": {
"description": "A URI containing the user ID.",
"type": "string"
},
"user": {
"$ref": "#/definitions/userInfo",
"description": "Information about the user associated with the folder."
}
},
"type": "object",
"x-ds-definition-name": "folderSharedItem",
"x-ms-summary": ""
},
"foldersRequest": {
"description": "Information for a folder request.",
"properties": {
"envelopeIds": {
"description": "An array of envelope ID GUIDs.",
"items": {
"type": "string"
},
"type": "array"
},
"folders": {
"description": "Not used.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"fromFolderId": {
"description": " The ID of the folder that the envelope is being moved from.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "foldersRequest",
"x-ms-summary": "Information for a folder request."
},
"foldersResponse": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"envelopes": {
"description": "",
"items": {
"$ref": "#/definitions/envelopeSummary"
},
"type": "array"
},
"folders": {
"description": "A list of folder objects.",
"items": {
"$ref": "#/definitions/folder"
},
"type": "array"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "foldersResponse",
"x-ms-summary": ""
},
"forgottenPasswordInformation": {
"description": "A complex element that has up to four Question/Answer pairs for forgotten password information.",
"properties": {
"forgottenPasswordAnswer1": {
"description": "The answer to the first forgotten password challenge question.",
"type": "string"
},
"forgottenPasswordAnswer2": {
"description": "The answer to the second forgotten password challenge question.",
"type": "string"
},
"forgottenPasswordAnswer3": {
"description": "The answer to the third forgotten password challenge question.",
"type": "string"
},
"forgottenPasswordAnswer4": {
"description": "The answer to the fourth forgotten password challenge question.",
"type": "string"
},
"forgottenPasswordQuestion1": {
"description": "The first challenge question presented to a user who has forgotten their password.",
"type": "string"
},
"forgottenPasswordQuestion2": {
"description": "The second challenge question presented to a user who has forgotten their password.",
"type": "string"
},
"forgottenPasswordQuestion3": {
"description": "The third challenge question presented to a user who has forgotten their password.",
"type": "string"
},
"forgottenPasswordQuestion4": {
"description": "The fourth challenge question presented to a user who has forgotten their password.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "forgottenPasswordInformation",
"x-ms-summary": "A complex element that has up to four Question/Answer pairs for forgotten password information."
},
"formDataItem": {
"description": "",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"listSelectedValue": {
"description": "The selected value in a list.",
"type": "string"
},
"name": {
"description": "The name of the form field.",
"type": "string"
},
"numericalValue": {
"description": "",
"type": "string"
},
"originalNumericalValue": {
"description": "",
"type": "string"
},
"originalValue": {
"description": "The initial value associated with the form field.",
"type": "string"
},
"value": {
"description": "The current value associated with the form field.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "formDataItem",
"x-ms-summary": ""
},
"formulaTab": {
"description": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the Docusign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the Docusign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"formula": {
"description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the Docusign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n",
"type": "string"
},
"formulaMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata indicating if the sender can edit the `formula` property."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"hidden": {
"description": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true:** The tab is hidden.\n* **false:** The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true:** The tab is displayed as a payment.\n* **false:** The tab is displayed as a regular formula.\n",
"type": "string"
},
"hiddenMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `hidden` property is editable."
},
"isPaymentAmountMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"paymentDetails": {
"$ref": "#/definitions/paymentDetails",
"description": "This property indicates \nthat this formula tab \nis a payment item. \nSee [Requesting Payments Along with Signatures][paymentguide] \nin the Docusign Support Center \nto learn more about payments. \n\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n"
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"roundDecimalPlaces": {
"description": "The number of decimal places to round to.",
"type": "string"
},
"roundDecimalPlacesMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `roundDecimalPlaces` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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 (+35, -2)\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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 (+35, -2)\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "formulaTab",
"x-ms-summary": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the Docusign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the Docusign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n"
},
"fullName": {
"description": "A tab that displays the recipient's full name.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "fullName",
"x-ms-summary": "A tab that displays the recipient's full name.\n"
},
"graphicsContext": {
"description": "",
"properties": {
"fillColor": {
"description": "The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).",
"type": "string"
},
"lineColor": {
"description": "The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).",
"type": "string"
},
"lineWeight": {
"description": "The line weight or thickness to use for the overlay.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "graphicsContext",
"x-ms-summary": ""
},
"group": {
"description": "This object contains information about a group.",
"properties": {
"accessType": {
"description": "",
"type": "string"
},
"dsGroupId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"groupId": {
"description": "The Docusign group ID for the group.\nThis is a read-only property.",
"type": "string"
},
"groupName": {
"description": "The name of the group.",
"type": "string"
},
"groupType": {
"description": "The group type.",
"type": "string"
},
"isManagedByScim": {
"description": "",
"type": "boolean"
},
"lastModifiedOn": {
"description": "",
"type": "string"
},
"permissionProfileId": {
"description": "The ID of the permission profile associated with the group.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.",
"type": "string"
},
"userGroupType": {
"description": "",
"type": "string"
},
"users": {
"description": "A list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/)\n",
"items": {
"$ref": "#/definitions/userInfo"
},
"type": "array"
},
"usersCount": {
"description": "The total number of users in the group.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "group",
"x-ms-summary": "This object contains information about a group."
},
"groupInformation": {
"description": "This object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/).\n",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"groups": {
"description": "A collection group objects containing information about the groups.",
"items": {
"$ref": "#/definitions/group"
},
"type": "array"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "groupInformation",
"x-ms-summary": "This object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/).\n"
},
"groupUserInfo": {
"description": "",
"properties": {
"activationAccessCode": {
"description": "Access code provided to the user to activate the account.",
"type": "string"
},
"email": {
"description": "",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"loginStatus": {
"description": "Boolean value that indicates whether the user is currently logged in or not.",
"type": "string"
},
"sendActivationEmail": {
"description": "This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).",
"type": "string"
},
"uri": {
"description": "A URI containing the user ID.",
"type": "string"
},
"userId": {
"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.",
"type": "string"
},
"userName": {
"description": "The name of the user.",
"type": "string"
},
"userStatus": {
"description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n",
"type": "string"
},
"userType": {
"description": "The type of user, for example `CompanyUser`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "groupUserInfo",
"x-ms-summary": ""
},
"groupUsersResponse": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
},
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/groupUserInfo"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "groupUsersResponse",
"x-ms-summary": ""
},
"idCheckConfiguration": {
"description": "A complex object specifying ID check configuration.",
"properties": {
"authSteps": {
"description": "A list of ID check security steps, each specifying an authorization type.",
"items": {
"$ref": "#/definitions/idCheckSecurityStep"
},
"type": "array"
},
"isDefault": {
"description": "Boolean that specifies whether the signature is the default signature for the user.",
"type": "string"
},
"name": {
"description": "The name of the signature.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "idCheckConfiguration",
"x-ms-summary": "A complex object specifying ID check configuration."
},
"idCheckInformationInput": {
"description": "A complex element that contains input information related to a recipient ID check.",
"properties": {
"addressInformationInput": {
"$ref": "#/definitions/addressInformationInput",
"description": "An object that specifies recipient address information and how it is displayed."
},
"dobInformationInput": {
"$ref": "#/definitions/dobInformationInput",
"description": "An object that specifies recipient date of birth information and how it is displayed."
},
"ssn4InformationInput": {
"$ref": "#/definitions/ssn4InformationInput",
"description": "An object that specifies the last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"$ref": "#/definitions/ssn9InformationInput",
"description": "An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response."
}
},
"type": "object",
"x-ds-definition-name": "idCheckInformationInput",
"x-ms-summary": "A complex element that contains input information related to a recipient ID check."
},
"idCheckSecurityStep": {
"description": "",
"properties": {
"authType": {
"description": "Type of authorization used for the security check.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "idCheckSecurityStep",
"x-ms-summary": ""
},
"idEvidenceResourceToken": {
"description": "",
"properties": {
"proofBaseURI": {
"description": "",
"type": "string"
},
"resourceToken": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "idEvidenceResourceToken",
"x-ms-summary": ""
},
"idEvidenceViewLink": {
"description": "",
"properties": {
"viewLink": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "idEvidenceViewLink",
"x-ms-summary": ""
},
"inPersonSigner": {
"description": "Contains information about an in-person recipient. This is a Docusign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about the fields used\nfor the eNotary feature,\nsee the [EnvelopeRecipients resource][resource].\n\n[resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient\n",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"canSignOffline": {
"description": "When **true,** specifies that the signer can perform the signing ceremony offline.",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"description": "Indicates the number of times that the recipient has been through a signing completion. \n\nIf this number is greater than `0` for a signing group, only the user who previously completed may sign again.",
"type": "string"
},
"creationReason": {
"description": "The reason why the recipient was created (for example, `sender`). This property is read-only.",
"type": "string"
},
"customFields": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"defaultRecipient": {
"description": "When **true,**\nthis is the default recipient for the envelope.\nThis option is used when creating an envelope from a template.\n",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "The signer's email address in an eNotary flow.\n\nUse only when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerEmail` instead.\n",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"excludedDocuments": {
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.",
"items": {
"type": "string"
},
"type": "array"
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"hostEmail": {
"description": "The email address of the signing host.\nThis is the Docusign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n",
"type": "string"
},
"hostEmailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `hostEmail` property is editable."
},
"hostName": {
"description": "The name of the signing host.\nThis is the Docusign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n",
"type": "string"
},
"hostNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `hostName` property is editable."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"handDrawRequired": {
"description": "Reserved for Docusign.",
"type": "string"
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"optional": {
"description": "When **true,** the recipient does not need to complete this tab to complete the signing process.",
"type": "string"
},
"optionalMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `optional` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"scaleValue": {
"description": " Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.",
"type": "string"
},
"scaleValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `scaleValue` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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 (+2, -7)\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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 (+2, -7)\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "initialHere",
"x-ms-summary": "A tab that allows the recipient to initial the document. May\nbe optional.\n"
},
"inlineTemplate": {
"description": "",
"properties": {
"customFields": {
"$ref": "#/definitions/AccountCustomFields",
"description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters."
},
"documents": {
"description": "A complex element that contains details about the documents associated with the envelope.",
"items": {
"$ref": "#/definitions/document"
},
"type": "array"
},
"envelope": {
"$ref": "#/definitions/envelope",
"description": "A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients."
},
"recipients": {
"$ref": "#/definitions/EnvelopeRecipients",
"description": "An array of recipient objects that provides details about the recipients of the envelope."
},
"sequence": {
"description": "Specifies the order in which templates are overlaid.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "inlineTemplate",
"x-ms-summary": ""
},
"integratedConnectUserInfoList": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
},
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/connectUserInfo"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "integratedConnectUserInfoList",
"x-ms-summary": ""
},
"integratedUserInfoList": {
"description": "",
"properties": {
"allUsersSelected": {
"description": "",
"type": "string"
},
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
},
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/userInfo"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "integratedUserInfoList",
"x-ms-summary": ""
},
"intermediary": {
"description": "Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"customFields": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. ",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"excludedDocuments": {
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.",
"items": {
"type": "string"
},
"type": "array"
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The recipient's first name. Maximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "lastName",
"x-ms-summary": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n"
},
"linkedExternalPrimaryAccount": {
"description": "",
"properties": {
"accountName": {
"description": "The name on the account.",
"type": "string"
},
"configurationId": {
"description": "",
"type": "string"
},
"email": {
"description": "",
"type": "string"
},
"exemptMembersOfSameAccountFromAuth": {
"description": "",
"type": "string"
},
"linkId": {
"description": "",
"type": "string"
},
"pdfFieldHandlingOption": {
"description": "",
"type": "string"
},
"pdfFieldHandlingPrefillTabPermission": {
"description": "",
"type": "string"
},
"pdfFieldHandlingStandardInputTabPermission": {
"description": "",
"type": "string"
},
"pdfFieldHandlingStandardTabPermission": {
"description": "",
"type": "string"
},
"recipientAuthRequirements": {
"$ref": "#/definitions/externalPrimaryAccountRecipientAuthRequirements",
"description": ""
},
"status": {
"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 to be sent later.",
"type": "string"
},
"userId": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "linkedExternalPrimaryAccount",
"x-ms-summary": ""
},
"list": {
"description": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/)\nobjects to specify the selectable options.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"listItems": {
"description": "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. \n",
"items": {
"$ref": "#/definitions/listItem"
},
"type": "array"
},
"listSelectedValue": {
"description": "The value in the list that is selected by default.",
"type": "string"
},
"listSelectedValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `listSelectedValue` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "The value to use when the item is selected.",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "list",
"x-ms-summary": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/)\nobjects to specify the selectable options.\n"
},
"listCustomField": {
"description": "This object represents a list custom field from which envelope creators and senders can select custom data.",
"properties": {
"configurationType": {
"description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"fieldId": {
"description": "The ID of the custom field.",
"type": "string"
},
"listItems": {
"description": "An array of strings that represents the options in a list.\n\nMaximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the custom field.",
"type": "string"
},
"required": {
"description": "When **true,** senders are required to select an option from the list before they can send the envelope.",
"type": "string"
},
"show": {
"description": "When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.",
"type": "string"
},
"value": {
"description": "The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "listCustomField",
"x-ms-summary": "This object represents a list custom field from which envelope creators and senders can select custom data."
},
"listItem": {
"description": "One of the selectable items\nin the `listItems` property\nof a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab.",
"properties": {
"selected": {
"description": "When **true,** indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.",
"type": "string"
},
"selectedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `selected` property is editable."
},
"text": {
"description": "Specifies the text that is shown in the dropdown list. ",
"type": "string"
},
"textMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": ""
},
"value": {
"description": "Specifies the value that is used when the list item is selected.",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "listItem",
"x-ms-summary": "One of the selectable items\nin the `listItems` property\nof a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab."
},
"localePolicy": {
"description": "",
"properties": {
"addressFormat": {
"description": "Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`\n",
"type": "string"
},
"addressFormatMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates if the `addressFormat` property is editable."
},
"allowRegion": {
"description": "",
"type": "string"
},
"calendarType": {
"description": "Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`\n",
"type": "string"
},
"calendarTypeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `calendarType` property is editable."
},
"cultureName": {
"description": "The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.",
"type": "string"
},
"cultureNameMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `cultureName` property is editable."
},
"currencyCode": {
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n",
"type": "string"
},
"currencyCodeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `currencyCode` property is editable."
},
"currencyNegativeFormat": {
"description": "Determines how negative currency values\nare displayed.\n\nIn most cases, you should not need to change\nthis value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).\n\nValid values:\n\n- `Default`Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "notarize",
"x-ms-summary": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page."
},
"notary": {
"description": "",
"properties": {
"createdDate": {
"description": "The creation date of the account in UTC timedate format.",
"type": "string"
},
"enabled": {
"description": "The date the this object was created.",
"type": "string"
},
"searchable": {
"description": "When **true,** this notary is searchable.",
"type": "string"
},
"userInfo": {
"$ref": "#/definitions/userInformation",
"description": "Information about the user registering to be a notary."
}
},
"type": "object",
"x-ds-definition-name": "notary",
"x-ms-summary": ""
},
"notaryContactDetails": {
"description": "",
"properties": {
"hasDocusignCertificate": {
"description": "",
"type": "string"
},
"jurisdictions": {
"description": "",
"items": {
"$ref": "#/definitions/jurisdictionSummary"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "notaryContactDetails",
"x-ms-summary": ""
},
"notaryHost": {
"description": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"customFields": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "The notary's email address.\n\nMaximum Length: 100 characters.\n",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"hostRecipientId": {
"description": "The host recipient ID.",
"type": "string"
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"scaleValue": {
"description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.",
"type": "string"
},
"scaleValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `scaleValue` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "notarySeal",
"x-ms-summary": "A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/"
},
"notaryWitness": {
"description": "",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"agentCanEditEmail": {
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.",
"type": "string"
},
"agentCanEditName": {
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkRecipientsUri": {
"description": "Reserved for Docusign.",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"canSignOffline": {
"description": "When **true,** specifies that the signer can perform the signing ceremony offline.",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"creationReason": {
"description": "The reason why the item was created.",
"type": "string"
},
"customFields": {
"description": "An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"defaultRecipient": {
"description": "When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.",
"type": "string"
},
"delegatedBy": {
"$ref": "#/definitions/delegationInfo",
"description": ""
},
"delegatedTo": {
"description": "",
"items": {
"$ref": "#/definitions/delegationInfo"
},
"type": "array"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"excludedDocuments": {
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.",
"items": {
"type": "string"
},
"type": "array"
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The user's first name. \nMaximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "**Note:** Note 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",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "note",
"x-ms-summary": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n"
},
"notification": {
"description": "A complex element that specifies the notification settings for the envelope.",
"properties": {
"expirations": {
"$ref": "#/definitions/expirations",
"description": "A complex element that specifies the expiration settings for the envelope."
},
"reminders": {
"$ref": "#/definitions/reminders",
"description": "A complex element that specifies reminder settings for the envelope."
},
"useAccountDefaults": {
"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.**",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "notification",
"x-ms-summary": "A complex element that specifies the notification settings for the envelope."
},
"notificationDefaultSettings": {
"description": "Contains details about the default notification settings for the envelope notifications that senders and signers receive.",
"properties": {
"senderEmailNotifications": {
"$ref": "#/definitions/senderEmailNotifications",
"description": " \nAn array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from Docusign. \n\nThe user inherits the default account sender email notification settings when the user is created. The email notifications are:\n\n* envelopeComplete\n* changedSigner \n* senderEnvelopeDeclined \n* withdrawnConsent \n* recipientViewed \n* deliveryFailed \n "
},
"signerEmailNotifications": {
"$ref": "#/definitions/signerEmailNotifications",
"description": "An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created.\n"
}
},
"type": "object",
"x-ds-definition-name": "notificationDefaultSettings",
"x-ms-summary": "Contains details about the default notification settings for the envelope notifications that senders and signers receive."
},
"notificationDefaults": {
"description": "",
"properties": {
"apiEmailNotifications": {
"$ref": "#/definitions/notificationDefaultSettings",
"description": "The default notification settings for envelopes sent by using the console."
},
"emailNotifications": {
"$ref": "#/definitions/notificationDefaultSettings",
"description": "The default notification settings for envelopes sent by using the API."
}
},
"type": "object",
"x-ds-definition-name": "notificationDefaults",
"x-ms-summary": ""
},
"number": {
"description": "Number tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\nSee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)\nto learn more about this tab type.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"formula": {
"description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the Docusign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n",
"type": "string"
},
"formulaMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata indicating if the sender can edit the `formula` property."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "number",
"x-ms-summary": "Number tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\nSee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)\nto learn more about this tab type.\n"
},
"numerical": {
"description": "Numerical tabs provide robust display and validation features,\nincluding formatting for different regions and currencies,\nand minimum and maximum value validation.\nSee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)\nto learn more about this tab type.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"description": "The Docusign-generated custom tab ID for the custom tab to be applied.\nThis can only be used when adding new tabs for a recipient.\nWhen used, the new tab inherits all the custom tab properties.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This ID must refer to an existing document.\n",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"maxNumericalValue": {
"description": "The maximum value that the numerical tab can take on.\nThe largest value allowed, and the default if not specified, is\n`999999999.99`",
"type": "string"
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"minNumericalValue": {
"description": "The minimum value that the numerical tab can take on.\nThe smallest value allowed, and the default if not specified, is\n`-999999999.99`",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"numericalValue": {
"description": "The raw numerical value of the tab.\n\nFor example,\nif the locale policy is `en-US`\nand the `numericalValue` is `-1234.56`,\nthe `value` property will contain the string\n`\"($ 1,234.56)\"`.\n",
"type": "string"
},
"originalNumericalValue": {
"description": "The original value of the tab.",
"type": "string"
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this tab is shared.\n",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationType": {
"description": "Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`\n",
"type": "string"
},
"value": {
"description": "The `numericalValue` of the tab\ndisplayed according to its locale policy.\n\nFor example,\nif the locale policy is `en-US`\nand the `numericalValue` is `-1234.56`,\nthis property will contain the string\n`\"($ 1,234.56)\"`.\n\n",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "numerical",
"x-ms-summary": "Numerical tabs provide robust display and validation features,\nincluding formatting for different regions and currencies,\nand minimum and maximum value validation.\nSee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)\nto learn more about this tab type.\n"
},
"oauthAccess": {
"description": "",
"properties": {
"access_token": {
"description": "Access token information.",
"type": "string"
},
"data": {
"description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
},
"expires_in": {
"description": "",
"type": "string"
},
"refresh_token": {
"description": "",
"type": "string"
},
"scope": {
"description": "Must be set to \"api\".",
"type": "string"
},
"token_type": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "oauthAccess",
"x-ms-summary": ""
},
"offlineAttributes": {
"description": "Reserved for Docusign.",
"properties": {
"accountEsignId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"deviceModel": {
"description": "Reserved for Docusign.",
"type": "string"
},
"deviceName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"gpsLatitude": {
"description": "Reserved for Docusign.",
"type": "string"
},
"gpsLongitude": {
"description": "Reserved for Docusign.",
"type": "string"
},
"offlineSigningHash": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "offlineAttributes",
"x-ms-summary": "Reserved for Docusign."
},
"page": {
"description": "Description of a page of a document.",
"properties": {
"dpi": {
"description": "The number of dots per inch used for the page image.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "If an error occurs, this property describes the error."
},
"height": {
"description": "The height of the page in pixels.\nMust be an integer.",
"type": "string"
},
"imageBytes": {
"description": "The number of image bytes.",
"type": "string"
},
"mimeType": {
"description": "The MIME type.",
"type": "string"
},
"pageId": {
"description": "The ID of the page.",
"type": "string"
},
"sequence": {
"description": "The sequence of the page in the document, or page number.",
"type": "string"
},
"width": {
"description": "The width of the page in pixels.\nMust be an integer.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "page",
"x-ms-summary": "Description of a page of a document."
},
"pageImages": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"pages": {
"description": "An array of page objects.",
"items": {
"$ref": "#/definitions/page"
},
"type": "array"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "pageImages",
"x-ms-summary": ""
},
"pageRequest": {
"description": "",
"properties": {
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
},
"rotate": {
"description": "Sets the direction the page image is rotated. The possible settings are: left or right",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "pageRequest",
"x-ms-summary": ""
},
"paletteItemSettings": {
"description": "",
"properties": {
"show": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "paletteItemSettings",
"x-ms-summary": ""
},
"paletteSettings": {
"description": "Reserved for Docusign.",
"properties": {
"annotations": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
},
"custom": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
},
"merge": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
},
"notary": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
},
"seals": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
},
"smartContracts": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
},
"smartSections": {
"$ref": "#/definitions/paletteItemSettings",
"description": "Reserved for Docusign."
}
},
"type": "object",
"x-ds-definition-name": "paletteSettings",
"x-ms-summary": "Reserved for Docusign."
},
"participant": {
"description": "",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"customFields": {
"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 string can be a maximum of 100 characters.\n",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The user's first name. \nMaximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "phoneNumber",
"x-ms-summary": "A Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/"
},
"planInformation": {
"description": "An object used to identify the features and attributes of the account being created.",
"properties": {
"addOns": {
"description": "Reserved for Docusign.",
"items": {
"$ref": "#/definitions/addOn"
},
"type": "array"
},
"currencyCode": {
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.",
"type": "string"
},
"freeTrialDaysOverride": {
"description": "Reserved for Docusign.",
"type": "string"
},
"planFeatureSets": {
"description": "Reserved for Docusign.",
"items": {
"$ref": "#/definitions/featureSet"
},
"type": "array"
},
"planId": {
"description": "Docusign's ID for the account plan.",
"type": "string"
},
"recipientDomains": {
"description": "",
"items": {
"$ref": "#/definitions/recipientDomain"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "planInformation",
"x-ms-summary": "An object used to identify the features and attributes of the account being created."
},
"polyLine": {
"description": "",
"properties": {
"x1": {
"description": "",
"type": "string"
},
"x2": {
"description": "",
"type": "string"
},
"y1": {
"description": "",
"type": "string"
},
"y2": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "polyLine",
"x-ms-summary": ""
},
"polyLineOverlay": {
"description": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"graphicsContext": {
"$ref": "#/definitions/graphicsContext",
"description": "Contains details about the style used for the strike through graphic."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"overlayType": {
"description": "The type of overlay to use. The API currently supports only the `outline` overlay type.",
"type": "string"
},
"overlayTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `overlayType` property is editable.\n"
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"polyLines": {
"description": "An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines.",
"items": {
"$ref": "#/definitions/polyLine"
},
"type": "array"
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"shared": {
"description": "When **true,** indicates that the tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "polyLineOverlay",
"x-ms-summary": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates."
},
"powerForm": {
"description": "Contains details about a PowerForm.",
"properties": {
"createdBy": {
"description": "The ID of the user who created the PowerForm.",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"emailBody": {
"description": "The body of the email message sent to the recipients. \n\nMaximum length: 10000 characters.",
"type": "string"
},
"emailSubject": {
"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",
"type": "string"
},
"envelopes": {
"description": "",
"items": {
"$ref": "#/definitions/envelope"
},
"type": "array"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"instructions": {
"description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters.",
"type": "string"
},
"isActive": {
"description": "When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\nWhen **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.\n",
"type": "string"
},
"lastUsed": {
"description": "The UTC DateTime when the PowerForm was last used.",
"type": "string"
},
"limitUseInterval": {
"description": "The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property.",
"type": "string"
},
"limitUseIntervalEnabled": {
"description": "When **true,** the `limitUseInterval` is enabled.",
"type": "string"
},
"limitUseIntervalUnits": {
"description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n",
"type": "string"
},
"maxUseEnabled": {
"description": "When **true,** you can set a maximum number of uses for the PowerForm.",
"type": "string"
},
"name": {
"description": "The name of the PowerForm.",
"type": "string"
},
"powerFormId": {
"description": "The ID of the PowerForm.",
"type": "string"
},
"powerFormUrl": {
"description": "The URL for the PowerForm.",
"type": "string"
},
"recipients": {
"description": "An array of recipient objects that provides details about the recipients of the envelope.",
"items": {
"$ref": "#/definitions/powerFormRecipient"
},
"type": "array"
},
"senderName": {
"description": "The sender's name.",
"type": "string"
},
"senderUserId": {
"description": "The ID of the sender.",
"type": "string"
},
"signingMode": {
"description": "The signing mode to use. Valid values are:\n \n- `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. \n- `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check). \n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.",
"type": "string"
},
"templateId": {
"description": "The ID of the template used to create the PowerForm.",
"type": "string"
},
"templateName": {
"description": "The name of the template used to create the PowerForm.",
"type": "string"
},
"timesUsed": {
"description": "The number of times the PowerForm has been used. ",
"type": "string"
},
"uri": {
"description": "The URI for the PowerForm.",
"type": "string"
},
"usesRemaining": {
"description": "The number of times the PowerForm can still be used.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "powerForm",
"x-ms-summary": "Contains details about a PowerForm."
},
"powerFormFormDataEnvelope": {
"description": "",
"properties": {
"envelopeId": {
"description": "The envelope ID of the envelope status that failed to post.",
"type": "string"
},
"recipients": {
"description": "An array of recipient objects that provides details about the recipients of the envelope.",
"items": {
"$ref": "#/definitions/powerFormFormDataRecipient"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "powerFormFormDataEnvelope",
"x-ms-summary": ""
},
"powerFormFormDataRecipient": {
"description": "",
"properties": {
"email": {
"description": "",
"type": "string"
},
"formData": {
"description": "",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "powerFormFormDataRecipient",
"x-ms-summary": ""
},
"powerFormRecipient": {
"description": "**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.",
"properties": {
"accessCode": {
"description": "(Optional) The access code that the recipient must enter to access the PowerForm.\n\nMaximum Length: 50 characters. The code must also 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.",
"type": "string"
},
"accessCodeLocked": {
"description": "When **true,** the `accessCode` property is locked and cannot be edited.",
"type": "string"
},
"accessCodeRequired": {
"description": "When **true,** the recipient must enter the `accessCode` to access the PowerForm.",
"type": "string"
},
"email": {
"description": "The email address of the recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank.",
"type": "string"
},
"emailLocked": {
"description": "When **true,** the recipient's email address is locked and cannot be edited.",
"type": "string"
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckRequired": {
"description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope. \n- `never`: Authentication checks are not performed on any envelopes. \n- `optional:` Authentication is configurable per envelope.",
"type": "string"
},
"name": {
"description": "The name of the PowerForm recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank.",
"type": "string"
},
"recipientType": {
"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.",
"type": "string"
},
"roleName": {
"description": "The role associated with the recipient (for example, `Member`).\n\nThis property is required when you are working with template recipients and PowerForm recipients.",
"type": "string"
},
"routingOrder": {
"description": "Specifies the routing order of the recipient in the envelope. ",
"type": "string"
},
"templateRequiresIdLookup": {
"description": "When **true,** the template used to create the PowerForm requires ID lookup for the recipient.",
"type": "string"
},
"userNameLocked": {
"description": "When **true,** the `userName` property for the recipient is locked and cannot be edited.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "powerFormRecipient",
"x-ms-summary": "**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`."
},
"powerFormSendersResponse": {
"description": "This object includes information about the users who have sent PowerForms.",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"format": "int32",
"type": "integer"
},
"nextUri": {
"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. ",
"type": "string"
},
"powerFormSenders": {
"description": "An array of `userInfo` objects containing information about users who have sent PowerForms.",
"items": {
"$ref": "#/definitions/userInfo"
},
"type": "array"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"format": "int32",
"type": "integer"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"format": "int32",
"type": "integer"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"x-ds-definition-name": "powerFormSendersResponse",
"x-ms-summary": "This object includes information about the users who have sent PowerForms."
},
"powerFormsFormDataResponse": {
"description": "",
"properties": {
"envelopes": {
"description": "",
"items": {
"$ref": "#/definitions/powerFormFormDataEnvelope"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "powerFormsFormDataResponse",
"x-ms-summary": ""
},
"powerFormsRequest": {
"description": "",
"properties": {
"powerForms": {
"description": "An array of PowerForm objects.",
"items": {
"$ref": "#/definitions/powerForm"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "powerFormsRequest",
"x-ms-summary": ""
},
"powerFormsResponse": {
"description": "A list of PowerForms.",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"format": "int32",
"type": "integer"
},
"nextUri": {
"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. ",
"type": "string"
},
"powerForms": {
"description": "An array of PowerForm objects.",
"items": {
"$ref": "#/definitions/powerForm"
},
"type": "array"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"format": "int32",
"type": "integer"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"format": "int32",
"type": "integer"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"x-ds-definition-name": "powerFormsResponse",
"x-ms-summary": "A list of PowerForms."
},
"prefillFormData": {
"description": "",
"properties": {
"formData": {
"description": "",
"items": {
"$ref": "#/definitions/formDataItem"
},
"type": "array"
},
"senderEmail": {
"description": "The sender's email address.",
"type": "string"
},
"senderName": {
"description": "The sender's name.",
"type": "string"
},
"senderUserId": {
"description": "The ID of the sender.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "prefillFormData",
"x-ms-summary": ""
},
"prefillTabs": {
"description": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields",
"properties": {
"checkboxTabs": {
"description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/checkbox"
},
"type": "array"
},
"dateTabs": {
"description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/date"
},
"type": "array"
},
"emailTabs": {
"description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/email"
},
"type": "array"
},
"numberTabs": {
"description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/number"
},
"type": "array"
},
"radioGroupTabs": {
"description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/radioGroup"
},
"type": "array"
},
"senderCompanyTabs": {
"description": "",
"items": {
"$ref": "#/definitions/senderCompany"
},
"type": "array"
},
"senderNameTabs": {
"description": "",
"items": {
"$ref": "#/definitions/senderName"
},
"type": "array"
},
"ssnTabs": {
"description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/ssn"
},
"type": "array"
},
"tabGroups": {
"description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n",
"items": {
"$ref": "#/definitions/tabGroup"
},
"type": "array"
},
"textTabs": {
"description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/text"
},
"type": "array"
},
"zipTabs": {
"description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/zip"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "prefillTabs",
"x-ms-summary": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields"
},
"propertyMetadata": {
"description": "Metadata about a property.",
"properties": {
"options": {
"description": "An array of option strings supported by this setting.",
"items": {
"type": "string"
},
"type": "array"
},
"rights": {
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "propertyMetadata",
"x-ms-summary": "Metadata about a property."
},
"province": {
"description": "",
"properties": {
"isoCode": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "province",
"x-ms-summary": ""
},
"provisioningInformation": {
"description": "",
"properties": {
"defaultConnectionId": {
"description": "",
"type": "string"
},
"defaultPlanId": {
"description": "",
"type": "string"
},
"distributorCode": {
"description": "The code that identifies the billing plan groups and plans for the new account.",
"type": "string"
},
"distributorPassword": {
"description": "The password for the `distributorCode`.",
"type": "string"
},
"passwordRuleText": {
"description": "",
"type": "string"
},
"planPromotionText": {
"description": "",
"type": "string"
},
"purchaseOrderOrPromAllowed": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "provisioningInformation",
"x-ms-summary": ""
},
"purchasedEnvelopesInformation": {
"description": "",
"properties": {
"amount": {
"description": "The total amount of the purchase.",
"type": "string"
},
"appName": {
"description": "The AppName of the client application.",
"type": "string"
},
"currencyCode": {
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase.\n",
"type": "string"
},
"platform": {
"description": "The Platform of the client application",
"type": "string"
},
"productId": {
"description": "The Product ID from the AppStore.",
"type": "string"
},
"quantity": {
"description": "The quantity of envelopes to add to the account.",
"type": "string"
},
"receiptData": {
"description": "The encrypted Base64 encoded receipt data.",
"type": "string"
},
"storeName": {
"description": "The name of the AppStore.",
"type": "string"
},
"transactionId": {
"description": "Specifies the Transaction ID from the AppStore.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "purchasedEnvelopesInformation",
"x-ms-summary": ""
},
"radio": {
"description": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.\n",
"properties": {
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"selected": {
"description": "When **true,** the radio button is selected.",
"type": "string"
},
"selectedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `selected` property is editable."
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "radio",
"x-ms-summary": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.\n"
},
"radioGroup": {
"description": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n",
"properties": {
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"groupName": {
"description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"type": "string"
},
"groupNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `groupName` property is editable."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"radios": {
"description": "Specifies the locations and status for radio buttons that are grouped together.",
"items": {
"$ref": "#/definitions/radio"
},
"type": "array"
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"source": {
"description": "",
"type": "string"
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"tooltipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tooltip` property is editable.\n"
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "radioGroup",
"x-ms-summary": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n"
},
"recipientAdditionalNotification": {
"description": "Describes an additional notification method.",
"properties": {
"phoneNumber": {
"$ref": "#/definitions/recipientPhoneNumber",
"description": "The phone number to receive the additional notifcation."
},
"secondaryDeliveryMethod": {
"description": "The secondary 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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"secondaryDeliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata about the delivery method."
},
"secondaryDeliveryStatus": {
"description": "The status of the delivery. This property is read-only.\n\nOne of:\n\n- `autoresponded`\n- `optedout`\n- `limitreached`\n",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientAdditionalNotification",
"x-ms-summary": "Describes an additional notification method."
},
"recipientAttachment": {
"description": "",
"properties": {
"attachmentId": {
"description": "The unique identifier for the attachment.",
"type": "string"
},
"attachmentType": {
"description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`",
"type": "string"
},
"data": {
"description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.",
"type": "string"
},
"label": {
"description": "An optional label for the attachment.",
"type": "string"
},
"name": {
"description": "The name of the attachment.",
"type": "string"
},
"remoteUrl": {
"description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientAttachment",
"x-ms-summary": ""
},
"recipientDomain": {
"description": "",
"properties": {
"active": {
"description": "",
"type": "string"
},
"domainCode": {
"description": "",
"type": "string"
},
"domainName": {
"description": "",
"type": "string"
},
"recipientDomainId": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientDomain",
"x-ms-summary": ""
},
"recipientEmailNotification": {
"description": "Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.\n",
"properties": {
"emailBody": {
"description": "The body of the email message.",
"type": "string"
},
"emailBodyMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `emailBody` property can be edited."
},
"emailSubject": {
"description": "The subject line for the email notification.",
"type": "string"
},
"emailSubjectMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `emailSubject` property can be edited."
},
"supportedLanguage": {
"description": "The language to use for the standard email format and signing view for a recipient.\n\nFor example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** This setting affects only Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nTo retrieve the possible values, use the [Accounts::listSupportedLanguages][ListLang] method.\n\n[ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/\n",
"type": "string"
},
"supportedLanguageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `supportedLanguage` property can be edited."
}
},
"type": "object",
"x-ds-definition-name": "recipientEmailNotification",
"x-ms-summary": "Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.\n"
},
"recipientEvent": {
"description": "",
"properties": {
"includeDocuments": {
"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.",
"type": "string"
},
"recipientEventStatusCode": {
"description": "Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientEvent",
"x-ms-summary": ""
},
"recipientFormData": {
"description": "",
"properties": {
"DeclinedTime": {
"description": "The date and time the recipient declined the envelope.",
"type": "string"
},
"DeliveredTime": {
"description": "The date and time the recipient viewed the documents in the envelope in the Docusign signing UI.",
"type": "string"
},
"SentTime": {
"description": "The date and time the envelope was sent to the recipient.",
"type": "string"
},
"SignedTime": {
"description": "The date and time the recipient signed the documents.",
"type": "string"
},
"email": {
"description": "The recipient's email address.",
"type": "string"
},
"formData": {
"description": "An array of form data objects.",
"items": {
"$ref": "#/definitions/formDataItem"
},
"type": "array"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientFormData",
"x-ms-summary": ""
},
"recipientGroup": {
"description": "Describes a group of recipients.",
"properties": {
"groupMessage": {
"description": "The group message, typically a description of the group.",
"type": "string"
},
"groupName": {
"description": "The name of the group.",
"type": "string"
},
"recipients": {
"description": "An array of recipient objects that provides details about the recipients of the envelope.",
"items": {
"$ref": "#/definitions/recipientOption"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "recipientGroup",
"x-ms-summary": "Describes a group of recipients."
},
"recipientIdentityInputOption": {
"description": "",
"properties": {
"name": {
"description": "",
"type": "string"
},
"phoneNumberList": {
"description": "",
"items": {
"$ref": "#/definitions/recipientIdentityPhoneNumber"
},
"type": "array"
},
"stringValue": {
"description": "",
"type": "string"
},
"valueType": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientIdentityInputOption",
"x-ms-summary": ""
},
"recipientIdentityPhoneNumber": {
"description": "",
"properties": {
"countryCode": {
"description": "The numeric country calling code for the phone number. For example, the country calling code for the US and Canada is 1. For the UK, the country calling code is 44.\n\nDo not include the + symbol.",
"type": "string"
},
"countryCodeLock": {
"description": "",
"type": "string"
},
"countryCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates if the `countryCode` property is editable."
},
"extension": {
"description": "The telephone extension, if any.",
"type": "string"
},
"extensionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates if the `extension` property is editable."
},
"number": {
"description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`.",
"type": "string"
},
"numberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates if the `number` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "recipientIdentityPhoneNumber",
"x-ms-summary": ""
},
"recipientIdentityVerification": {
"description": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/)\nmethod in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.",
"properties": {
"inputOptions": {
"description": "",
"items": {
"$ref": "#/definitions/recipientIdentityInputOption"
},
"type": "array"
},
"workflowId": {
"description": "ID of the Identity Verification worklow used to verify recipients' identity.\n\nThis ID must match one of the [workflowId](/docs/esign-rest-api/reference/accounts/identityverifications/list/) available to your account.",
"type": "string"
},
"workflowIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": ""
},
"workflowLabel": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientIdentityVerification",
"x-ms-summary": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/)\nmethod in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods."
},
"recipientOption": {
"description": "Describes a recipient who is a member of a conditional group.",
"properties": {
"email": {
"description": "The email ID of the agent. This property is required. Maximum length: 100 characters.",
"type": "string"
},
"name": {
"description": "The full legal name of the recipient. Maximum length: 100 characters.",
"type": "string"
},
"recipientLabel": {
"description": "An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/).\n",
"type": "string"
},
"roleName": {
"description": "Specifies the signing group role of the recipient. This property is required.",
"type": "string"
},
"signingGroupId": {
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientOption",
"x-ms-summary": "Describes a recipient who is a member of a conditional group."
},
"recipientPhoneAuthentication": {
"description": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for Docusign.\n* `validateRecipProvidedNumber`: Reserved for Docusign.",
"properties": {
"recipMayProvideNumber": {
"description": "Boolean. When **true,** the recipient can supply a phone number their choice.",
"type": "string"
},
"recipMayProvideNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipMayProvideNumber` property can be edited."
},
"recordVoicePrint": {
"description": "Reserved for Docusign.",
"type": "string"
},
"recordVoicePrintMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"senderProvidedNumbers": {
"description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. ",
"items": {
"type": "string"
},
"type": "array"
},
"senderProvidedNumbersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderProvidedNumbers` property can be edited."
},
"validateRecipProvidedNumber": {
"description": " Reserved for Docusign.",
"type": "string"
},
"validateRecipProvidedNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
}
},
"type": "object",
"x-ds-definition-name": "recipientPhoneAuthentication",
"x-ms-summary": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for Docusign.\n* `validateRecipProvidedNumber`: Reserved for Docusign."
},
"recipientPhoneNumber": {
"description": "Describes the recipient phone number.",
"properties": {
"countryCode": {
"description": "The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`,\n\nDo not include the `+` symbol.",
"type": "string"
},
"countryCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates if the `countryCode` property is editable."
},
"number": {
"description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`.",
"type": "string"
},
"numberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates if the `number` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "recipientPhoneNumber",
"x-ms-summary": "Describes the recipient phone number."
},
"recipientPreviewRequest": {
"description": "This request object contains the information necessary to create a recipient preview.",
"properties": {
"assertionId": {
"description": "A unique identifier of the authentication event executed by the client application.",
"type": "string"
},
"authenticationInstant": {
"description": "A sender-generated value that indicates the date and time that the signer was authenticated.",
"type": "string"
},
"authenticationMethod": {
"description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion.",
"type": "string"
},
"clientURLs": {
"$ref": "#/definitions/recipientTokenClientURLs",
"description": ""
},
"pingFrequency": {
"description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds.",
"type": "string"
},
"pingUrl": {
"description": "The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.",
"type": "string"
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
},
"returnUrl": {
"description": "The URL to which the user will be redirected in an exit scenario. For example, if the link has expired, the user will be redirected to the URL provided here. This value must be an absolute URL.\n\nThis property is required.\n",
"type": "string"
},
"securityDomain": {
"description": "The domain in which the user authenticated.",
"type": "string"
},
"xFrameOptions": {
"description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property.",
"type": "string"
},
"xFrameOptionsAllowFromUrl": {
"description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientPreviewRequest",
"x-ms-summary": "This request object contains the information necessary to create a recipient preview."
},
"recipientProofFile": {
"description": "The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/)",
"properties": {
"hasIdentityAttempts": {
"description": "",
"type": "string"
},
"isInProofFile": {
"description": "Indicates whether a proof file is available for this recipient.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientProofFile",
"x-ms-summary": "The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/)"
},
"recipientRouting": {
"description": "Describes the recipient routing rules.",
"properties": {
"rules": {
"$ref": "#/definitions/recipientRules",
"description": "The recipient routing rules."
}
},
"type": "object",
"x-ds-definition-name": "recipientRouting",
"x-ms-summary": "Describes the recipient routing rules."
},
"recipientRules": {
"description": "",
"properties": {
"conditionalRecipients": {
"description": "",
"items": {
"$ref": "#/definitions/conditionalRecipientRule"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "recipientRules",
"x-ms-summary": ""
},
"recipientSMSAuthentication": {
"description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.",
"properties": {
"senderProvidedNumbers": {
"description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. ",
"items": {
"type": "string"
},
"type": "array"
},
"senderProvidedNumbersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderProvidedNumbers` property can be edited."
}
},
"type": "object",
"x-ds-definition-name": "recipientSMSAuthentication",
"x-ms-summary": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication."
},
"recipientSignatureInformation": {
"description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.",
"properties": {
"fontStyle": {
"description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n",
"type": "string"
},
"signatureInitials": {
"description": "Specifies the user's signature in initials format.",
"type": "string"
},
"signatureName": {
"description": "Specifies the user's signature name.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientSignatureInformation",
"x-ms-summary": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers."
},
"recipientSignatureProvider": {
"description": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).\n",
"properties": {
"sealDocumentsWithTabsOnly": {
"description": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ",
"type": "string"
},
"sealName": {
"description": "Indicates the name of the electronic seal to apply on documents.\n",
"type": "string"
},
"signatureProviderName": {
"description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method.\n\nExample: `universalsignaturepen_default`\n\n",
"type": "string"
},
"signatureProviderNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `signatureProviderName` property is editable.\n"
},
"signatureProviderOptions": {
"$ref": "#/definitions/recipientSignatureProviderOptions",
"description": "Not applicable for this object."
}
},
"type": "object",
"x-ds-definition-name": "recipientSignatureProvider",
"x-ms-summary": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).\n"
},
"recipientSignatureProviderOptions": {
"description": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)",
"properties": {
"cpfNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"cpfNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"oneTimePassword": {
"description": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.",
"type": "string"
},
"oneTimePasswordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `oneTimePassword` property is editable."
},
"signerRole": {
"description": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.",
"type": "string"
},
"signerRoleMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `signerRole` property is editable."
},
"sms": {
"description": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234.",
"type": "string"
},
"smsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `sms` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "recipientSignatureProviderOptions",
"x-ms-summary": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"
},
"recipientTokenClientURLs": {
"description": "",
"properties": {
"onAccessCodeFailed": {
"description": "",
"type": "string"
},
"onCancel": {
"description": "",
"type": "string"
},
"onDecline": {
"description": "",
"type": "string"
},
"onException": {
"description": "",
"type": "string"
},
"onFaxPending": {
"description": "",
"type": "string"
},
"onIdCheckFailed": {
"description": "",
"type": "string"
},
"onSessionTimeout": {
"description": "",
"type": "string"
},
"onSigningComplete": {
"description": "",
"type": "string"
},
"onTTLExpired": {
"description": "",
"type": "string"
},
"onViewingComplete": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientTokenClientURLs",
"x-ms-summary": ""
},
"recipientUpdateResponse": {
"description": "The recipient details that are returned after you update the recipient.",
"properties": {
"combined": {
"description": "When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When **true,** it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"tabs": {
"$ref": "#/definitions/EnvelopeRecipientTabs",
"description": "All of the tabs associated with the recipient."
}
},
"type": "object",
"x-ds-definition-name": "recipientUpdateResponse",
"x-ms-summary": "The recipient details that are returned after you update the recipient."
},
"recipientViewRequest": {
"description": "The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/)\nand\n[EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods.",
"properties": {
"assertionId": {
"description": "A unique identifier of the authentication event executed by the client application.",
"type": "string"
},
"authenticationInstant": {
"description": "A sender-generated value that indicates the date and time that the signer was authenticated.",
"type": "string"
},
"authenticationMethod": {
"description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion.",
"type": "string"
},
"clientURLs": {
"$ref": "#/definitions/recipientTokenClientURLs",
"description": ""
},
"clientUserId": {
"description": "A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.\n\nUse your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.\n\nMaximum length: 100 characters.",
"type": "string"
},
"displayFormat": {
"description": "",
"type": "string"
},
"email": {
"description": "(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.",
"type": "string"
},
"frameAncestors": {
"description": "An array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/).\n\nIn the demo environment, include your site URL and `https://apps-d.docusign.com`. You can use `http://localhost` for local development and testing. Example: `[\"https://my.site.com\", \"https://apps-d.docusign.com\"]`\n\nIn the production environment, include your site URL and `https://apps.docusign.com`. HTTPS must be enabled on your site. Example: `[\"https://my.site.com\", \"https://apps.docusign.com\"]`\n",
"items": {
"type": "string"
},
"type": "array"
},
"messageOrigins": {
"description": "The originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/).\n\nIn the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`.\n",
"items": {
"type": "string"
},
"type": "array"
},
"pingFrequency": {
"description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds.",
"type": "string"
},
"pingUrl": {
"description": "The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received.",
"type": "string"
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
},
"returnUrl": {
"description": "(Required) The URL to which the user should be redirected\nafter the signing session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\n\nWhen Docusign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n* `access_code_failed`: Recipient used incorrect access code.\n* `cancel`: Recipient canceled the signing operation,\n possibly by using the **Finish Later** option.\n* `decline`: Recipient declined to sign.\n* `exception`: A system error occurred during the signing process.\n* `fax_pending`: Recipient has a fax pending.\n* `id_check_failed`: Recipient failed an ID check.\n* `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option.\n* `signing_complete`: The recipient completed the signing ceremony.\n* `ttl_expired`: The Time To Live token for the envelope has expired.\n After being successfully invoked, these tokens expire\n after five minutes.\n* `viewing_complete`: The recipient completed viewing an envelope\n that is in a read-only/terminal state,\n such as completed, declined, or voided.\n\n",
"type": "string"
},
"securityDomain": {
"description": "The domain in which the user authenticated.",
"type": "string"
},
"userId": {
"description": "The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. \n\nIf `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. \n\nIf a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user.",
"type": "string"
},
"userName": {
"description": "The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.",
"type": "string"
},
"xFrameOptions": {
"description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property.",
"type": "string"
},
"xFrameOptionsAllowFromUrl": {
"description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "recipientViewRequest",
"x-ms-summary": "The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/)\nand\n[EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods."
},
"recipients": {
"description": "Specifies the envelope recipients.",
"properties": {
"agents": {
"description": "A list of agent recipients assigned to the documents.",
"items": {
"$ref": "#/definitions/agent"
},
"type": "array"
},
"authorizedSignatories": {
"description": "",
"items": {
"$ref": "#/definitions/authorizedSignatory"
},
"type": "array"
},
"carbonCopies": {
"description": "A list of carbon copy recipients assigned to the documents.",
"items": {
"$ref": "#/definitions/carbonCopy"
},
"type": "array"
},
"certifiedDeliveries": {
"description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.",
"items": {
"$ref": "#/definitions/certifiedDelivery"
},
"type": "array"
},
"currentRoutingOrder": {
"description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.",
"type": "string"
},
"editors": {
"description": "A list of users who can edit the envelope.",
"items": {
"$ref": "#/definitions/editor"
},
"type": "array"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"inPersonSigners": {
"description": "Specifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.",
"items": {
"$ref": "#/definitions/inPersonSigner"
},
"type": "array"
},
"intermediaries": {
"description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).",
"items": {
"$ref": "#/definitions/intermediary"
},
"type": "array"
},
"notaries": {
"description": "A list of notary recipients on the envelope.",
"items": {
"$ref": "#/definitions/notaryRecipient"
},
"type": "array"
},
"notaryWitnesses": {
"description": "",
"items": {
"$ref": "#/definitions/notaryWitness"
},
"type": "array"
},
"participants": {
"description": "",
"items": {
"$ref": "#/definitions/participant"
},
"type": "array"
},
"recipientCount": {
"description": "The number of recipients in the envelope.",
"type": "string"
},
"seals": {
"description": "A list of electronic seals to apply to documents.",
"items": {
"$ref": "#/definitions/sealSign"
},
"type": "array"
},
"signers": {
"description": "A list of signers on the envelope.",
"items": {
"$ref": "#/definitions/signer"
},
"type": "array"
},
"witnesses": {
"description": "A list of signers who act as witnesses on the envelope.",
"items": {
"$ref": "#/definitions/witness"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "recipients",
"x-ms-summary": "Specifies the envelope recipients."
},
"recipientsUpdateSummary": {
"description": "This is the response that the API returns after you update recipients.",
"properties": {
"recipientUpdateResults": {
"description": "An array of `recipientUpdateResults` objects that contain details about the recipients.",
"items": {
"$ref": "#/definitions/recipientUpdateResponse"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "recipientsUpdateSummary",
"x-ms-summary": "This is the response that the API returns after you update recipients."
},
"referralInformation": {
"description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.",
"properties": {
"advertisementId": {
"description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.\n",
"type": "string"
},
"enableSupport": {
"description": "When **true,** customer support is provided as part of the account plan.",
"type": "string"
},
"externalOrgId": {
"description": "An optional external ID for the referral.",
"type": "string"
},
"groupMemberId": {
"description": "",
"type": "string"
},
"idType": {
"description": "",
"type": "string"
},
"includedSeats": {
"description": "The number of seats (users) included in the plan.",
"type": "string"
},
"industry": {
"description": "The name of the industry associated with the referral. \n\nExample: `Accounting`",
"type": "string"
},
"planStartMonth": {
"description": "",
"type": "string"
},
"promoCode": {
"description": "",
"type": "string"
},
"publisherId": {
"description": "",
"type": "string"
},
"referralCode": {
"description": "",
"type": "string"
},
"referrerName": {
"description": "The name of the referrer.",
"type": "string"
},
"saleDiscountAmount": {
"description": "Reserved for Docusign.",
"type": "string"
},
"saleDiscountFixedAmount": {
"description": "Reserved for Docusign.",
"type": "string"
},
"saleDiscountPercent": {
"description": "Reserved for Docusign.",
"type": "string"
},
"saleDiscountPeriods": {
"description": "Reserved for Docusign.",
"type": "string"
},
"saleDiscountSeatPriceOverride": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shopperId": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "referralInformation",
"x-ms-summary": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only."
},
"reminders": {
"description": "A complex element that specifies reminder settings for the envelope.",
"properties": {
"maximumReminderCount": {
"description": "",
"type": "string"
},
"reminderDelay": {
"description": "An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0.",
"type": "string"
},
"reminderEnabled": {
"description": "When **true,** reminders are enabled. The default value is **false.**",
"type": "string"
},
"reminderFrequency": {
"description": "An integer specifying the interval in days between reminder emails. The default value is 0.",
"type": "string"
},
"smartReminderEnabled": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "reminders",
"x-ms-summary": "A complex element that specifies reminder settings for the envelope."
},
"resourceInformation": {
"description": "",
"properties": {
"resources": {
"description": "",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "resourceInformation",
"x-ms-summary": ""
},
"scheduledSending": {
"description": "A complex element that specifies the scheduled sending settings for the envelope.",
"properties": {
"bulkListId": {
"description": "The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.",
"type": "string"
},
"resumeDate": {
"description": "The timestamp of when the envelope is scheduled to be sent in ISO 8601 format.\n\nThis property is read-only.\n",
"type": "string"
},
"rules": {
"description": "User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.",
"items": {
"$ref": "#/definitions/envelopeDelayRule"
},
"type": "array"
},
"status": {
"description": "Status of the scheduled sending job. Valid values:\n\n* `pending`: The envelope has not yet been sent and the scheduled sending delay has not been initiated.\n* `started`: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient.\n* `completed`: The delay has elapsed and the envelope has been sent to the first recipient.\n\nThis property is read-only.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "scheduledSending",
"x-ms-summary": "A complex element that specifies the scheduled sending settings for the envelope."
},
"sealIdentifier": {
"description": "",
"properties": {
"sealDisplayName": {
"description": "The user-friendly display name for a seal.",
"type": "string"
},
"sealName": {
"description": "The name of a seal.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "sealIdentifier",
"x-ms-summary": ""
},
"sealSign": {
"description": "Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nExample:\n\n```json\n\"recipients\": {\n \"seals\": [\n {\n \"recipientId\": \"1\",\n \"routingOrder\" : 1,\n \"recipientSignatureProviders\": [\n {\n \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"\n }\n ]\n }\n ]\n },\n .\n .\n .\n```\nFor more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html).\n",
"properties": {
"accessCode": {
"description": "Not applicable.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Not applicable."
},
"addAccessCodeToEmail": {
"description": "Not applicable.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"clientUserId": {
"description": "Not applicable.",
"type": "string"
},
"completedCount": {
"description": "Not applicable.",
"type": "string"
},
"customFields": {
"description": "Not applicable.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "Not applicable.",
"type": "string"
},
"declinedReason": {
"description": "Not applicable.",
"type": "string"
},
"deliveredDateTime": {
"description": "Not applicable.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"documentVisibility": {
"description": "Not applicable.",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "Not applicable."
},
"embeddedRecipientStartURL": {
"description": "Not applicable.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"description": "Not applicable.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Not applicable."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "Not applicable."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "senderCompany",
"x-ms-summary": ""
},
"senderCompletionInfo": {
"description": "",
"properties": {
"completed": {
"description": "",
"format": "int32",
"type": "string"
},
"completionRate": {
"description": "",
"format": "double",
"type": "string"
},
"expired": {
"description": "",
"format": "int32",
"type": "string"
},
"expiredRate": {
"description": "",
"format": "double",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"senderId": {
"description": "",
"type": "string"
},
"sent": {
"description": "The number of entries with a status of `sent`.",
"format": "int32",
"type": "string"
},
"voided": {
"description": "",
"format": "int32",
"type": "string"
},
"voidedRate": {
"description": "",
"format": "double",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "senderCompletionInfo",
"x-ms-summary": ""
},
"senderEmailNotifications": {
"description": "Contains the settings for the email notifications that senders receive about the envelopes that they send.",
"properties": {
"changedSigner": {
"description": "When **true,** the sender receives an email notification if the signer changes.",
"type": "string"
},
"clickwrapResponsesLimitNotificationEmail": {
"description": "",
"type": "string"
},
"commentsOnlyPrivateAndMention": {
"description": "When **true,** the user receives only comments that mention their own user name.",
"type": "string"
},
"commentsReceiveAll": {
"description": "When **true,** the user receives all comments.",
"type": "string"
},
"deliveryFailed": {
"description": "When **true,** the sender receives an email notification if envelope delivery fails.",
"type": "string"
},
"envelopeComplete": {
"description": "When **true,** the user receives an email notification when the envelope has been completed.",
"type": "string"
},
"offlineSigningFailed": {
"description": "When **true,** the user receives an email notification if offline signing failed.",
"type": "string"
},
"powerformResponsesLimitNotificationEmail": {
"description": "",
"type": "string"
},
"purgeDocuments": {
"description": "When **true,** the user receives an email notification when a document purge occurs.",
"type": "string"
},
"recipientViewed": {
"description": "When **true,** the sender receives notification that a recipient viewed the envelope.",
"type": "string"
},
"senderEnvelopeDeclined": {
"description": "When **true,** the sender receives notification that the envelope was declined.",
"type": "string"
},
"withdrawnConsent": {
"description": "When **true,** the user receives an email notification if consent is withdrawn.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "senderEmailNotifications",
"x-ms-summary": "Contains the settings for the email notifications that senders receive about the envelopes that they send."
},
"senderName": {
"description": "",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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.",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "senderName",
"x-ms-summary": ""
},
"serverTemplate": {
"description": "",
"properties": {
"sequence": {
"description": "Specifies the order in which templates are overlaid.",
"type": "string"
},
"templateId": {
"description": "The unique identifier of the template. If this is not provided, Docusign will generate a value. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "serverTemplate",
"x-ms-summary": ""
},
"serviceInformation": {
"description": "",
"properties": {
"buildBranch": {
"description": "Reserved for Docusign.",
"type": "string"
},
"buildBranchDeployedDateTime": {
"description": "Reserved for Docusign.",
"type": "string"
},
"buildSHA": {
"description": "Reserved for Docusign.",
"type": "string"
},
"buildVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"linkedSites": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"serviceVersions": {
"description": "",
"items": {
"$ref": "#/definitions/serviceVersion"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "serviceInformation",
"x-ms-summary": ""
},
"serviceVersion": {
"description": "",
"properties": {
"version": {
"description": "The version of the rest API.",
"type": "string"
},
"versionUrl": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "serviceVersion",
"x-ms-summary": ""
},
"settingsMetadata": {
"description": "Metadata that indicates whether a property is editable and describes setting-specific options.",
"properties": {
"is21CFRPart11": {
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).",
"type": "string"
},
"options": {
"description": "An array of option strings supported by this setting.",
"items": {
"type": "string"
},
"type": "array"
},
"rights": {
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`",
"type": "string"
},
"uiHint": {
"description": "Reserved for Docusign.",
"type": "string"
},
"uiOrder": {
"description": "Reserved for Docusign.",
"type": "string"
},
"uiType": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "settingsMetadata",
"x-ms-summary": "Metadata that indicates whether a property is editable and describes setting-specific options."
},
"sharedItem": {
"description": "Information about the shared item.",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"shared": {
"description": "How the item is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`",
"type": "string"
},
"user": {
"$ref": "#/definitions/userInfo",
"description": "Information about the user who owns the shared item."
}
},
"type": "object",
"x-ds-definition-name": "sharedItem",
"x-ms-summary": "Information about the shared item."
},
"signHere": {
"description": "A tab that allows the recipient to sign a document. May be\noptional.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"handDrawRequired": {
"description": "Reserved for Docusign.",
"type": "string"
},
"height": {
"description": "Not applicable to Sign Here tab.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"isSealSignTab": {
"description": "When **true,** the tab contains a visual representation for an electronic seal in a document.",
"type": "string"
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.\n",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"optional": {
"description": "When **true,** the recipient does not need to complete this tab to complete the signing process.",
"type": "string"
},
"optionalMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `optional` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"scaleValue": {
"description": "Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size.",
"type": "string"
},
"scaleValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `scaleValue` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"stamp": {
"$ref": "#/definitions/stamp",
"description": ""
},
"stampType": {
"description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null",
"type": "string"
},
"stampTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `stampType` property is editable."
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "Not applicable to Sign Here tab.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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 (+1, -7)\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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 (+1, -7)\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "signHere",
"x-ms-summary": "A tab that allows the recipient to sign a document. May be\noptional.\n"
},
"signatureGroup": {
"description": "",
"properties": {
"groupId": {
"description": "The ID of the group being accessed.",
"type": "string"
},
"groupName": {
"description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"type": "string"
},
"rights": {
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signatureGroup",
"x-ms-summary": ""
},
"signatureGroupDef": {
"description": "",
"properties": {
"groupId": {
"description": "The ID of the group being accessed.",
"type": "string"
},
"rights": {
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signatureGroupDef",
"x-ms-summary": ""
},
"signatureProviderRequiredOption": {
"description": "Contains additional information that a specific signature provider requires.",
"properties": {
"requiredSignatureProviderOptionIds": {
"description": "Reserved for Docusign.",
"items": {
"type": "string"
},
"type": "array"
},
"signerType": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signatureProviderRequiredOption",
"x-ms-summary": "Contains additional information that a specific signature provider requires."
},
"signatureType": {
"description": "This object contains information about the type of signature.",
"properties": {
"isDefault": {
"description": "When **true,** the signature type is the default type.",
"type": "string"
},
"type": {
"description": "The type of signature. Valid values are:\n\n- `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that Docusign uses.\n- `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [Docusign Signature Appliance](/docs/dsa-api/).\n\nFor more information, see [Standards Based Signatures](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signatureType",
"x-ms-summary": "This object contains information about the type of signature."
},
"signatureUser": {
"description": "",
"properties": {
"isDefault": {
"description": "Boolean that specifies whether the signature is the default signature for the user.",
"type": "string"
},
"rights": {
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`",
"type": "string"
},
"userId": {
"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.",
"type": "string"
},
"userName": {
"description": "The name of the user.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signatureUser",
"x-ms-summary": ""
},
"signatureUserDef": {
"description": "",
"properties": {
"isDefault": {
"description": "Boolean that specifies whether the signature is the default signature for the user.",
"type": "string"
},
"rights": {
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`",
"type": "string"
},
"userId": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signatureUserDef",
"x-ms-summary": ""
},
"signer": {
"description": "A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"agentCanEditEmail": {
"description": "Optional element. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.",
"type": "string"
},
"agentCanEditName": {
"description": "Optional. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkRecipientsUri": {
"description": "Reserved for Docusign.",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"canSignOffline": {
"description": "When **true,** specifies that the signer can perform the signing ceremony offline.",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"creationReason": {
"description": "The reason why the item was created.",
"type": "string"
},
"customFields": {
"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. \n\nEach recipient may be assigned a maximum of 3 custom fields, and each customField string can be a maximum of 100 characters.\n",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"defaultRecipient": {
"description": "When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.",
"type": "string"
},
"delegatedBy": {
"$ref": "#/definitions/delegationInfo",
"description": ""
},
"delegatedTo": {
"description": "",
"items": {
"$ref": "#/definitions/delegationInfo"
},
"type": "array"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "The recipient's email address. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters. ",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"excludedDocuments": {
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.",
"items": {
"type": "string"
},
"type": "array"
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The recipient's first name. Maximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"handDrawRequired": {
"description": "Reserved for Docusign.",
"type": "string"
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"optional": {
"description": "When **true,** the recipient does not need to complete this tab to complete the signing process.",
"type": "string"
},
"optionalMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `optional` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"scaleValue": {
"description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.",
"type": "string"
},
"scaleValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `scaleValue` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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 (+0, -24)\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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 (+0, -24)\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "signerAttachment",
"x-ms-summary": "A tab that allows the recipient to attach supporting\ndocuments to an envelope.\n"
},
"signerEmailNotifications": {
"description": "An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created.\n",
"properties": {
"agentNotification": {
"description": "When **true,** the user receives agent notification emails.",
"type": "string"
},
"carbonCopyNotification": {
"description": "When **true,** the user receives notifications of carbon copy deliveries.",
"type": "string"
},
"certifiedDeliveryNotification": {
"description": "When **true,** the user receives notifications of certified deliveries.",
"type": "string"
},
"commentsOnlyPrivateAndMention": {
"description": "When **true,** the user receives only comments that mention their own user name.",
"type": "string"
},
"commentsReceiveAll": {
"description": "When **true,** the user receives all comments.",
"type": "string"
},
"documentMarkupActivation": {
"description": "When **true,** the user receives notification that document markup has been activated.",
"type": "string"
},
"envelopeActivation": {
"description": "When **true,** the user receives notification that the envelope has been activated.",
"type": "string"
},
"envelopeComplete": {
"description": "When **true,** the user receives an email notification when the envelope has been completed.",
"type": "string"
},
"envelopeCorrected": {
"description": "When **true,** the user receives notification that the envelope has been corrected.",
"type": "string"
},
"envelopeDeclined": {
"description": "When **true,** the user receives notification that the envelope has been declined.",
"type": "string"
},
"envelopeVoided": {
"description": "When **true,** the user receives notification that the envelope has been voided.",
"type": "string"
},
"faxReceived": {
"description": "Reserved for Docusign.",
"type": "string"
},
"offlineSigningFailed": {
"description": "When **true,** the user receives an email notification if offline signing failed.",
"type": "string"
},
"purgeDocuments": {
"description": "When **true,** the user receives an email notification when a document purge occurs.",
"type": "string"
},
"reassignedSigner": {
"description": "When **true,** the user receives notification that the envelope has been reassigned.",
"type": "string"
},
"whenSigningGroupMember": {
"description": "When **true,** the user receives notification that he or she is a member of the signing group.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signerEmailNotifications",
"x-ms-summary": "An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created.\n"
},
"signingGroup": {
"description": "Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.",
"properties": {
"created": {
"description": "The UTC DateTime when the signing group was created. This property is read-only.",
"type": "string"
},
"createdBy": {
"description": "The name of the user who created the signing group. This property is read-only.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"groupEmail": {
"description": "The email address for the signing group. You can use a group email address to email all of the group members at the same time.",
"type": "string"
},
"groupName": {
"description": "The name of the group.",
"type": "string"
},
"groupType": {
"description": "The type of the group. The only valid value for this request is `sharedSigningGroup`.",
"type": "string"
},
"modified": {
"description": "The UTC DateTime when the signing group was last modified. This property is read-only.",
"type": "string"
},
"modifiedBy": {
"description": "The user ID (GUID) of the user who last modified this user record. This property is read-only.",
"type": "string"
},
"signingGroupId": {
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n",
"type": "string"
},
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/signingGroupUser"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "signingGroup",
"x-ms-summary": "Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature."
},
"signingGroupInformation": {
"description": "",
"properties": {
"groups": {
"description": "A collection group objects containing information about the groups.",
"items": {
"$ref": "#/definitions/signingGroup"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "signingGroupInformation",
"x-ms-summary": ""
},
"signingGroupUser": {
"description": "",
"properties": {
"email": {
"description": "",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"userName": {
"description": "The name of the group member. \n\nMaximum Length: 100 characters. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "signingGroupUser",
"x-ms-summary": ""
},
"signingGroupUsers": {
"description": "",
"properties": {
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/signingGroupUser"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "signingGroupUsers",
"x-ms-summary": ""
},
"smartContractInformation": {
"description": "",
"properties": {
"code": {
"description": "Reserved for Docusign.",
"type": "string"
},
"uri": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "smartContractInformation",
"x-ms-summary": ""
},
"smartSection": {
"description": "",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"caseSensitive": {
"description": "When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML.",
"type": "boolean"
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"displaySettings": {
"$ref": "#/definitions/smartSectionDisplaySettings",
"description": "This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"endAnchor": {
"description": "Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required.",
"type": "string"
},
"endPosition": {
"$ref": "#/definitions/smartSectionAnchorPosition",
"description": "The last index position in the result set. "
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"overlayType": {
"description": "The type of overlay to draw on the document. The following overlay types are supported:\n\n- `line`\n- `outline`\n",
"type": "string"
},
"overlayTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `overlayType` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"removeEndAnchor": {
"description": "When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.",
"type": "boolean"
},
"removeStartAnchor": {
"description": "When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.",
"type": "boolean"
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"startAnchor": {
"description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required.",
"type": "string"
},
"startPosition": {
"$ref": "#/definitions/smartSectionAnchorPosition",
"description": "The starting index position of the current result set."
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "smartSection",
"x-ms-summary": ""
},
"smartSectionAnchorPosition": {
"description": "",
"properties": {
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"format": "int32",
"type": "integer"
},
"xPosition": {
"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",
"format": "double",
"type": "number"
},
"yPosition": {
"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",
"format": "double",
"type": "number"
}
},
"type": "object",
"x-ds-definition-name": "smartSectionAnchorPosition",
"x-ms-summary": ""
},
"smartSectionCollapsibleDisplaySettings": {
"description": "",
"properties": {
"arrowClosed": {
"description": "Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the closed state.\n\nOne of the following:\n\n- `up`: In the closed state, the disclosure arrow points up.\n- `down`: In the closed state, the disclosure arrow points down.\n- `left`: In the closed state, the disclosure arrow points left.\n- `right`: In the closed state, the disclosure arrow points right.\n",
"type": "string"
},
"arrowColor": {
"description": "A CSS color value (such as `#DCF851`) that indicates the color of the arrow.\n",
"type": "string"
},
"arrowLocation": {
"description": "The location of the arrow relative to the collapsible section's label. Possible values are:\n\n- `right` (default)\n- `left`\n",
"type": "string"
},
"arrowOpen": {
"description": "Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the open state.\n\nOne of the following:\n\n- `up`: In the open state, the disclosure arrow points up.\n- `down`: In the open state, the disclosure arrow points down.\n- `left`: In the open state, the disclosure arrow points left.\n- `right`: In the open state, the disclosure arrow points right.\n",
"type": "string"
},
"arrowSize": {
"description": "Indicates the size of the collapsible arrows. Possible values are:\n\n- `small`\n- `large` (default)\n",
"type": "string"
},
"arrowStyle": {
"description": "The name of the CSS style to be used on collapsible arrow section.\n",
"type": "string"
},
"containerStyle": {
"description": "The name of the CSS style to be used for the collapsible container.\n",
"type": "string"
},
"labelStyle": {
"description": "The name of the CSS style to be used for the collapsible container's label.",
"type": "string"
},
"onlyArrowIsClickable": {
"description": "When **true,** only the arrow is clickable to expand or collapse the section.\nWhen **false** (the default), both the label and the arrow are clickable.\n\nIf no arrow is used, this setting is ignored.\n",
"type": "boolean"
},
"outerLabelAndArrowStyle": {
"description": "The name of the CSS style to be used for the collapsible container's outer label and arrow style.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "smartSectionCollapsibleDisplaySettings",
"x-ms-summary": ""
},
"smartSectionDisplaySettings": {
"description": "These properties define how a Smart Section displays. A Smart Section is a type of display section.",
"properties": {
"cellStyle": {
"description": "Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.",
"type": "string"
},
"collapsibleSettings": {
"$ref": "#/definitions/smartSectionCollapsibleDisplaySettings",
"description": "This object defines the appearance and function of a collapsible section or item."
},
"display": {
"description": "Indicates the display type. Must be one of the following enum values:\n\n- **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page.\n- **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded.\n- **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed.\n- **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions.\n- **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked.\n- **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view.",
"type": "string"
},
"displayLabel": {
"description": "The label to add to this display section in the signing page.\n",
"type": "string"
},
"displayOrder": {
"description": "The position on the page where the display section appears.",
"format": "int32",
"type": "integer"
},
"displayPageNumber": {
"description": "The number of the page on which the display section appears.",
"format": "int32",
"type": "integer"
},
"hideLabelWhenOpened": {
"description": "When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.",
"type": "boolean"
},
"inlineOuterStyle": {
"description": "Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.",
"type": "string"
},
"labelWhenOpened": {
"description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.",
"type": "string"
},
"preLabel": {
"description": "Enables you to add descriptive text that appears before a collapsed section or continue button.",
"type": "string"
},
"scrollToTopWhenOpened": {
"description": "When **true** and the section is expanded,\nthe position of the section-close control\nscrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.\n",
"type": "boolean"
},
"tableStyle": {
"description": "Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "smartSectionDisplaySettings",
"x-ms-summary": "These properties define how a Smart Section displays. A Smart Section is a type of display section."
},
"socialAccountInformation": {
"description": "",
"properties": {
"email": {
"description": "The users email address.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"provider": {
"description": "The social account provider (Facebook, Yahoo, etc.)",
"type": "string"
},
"socialId": {
"description": "The ID provided by the Socal Account.",
"type": "string"
},
"userName": {
"description": "The full user name for the account.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "socialAccountInformation",
"x-ms-summary": ""
},
"socialAuthentication": {
"description": "",
"properties": {
"authentication": {
"description": "Reserved for Docusign.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "socialAuthentication",
"x-ms-summary": ""
},
"ssn": {
"description": "A one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "ssn",
"x-ms-summary": "A one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n"
},
"ssn4InformationInput": {
"description": "",
"properties": {
"displayLevelCode": {
"description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`",
"type": "string"
},
"receiveInResponse": {
"description": "A Boolean value that specifies whether the information must be returned in the response.",
"type": "string"
},
"ssn4": {
"description": "The last four digits of the recipient's Social Security Number (SSN).",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "ssn4InformationInput",
"x-ms-summary": ""
},
"ssn9InformationInput": {
"description": "",
"properties": {
"displayLevelCode": {
"description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`",
"type": "string"
},
"ssn9": {
"description": "The recipient's full Social Security Number (SSN).",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "ssn9InformationInput",
"x-ms-summary": ""
},
"stamp": {
"description": "",
"properties": {
"adoptedDateTime": {
"description": "The UTC date and time when the user adopted the signature.",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"customField": {
"description": "",
"type": "string"
},
"dateStampProperties": {
"$ref": "#/definitions/dateStampProperties",
"description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle."
},
"disallowUserResizeStamp": {
"description": "When **true,** users may not resize the stamp.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"externalID": {
"description": "Optionally specify an external identifier for the user's signature.",
"type": "string"
},
"imageBase64": {
"description": "",
"type": "string"
},
"imageType": {
"description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
},
"phoneticName": {
"description": "The phonetic spelling of the `signatureName`.",
"type": "string"
},
"signatureName": {
"description": "Specifies the user's signature name.",
"type": "string"
},
"stampFormat": {
"description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ",
"type": "string"
},
"stampImageUri": {
"description": "The URI for retrieving the image of the user's stamp.",
"type": "string"
},
"stampSizeMM": {
"description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.",
"type": "string"
},
"status": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "stamp",
"x-ms-summary": ""
},
"supportedLanguages": {
"description": "A list of supported languages.",
"properties": {
"languages": {
"description": "A list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** Setting a language for a recipient affects only the Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nExample:\n\n```\n{\n \"languages\": [\n {\n \"name\": \"Arabic (ar)\",\n \"value\": \"ar\"\n },\n {\n \"name\": \"Bulgarian (bg)\",\n \"value\": \"bg\"\n },\n .\n .\n .\n}\n```",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "supportedLanguages",
"x-ms-summary": "A list of supported languages."
},
"tabAccountSettings": {
"description": "",
"properties": {
"allowTabOrder": {
"description": "When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting.",
"type": "string"
},
"allowTabOrderMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `allowTabOrder` property is editable.\n"
},
"approveDeclineTabsEnabled": {
"description": "When **true,** approve and decline tabs are enabled.",
"type": "string"
},
"approveDeclineTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `approveDeclineTabs` property is editable.\n"
},
"calculatedFieldsEnabled": {
"description": "When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs.",
"type": "string"
},
"calculatedFieldsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `calculatedFields` property is editable.\n"
},
"checkBoxTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `checkBoxTabs` property is editable."
},
"checkboxTabsEnabled": {
"description": "When **true,** checkbox tabs are enabled.",
"type": "string"
},
"dataFieldRegexEnabled": {
"description": "When **true,** regular expressions are enabled for tabs that contain data fields.",
"type": "string"
},
"dataFieldRegexMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `dataFieldRegex` property is editable.\n"
},
"dataFieldSizeEnabled": {
"description": "When **true,** setting character limits for input fields is enabled.",
"type": "string"
},
"dataFieldSizeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n"
},
"drawTabsEnabled": {
"description": "",
"type": "string"
},
"drawTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableTabAgreementDetails": {
"description": "",
"type": "string"
},
"enableTabAgreementDetailsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"firstLastEmailTabsEnabled": {
"description": "Reserved for Docusign.",
"type": "string"
},
"firstLastEmailTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"listTabsEnabled": {
"description": "When **true,** list tabs are enabled.",
"type": "string"
},
"listTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `listTabs` property is editable.\n"
},
"noteTabsEnabled": {
"description": "When **true,** note tabs are enabled.",
"type": "string"
},
"noteTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `noteTabs` property is editable.\n"
},
"numericalTabsEnabled": {
"description": "",
"type": "string"
},
"numericalTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"prefillTabsEnabled": {
"description": "",
"type": "string"
},
"prefillTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"radioTabsEnabled": {
"description": "When **true,** radio button tabs are enabled.",
"type": "string"
},
"radioTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `radioTabs` property is editable.\n"
},
"savingCustomTabsEnabled": {
"description": "When **true,** saving custom tabs is enabled.",
"type": "string"
},
"savingCustomTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `savingCustomTabs` property is editable.\n"
},
"senderToChangeTabAssignmentsEnabled": {
"description": "Reserved for Docusign.",
"type": "string"
},
"senderToChangeTabAssignmentsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"sharedCustomTabsEnabled": {
"description": "When **true,** shared custom tabs are enabled.",
"type": "string"
},
"sharedCustomTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `sharedCustomTabs` property is editable.\n"
},
"tabDataLabelEnabled": {
"description": "When **true,** [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"tabDataLabelMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `tabDataLabel` property is editable.\n"
},
"tabLocationEnabled": {
"description": "Reserved for Docusign.",
"type": "string"
},
"tabLocationMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"tabLockingEnabled": {
"description": "When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"tabLockingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `tabLocking` property is editable.\n"
},
"tabScaleEnabled": {
"description": "Reserved for Docusign.",
"type": "string"
},
"tabScaleMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"tabTextFormattingEnabled": {
"description": "When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"tabTextFormattingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `tabTextFormatting` property is editable.\n"
},
"textTabsEnabled": {
"description": "When **true,** text tabs are enabled.",
"type": "string"
},
"textTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `textTabs` property is editable.\n"
},
"uriTabsEnabled": {
"description": "",
"type": "string"
},
"uriTabsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
}
},
"type": "object",
"x-ds-definition-name": "tabAccountSettings",
"x-ms-summary": ""
},
"tabGroup": {
"description": "",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"groupLabel": {
"description": "A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array.",
"type": "string"
},
"groupLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `groupLabel` property is editable."
},
"groupRule": {
"description": "Specifies how `maximumAllowed` and `minimumRequired`\nare interpreted when selecting tabs in a `tabGroup`.\n\nPossible values are:\n\n- `SelectAtLeast`\n- `SelectAtMost`\n- `SelectExactly`\n- `SelectARange`\n\n",
"type": "string"
},
"groupRuleMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `groupRule` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"maximumAllowed": {
"description": "The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation.",
"type": "string"
},
"maximumAllowedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maximumAllowed` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"minimumRequired": {
"description": "The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation.",
"type": "string"
},
"minimumRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `minimumRequired` property is editable."
},
"pageNumber": {
"description": "Specifies the page number on which the tab is located.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"description": "The ID of the recipient to whom the tab group will be assigned. This value should match the `recipientId` defined in the recipient object.\n",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabScope": {
"description": "The scope of the tab group. Possible values are:\n\n- `document`\n- `envelope` (default)",
"type": "string"
},
"tabScopeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabScope` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "tabGroup",
"x-ms-summary": ""
},
"tabMetadata": {
"description": "",
"properties": {
"anchor": {
"description": "An optional string that is used to auto-match tabs to strings located in the documents of an envelope.",
"type": "string"
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"collaborative": {
"description": "",
"type": "string"
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"createdByDisplayName": {
"description": "The user name of the Docusign user who created this object.",
"type": "string"
},
"createdByUserId": {
"description": "The userId of the Docusign user who created this object.",
"type": "string"
},
"customTabId": {
"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.",
"type": "string"
},
"disableAutoSize": {
"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.",
"type": "string"
},
"editable": {
"description": "When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified.",
"type": "string"
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontSize": {
"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",
"type": "string"
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"includedInEmail": {
"description": "When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.",
"type": "string"
},
"initialValue": {
"description": "The original value of the tab.",
"type": "string"
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"items": {
"description": "If the tab is a list, this represents the values that are possible for the tab.",
"items": {
"type": "string"
},
"type": "array"
},
"lastModified": {
"description": "The UTC DateTime this object was last modified. This is in ISO 8601 format.",
"type": "string"
},
"lastModifiedByDisplayName": {
"description": "The User Name of the Docusign user who last modified this object.",
"type": "string"
},
"lastModifiedByUserId": {
"description": "The userId of the Docusign user who last modified this object.",
"type": "string"
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"maxNumericalValue": {
"description": "",
"type": "string"
},
"maximumLength": {
"description": "The maximum number of entry characters supported by the custom tab.",
"type": "string"
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"minNumericalValue": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"numericalValue": {
"description": "",
"type": "string"
},
"paymentItemCode": {
"description": "If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters.",
"type": "string"
},
"paymentItemDescription": {
"description": "If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters.",
"type": "string"
},
"paymentItemName": {
"description": "If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`",
"type": "string"
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"scaleValue": {
"description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size.",
"type": "string"
},
"selected": {
"description": "When **true,** the radio button is selected.",
"type": "string"
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"signatureProviderId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"stampType": {
"description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null",
"type": "string"
},
"stampTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `stampType` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"type": {
"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`",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationType": {
"description": "Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`\n",
"type": "string"
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "tabMetadata",
"x-ms-summary": ""
},
"tabMetadataList": {
"description": "",
"properties": {
"tabs": {
"description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.",
"items": {
"$ref": "#/definitions/tabMetadata"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "tabMetadataList",
"x-ms-summary": ""
},
"tabs": {
"description": "Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.",
"properties": {
"approveTabs": {
"description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/approve"
},
"type": "array"
},
"checkboxTabs": {
"description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/checkbox"
},
"type": "array"
},
"commentThreadTabs": {
"description": "An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set.",
"items": {
"$ref": "#/definitions/commentThread"
},
"type": "array"
},
"commissionCountyTabs": {
"description": "A list of\n[Commission County tabs][cc].\n\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/",
"items": {
"$ref": "#/definitions/commissionCounty"
},
"type": "array"
},
"commissionExpirationTabs": {
"description": "A list of\n[Commission Expiration tabs][tabref].\n\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/",
"items": {
"$ref": "#/definitions/commissionExpiration"
},
"type": "array"
},
"commissionNumberTabs": {
"description": "A list of\n[Commission Number tabs][tabref].\n\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/",
"items": {
"$ref": "#/definitions/commissionNumber"
},
"type": "array"
},
"commissionStateTabs": {
"description": "A list of\n[Commission State tabs][cc].\n\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient.\n\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/",
"items": {
"$ref": "#/definitions/commissionState"
},
"type": "array"
},
"companyTabs": {
"description": "A list of\n[Company tabs][company].\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n[company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company\n",
"items": {
"$ref": "#/definitions/company"
},
"type": "array"
},
"dateSignedTabs": {
"description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/dateSigned"
},
"type": "array"
},
"dateTabs": {
"description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/date"
},
"type": "array"
},
"declineTabs": {
"description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/decline"
},
"type": "array"
},
"drawTabs": {
"description": "A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document.",
"items": {
"$ref": "#/definitions/draw"
},
"type": "array"
},
"emailAddressTabs": {
"description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/emailAddress"
},
"type": "array"
},
"emailTabs": {
"description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/email"
},
"type": "array"
},
"envelopeIdTabs": {
"description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid\n",
"items": {
"$ref": "#/definitions/envelopeId"
},
"type": "array"
},
"firstNameTabs": {
"description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname\n",
"items": {
"$ref": "#/definitions/firstName"
},
"type": "array"
},
"formulaTabs": {
"description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n[formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/formulaTab"
},
"type": "array"
},
"fullNameTabs": {
"description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/fullName"
},
"type": "array"
},
"initialHereTabs": {
"description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/initialHere"
},
"type": "array"
},
"lastNameTabs": {
"description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/lastName"
},
"type": "array"
},
"listTabs": {
"description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/list"
},
"type": "array"
},
"notarizeTabs": {
"description": "A list of [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page.\n\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/notarize"
},
"type": "array"
},
"notarySealTabs": {
"description": "A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[notary]: /docs/notary-api/",
"items": {
"$ref": "#/definitions/notarySeal"
},
"type": "array"
},
"noteTabs": {
"description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/note"
},
"type": "array"
},
"numberTabs": {
"description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/number"
},
"type": "array"
},
"numericalTabs": {
"description": "A list of numerical tabs.\n\nNumerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. \n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs).",
"items": {
"$ref": "#/definitions/numerical"
},
"type": "array"
},
"phoneNumberTabs": {
"description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/",
"items": {
"$ref": "#/definitions/phoneNumber"
},
"type": "array"
},
"polyLineOverlayTabs": {
"description": "This type of tab enables the recipient to strike through document text. This value can't be set. ",
"items": {
"$ref": "#/definitions/polyLineOverlay"
},
"type": "array"
},
"prefillTabs": {
"$ref": "#/definitions/prefillTabs",
"description": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields"
},
"radioGroupTabs": {
"description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/radioGroup"
},
"type": "array"
},
"signHereTabs": {
"description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/signHere"
},
"type": "array"
},
"signerAttachmentTabs": {
"description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/signerAttachment"
},
"type": "array"
},
"smartSectionTabs": {
"description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account.",
"items": {
"$ref": "#/definitions/smartSection"
},
"type": "array"
},
"ssnTabs": {
"description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/ssn"
},
"type": "array"
},
"tabGroups": {
"description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n",
"items": {
"$ref": "#/definitions/tabGroup"
},
"type": "array"
},
"textTabs": {
"description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/text"
},
"type": "array"
},
"titleTabs": {
"description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title. This value can't be set.\n\n\n[title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/title"
},
"type": "array"
},
"viewTabs": {
"description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set.\n\n[view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/view"
},
"type": "array"
},
"zipTabs": {
"description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n",
"items": {
"$ref": "#/definitions/zip"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "tabs",
"x-ms-summary": "Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients."
},
"templateAutoMatch": {
"description": "",
"properties": {
"autoMatch": {
"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.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"templateId": {
"description": "The ID of the template.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "templateAutoMatch",
"x-ms-summary": ""
},
"templateAutoMatchList": {
"description": "",
"properties": {
"templates": {
"description": "An array of `templateSummary` objects that contain information about templates.",
"items": {
"$ref": "#/definitions/templateAutoMatch"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "templateAutoMatchList",
"x-ms-summary": ""
},
"templateCompletionInfo": {
"description": "",
"properties": {
"completed": {
"description": "",
"format": "int32",
"type": "string"
},
"completionRate": {
"description": "",
"format": "double",
"type": "string"
},
"expired": {
"description": "",
"format": "int32",
"type": "string"
},
"expiredRate": {
"description": "",
"format": "double",
"type": "string"
},
"name": {
"description": "",
"type": "string"
},
"sent": {
"description": "The number of entries with a status of `sent`.",
"format": "int32",
"type": "string"
},
"templateId": {
"description": "The ID of the template.",
"type": "string"
},
"voided": {
"description": "",
"format": "int32",
"type": "string"
},
"voidedRate": {
"description": "",
"format": "double",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "templateCompletionInfo",
"x-ms-summary": ""
},
"templateCompletionRateResponse": {
"description": "",
"properties": {
"bottomSenders": {
"description": "",
"items": {
"$ref": "#/definitions/senderCompletionInfo"
},
"type": "array"
},
"completed": {
"description": "",
"format": "int32",
"type": "string"
},
"completionRate": {
"description": "",
"format": "double",
"type": "string"
},
"expired": {
"description": "",
"format": "int32",
"type": "string"
},
"expiredRate": {
"description": "",
"format": "double",
"type": "string"
},
"sent": {
"description": "The number of entries with a status of `sent`.",
"format": "int32",
"type": "string"
},
"topSenders": {
"description": "",
"items": {
"$ref": "#/definitions/senderCompletionInfo"
},
"type": "array"
},
"voided": {
"description": "",
"format": "int32",
"type": "string"
},
"voidedRate": {
"description": "",
"format": "double",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "templateCompletionRateResponse",
"x-ms-summary": ""
},
"templateCustomFields": {
"description": "",
"properties": {
"listCustomFields": {
"description": "An array of list custom fields.",
"items": {
"$ref": "#/definitions/listCustomField"
},
"type": "array"
},
"textCustomFields": {
"description": "An array of text custom fields.",
"items": {
"$ref": "#/definitions/textCustomField"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "templateCustomFields",
"x-ms-summary": ""
},
"templateDocumentVisibilityList": {
"description": "A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.",
"properties": {
"documentVisibility": {
"description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients.",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "templateDocumentVisibilityList",
"x-ms-summary": "A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients."
},
"templateDocumentsResult": {
"description": "The results of this method.",
"properties": {
"templateDocuments": {
"description": "An array of document objects that contain information about the documents associated with the template.",
"items": {
"$ref": "#/definitions/envelopeDocument"
},
"type": "array"
},
"templateId": {
"description": "The unique identifier of the template. If this is not provided, Docusign will generate a value. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "templateDocumentsResult",
"x-ms-summary": "The results of this method."
},
"templateInformation": {
"description": "",
"properties": {
"templates": {
"description": "An array of `templateSummary` objects that contain information about templates.",
"items": {
"$ref": "#/definitions/templateSummary"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "templateInformation",
"x-ms-summary": ""
},
"templateMatch": {
"description": "",
"properties": {
"documentEndPage": {
"description": "",
"type": "string"
},
"documentStartPage": {
"description": "",
"type": "string"
},
"matchPercentage": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "templateMatch",
"x-ms-summary": ""
},
"templateNotificationRequest": {
"description": "",
"properties": {
"expirations": {
"$ref": "#/definitions/expirations",
"description": "A complex element that specifies the expiration settings for the envelope."
},
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
},
"reminders": {
"$ref": "#/definitions/reminders",
"description": "A complex element that specifies reminder settings for the envelope."
},
"useAccountDefaults": {
"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.**",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "templateNotificationRequest",
"x-ms-summary": ""
},
"templateRecipients": {
"description": "",
"properties": {
"agents": {
"description": "A list of agent recipients assigned to the documents.",
"items": {
"$ref": "#/definitions/agent"
},
"type": "array"
},
"authorizedSignatories": {
"description": "",
"items": {
"$ref": "#/definitions/authorizedSignatory"
},
"type": "array"
},
"carbonCopies": {
"description": "A list of carbon copy recipients assigned to the documents.",
"items": {
"$ref": "#/definitions/carbonCopy"
},
"type": "array"
},
"certifiedDeliveries": {
"description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.",
"items": {
"$ref": "#/definitions/certifiedDelivery"
},
"type": "array"
},
"currentRoutingOrder": {
"description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.",
"type": "string"
},
"editors": {
"description": "A list of users who can edit the envelope.",
"items": {
"$ref": "#/definitions/editor"
},
"type": "array"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"inPersonSigners": {
"description": "Specifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.",
"items": {
"$ref": "#/definitions/inPersonSigner"
},
"type": "array"
},
"intermediaries": {
"description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).",
"items": {
"$ref": "#/definitions/intermediary"
},
"type": "array"
},
"notaries": {
"description": "A list of notary recipients on the envelope.",
"items": {
"$ref": "#/definitions/notaryRecipient"
},
"type": "array"
},
"notaryWitnesses": {
"description": "",
"items": {
"$ref": "#/definitions/notaryWitness"
},
"type": "array"
},
"participants": {
"description": "",
"items": {
"$ref": "#/definitions/participant"
},
"type": "array"
},
"recipientCount": {
"description": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When **true,** the envelope time zone information is included in the message.",
"type": "string"
},
"seals": {
"description": "Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html",
"items": {
"$ref": "#/definitions/sealSign"
},
"type": "array"
},
"signers": {
"description": "A list of signers on the envelope.",
"items": {
"$ref": "#/definitions/signer"
},
"type": "array"
},
"witnesses": {
"description": "A list of signers who act as witnesses on the envelope.",
"items": {
"$ref": "#/definitions/witness"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "templateRecipients",
"x-ms-summary": ""
},
"templateRole": {
"description": "Information about a specific role.",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"defaultRecipient": {
"description": "When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"email": {
"description": "The email address of the person associated with a role name. It is the email address of the person specified in the `name` property.\n\nFor an in-person signer, this is the email address of the host.",
"type": "string"
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"inPersonSignerName": {
"description": "The full legal name of the in-person signer.\n\nMaximum Length: 100 characters.",
"type": "string"
},
"name": {
"description": "Specifies the recipient's name.\n\nFor an in-person signer, this is the name of the host.",
"type": "string"
},
"phoneNumber": {
"$ref": "#/definitions/recipientPhoneNumber",
"description": "Describes the recipient phone number."
},
"recipientSignatureProviders": {
"description": "The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)",
"items": {
"$ref": "#/definitions/recipientSignatureProvider"
},
"type": "array"
},
"roleName": {
"description": "Optional element. Specifies the role name associated with the recipient.Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"formula": {
"description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the Docusign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n",
"type": "string"
},
"formulaMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata indicating if the sender can edit the `formula` property."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "The value of the text tab.\n\nMaximum length: 4000 bytes.",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "text",
"x-ms-summary": "A tab that allows the recipient to enter any type of text.\n"
},
"textCustomField": {
"description": "This object represents a free text custom field where envelope creators and senders can enter custom data.",
"properties": {
"configurationType": {
"description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"fieldId": {
"description": "The ID of the custom field.",
"type": "string"
},
"name": {
"description": "The name of the custom field.",
"type": "string"
},
"required": {
"description": "When **true,** senders are required to enter or select information for the field before they can send the envelope.",
"type": "string"
},
"show": {
"description": "When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope.",
"type": "string"
},
"value": {
"description": "The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "textCustomField",
"x-ms-summary": "This object represents a free text custom field where envelope creators and senders can enter custom data."
},
"title": {
"description": "A tab that displays the recipient's title.\n",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "title",
"x-ms-summary": "A tab that displays the recipient's title.\n"
},
"usageHistory": {
"description": "A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed.",
"properties": {
"lastSentDateTime": {
"description": "The date and time the user last sent an envelope. ",
"type": "string"
},
"lastSignedDateTime": {
"description": "The date and time the user last signed an envelope.",
"type": "string"
},
"sentCount": {
"description": "The number of envelopes the user has sent. ",
"type": "string"
},
"signedCount": {
"description": "The number of envelopes the user has signed. ",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "usageHistory",
"x-ms-summary": "A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed."
},
"userAccountManagementGranularInformation": {
"description": "Describes which account management capabilities a user has.",
"properties": {
"canManageAccountSecuritySettings": {
"description": "**True** if the user can manage account security settings.",
"type": "string"
},
"canManageAccountSecuritySettingsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageAccountSettings": {
"description": "**True** if the user can manage account settings.",
"type": "string"
},
"canManageAccountSettingsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageAdmins": {
"description": "**True** if the user can manage administrators.",
"type": "string"
},
"canManageAdminsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `canManageAdmins` property is editable.\n"
},
"canManageConnect": {
"description": "",
"type": "string"
},
"canManageConnectMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageDocumentRetention": {
"description": "",
"type": "string"
},
"canManageDocumentRetentionMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageEnvelopeTransfer": {
"description": "",
"type": "string"
},
"canManageEnvelopeTransferMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageGroupsButNotUsers": {
"description": "",
"type": "string"
},
"canManageGroupsButNotUsersMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageJointAgreements": {
"description": "",
"type": "string"
},
"canManageJointAgreementsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageReporting": {
"description": "**True** if the user can manage reporting.",
"type": "string"
},
"canManageReportingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageSharing": {
"description": "**True** if the user can manage sharing.",
"type": "string"
},
"canManageSharingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `canManageSharing` property is editable.\n"
},
"canManageSigningGroups": {
"description": "**True** if the user can manage signing groups.",
"type": "string"
},
"canManageSigningGroupsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageStamps": {
"description": "",
"type": "string"
},
"canManageStampsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageUsers": {
"description": "**True** if the user can manage users.",
"type": "string"
},
"canManageUsersMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `canManageUsers` property is editable.\n"
},
"canViewUsers": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAccountManagementGranularInformation",
"x-ms-summary": "Describes which account management capabilities a user has."
},
"userAuthorization": {
"description": "A complex object describing a user authorization.",
"properties": {
"agentUser": {
"$ref": "#/definitions/authorizationUser",
"description": "The user who can act on behalf of the principal user."
},
"authorizationId": {
"description": "The ID of the user authorization.",
"type": "string"
},
"created": {
"description": "The UTC DateTime when the workspace user authorization was created.",
"type": "string"
},
"createdBy": {
"description": "The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`",
"type": "string"
},
"endDate": {
"description": "The UTC DateTime at which the authorization will expire.",
"type": "string"
},
"modified": {
"description": "The UTC DateTime when the workspace user authorization was last updated.",
"type": "string"
},
"modifiedBy": {
"description": "The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`",
"type": "string"
},
"permission": {
"description": "The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/shared-access/) to grant the agent. Valid values:\n* `Send`\n* `Manage`\n* `Sign`\n* `Edit`\n\nThis property is required.",
"type": "string"
},
"principalUser": {
"$ref": "#/definitions/authorizationUser",
"description": "The user for whom the agent user acts."
},
"startDate": {
"description": "The UTC DateTime at which the authorization will start.",
"type": "string"
},
"taskSource": {
"description": "",
"type": "string"
},
"taskType": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorization",
"x-ms-summary": "A complex object describing a user authorization."
},
"userAuthorizationCreateRequest": {
"description": "The request object to create a user authorization.",
"properties": {
"agentUser": {
"$ref": "#/definitions/authorizationUser",
"description": "The user who will be able to act on behalf of the principal user."
},
"endDate": {
"description": "The UTC DateTime to end the authorization. The default value is the max UTC value (`9999-12-31T23:59:59.0000000+00:00`).",
"type": "string"
},
"permission": {
"description": "The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/shared-access/) to grant the agent. Valid values:\n* `Send`\n* `Manage`\n* `Sign`\n* `Edit`\n\nThis property is required.\n",
"type": "string"
},
"startDate": {
"description": "The UTC DateTime to initiate the authorization. The default value is the current date and time.",
"type": "string"
},
"taskSource": {
"description": "",
"type": "string"
},
"taskType": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationCreateRequest",
"x-ms-summary": "The request object to create a user authorization."
},
"userAuthorizationCreateRequestWithId": {
"description": "A user authorizations to create or update.",
"properties": {
"agentUser": {
"$ref": "#/definitions/authorizationUser",
"description": "The agent user. This property is required if you are creating a new authorization."
},
"authorizationId": {
"description": "The ID of the user authorization. This property is required to update an existing authorization.",
"type": "string"
},
"endDate": {
"description": "The UTC DateTime to end the authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`.",
"type": "string"
},
"permission": {
"description": "The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/shared-access/) to grant the agent. Valid values:\n* `Send`\n* `Manage`\n* `Sign`\n* `Edit`\n\nThis property is required.\n",
"type": "string"
},
"startDate": {
"description": "The UTC DateTime to initiate the authorization. The default value is the current date and time.",
"type": "string"
},
"taskSource": {
"description": "",
"type": "string"
},
"taskType": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationCreateRequestWithId",
"x-ms-summary": "A user authorizations to create or update."
},
"userAuthorizationIdWithStatus": {
"description": "",
"properties": {
"authorizationId": {
"description": "",
"type": "string"
},
"errorMessage": {
"description": "",
"type": "string"
},
"success": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationIdWithStatus",
"x-ms-summary": ""
},
"userAuthorizationUpdateRequest": {
"description": "The request object to update a user authorization.",
"properties": {
"endDate": {
"description": "The end date for the user authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`.",
"type": "string"
},
"startDate": {
"description": "The start date for the user authorization. The default value is the current date and time.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationUpdateRequest",
"x-ms-summary": "The request object to update a user authorization."
},
"userAuthorizationWithStatus": {
"description": "",
"properties": {
"authorization": {
"$ref": "#/definitions/userAuthorization",
"description": ""
},
"errorMessage": {
"description": "",
"type": "string"
},
"success": {
"description": "",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationWithStatus",
"x-ms-summary": ""
},
"userAuthorizations": {
"description": "",
"properties": {
"authorizations": {
"description": "",
"items": {
"$ref": "#/definitions/userAuthorization"
},
"type": "array"
},
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizations",
"x-ms-summary": ""
},
"userAuthorizationsDeleteRequest": {
"description": "",
"properties": {
"authorizations": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationsDeleteRequest",
"x-ms-summary": ""
},
"userAuthorizationsDeleteResponse": {
"description": "",
"properties": {
"results": {
"description": "",
"items": {
"$ref": "#/definitions/userAuthorizationIdWithStatus"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationsDeleteResponse",
"x-ms-summary": ""
},
"userAuthorizationsRequest": {
"description": "An object that describes the user authorizations to create or update.\n",
"properties": {
"authorizations": {
"description": "The list of user authorizations to create and/or update.",
"items": {
"$ref": "#/definitions/userAuthorizationCreateRequestWithId"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationsRequest",
"x-ms-summary": "An object that describes the user authorizations to create or update.\n"
},
"userAuthorizationsResponse": {
"description": "",
"properties": {
"results": {
"description": "",
"items": {
"$ref": "#/definitions/userAuthorizationWithStatus"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userAuthorizationsResponse",
"x-ms-summary": ""
},
"userCompletionRateResponse": {
"description": "",
"properties": {
"bottomTemplates": {
"description": "",
"items": {
"$ref": "#/definitions/templateCompletionInfo"
},
"type": "array"
},
"completed": {
"description": "",
"format": "int32",
"type": "string"
},
"completionRate": {
"description": "",
"format": "double",
"type": "string"
},
"expired": {
"description": "",
"format": "int32",
"type": "string"
},
"sent": {
"description": "The number of entries with a status of `sent`.",
"format": "int32",
"type": "string"
},
"topTemplates": {
"description": "",
"items": {
"$ref": "#/definitions/templateCompletionInfo"
},
"type": "array"
},
"voided": {
"description": "",
"format": "int32",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userCompletionRateResponse",
"x-ms-summary": ""
},
"userInfo": {
"description": "",
"properties": {
"accountId": {
"description": "The account ID associated with the envelope.",
"type": "string"
},
"accountName": {
"description": "The name on the account.",
"type": "string"
},
"activationAccessCode": {
"description": "Access code provided to the user to activate the account.",
"type": "string"
},
"email": {
"description": "The user's email address.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"ipAddress": {
"description": "",
"type": "string"
},
"loginStatus": {
"description": "When **true,** indicates that the user is logged in. This is a read-only property.",
"type": "string"
},
"membershipId": {
"description": "The user's membership ID.",
"type": "string"
},
"sendActivationEmail": {
"description": "This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).",
"type": "string"
},
"uri": {
"description": "A URI containing the user ID.",
"type": "string"
},
"userId": {
"description": "The ID of the user to access.",
"type": "string"
},
"userName": {
"description": "The name of the user.",
"type": "string"
},
"userStatus": {
"description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n",
"type": "string"
},
"userType": {
"description": "The type of user, for example `CompanyUser`.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userInfo",
"x-ms-summary": ""
},
"userInfoList": {
"description": "",
"properties": {
"users": {
"description": "An array of `userInfo` objects containing information about the users in the group.",
"items": {
"$ref": "#/definitions/userInfo"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userInfoList",
"x-ms-summary": ""
},
"userInformation": {
"description": "User information.",
"properties": {
"activationAccessCode": {
"description": "Access code provided to the user to activate the account.",
"type": "string"
},
"company": {
"description": "The name of the user's company.",
"type": "string"
},
"connectConfigurations": {
"description": "Object representing the user's custom Connect configuration.",
"items": {
"$ref": "#/definitions/connectUserObject"
},
"type": "array"
},
"countryCode": {
"description": "The two-letter code for the user's country.",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"customSettings": {
"description": "The name/value pair information for the user custom setting.",
"items": {
"$ref": "#/definitions/nameValue"
},
"type": "array"
},
"defaultAccountId": {
"description": "The default account ID associated with the user.",
"type": "string"
},
"email": {
"description": "The user's email address.\n\nThis property cannot be updated via `PUT` requests.",
"type": "string"
},
"enableConnectForUser": {
"description": "Boolean value that specifies whether the user is enabled for updates from Docusign Connect.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"firstName": {
"description": "The user's first name. \nMaximum Length: 50 characters.",
"type": "string"
},
"forgottenPasswordInfo": {
"$ref": "#/definitions/forgottenPasswordInformation",
"description": "A complex element containing up to four Question/Answer pairs for forgotten password information."
},
"groupList": {
"description": "A list of the group information for groups to add the user to.\nUse [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n",
"items": {
"$ref": "#/definitions/group"
},
"type": "array"
},
"hasRemoteNotary": {
"description": "",
"type": "boolean"
},
"homeAddress": {
"$ref": "#/definitions/addressInformation",
"description": "Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. \nMaximum Length: 100 characters."
},
"initialsImageUri": {
"description": "The URI for retrieving the image of the user's initials.",
"type": "string"
},
"isAdmin": {
"description": "When **true,** the user is an administrator.",
"type": "string"
},
"isAlternateAdmin": {
"description": "When **true,** the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.",
"type": "string"
},
"isManagedByScim": {
"description": "",
"type": "string"
},
"isMembershipManagedByScim": {
"description": "",
"type": "string"
},
"isNAREnabled": {
"description": "When **true,** National Association of Realtors (NAR) signature logos are enabled for the user.",
"type": "string"
},
"jobTitle": {
"description": "The user's job title.",
"type": "string"
},
"lastLogin": {
"description": "This property has been deprecated.",
"type": "string"
},
"lastName": {
"description": "The user's last name. \nMaximum Length: 50 characters.",
"type": "string"
},
"licenseStatus": {
"description": "",
"type": "string"
},
"licenseType": {
"description": "",
"type": "string"
},
"loginStatus": {
"description": "Boolean value that indicates whether the user is currently logged in or not.",
"type": "string"
},
"middleName": {
"description": "The user's middle name. \nLimit: 50 characters.",
"type": "string"
},
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
},
"passwordExpiration": {
"description": "If password expiration is enabled, the date-time when the user's password expires.",
"type": "string"
},
"permissionProfileId": {
"description": "The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page.\n",
"type": "string"
},
"permissionProfileName": {
"description": "The name of the account permission profile. \n\nExample: `Account Administrator`",
"type": "string"
},
"profileImageUri": {
"description": "The URL for retrieving the user's profile image.",
"type": "string"
},
"sendActivationEmail": {
"description": "This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).",
"type": "string"
},
"sendActivationOnInvalidLogin": {
"description": "When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated.",
"type": "string"
},
"signatureImageUri": {
"description": "An endpoint URI that you can use to retrieve the user's signature image.",
"type": "string"
},
"subscribe": {
"description": "",
"type": "string"
},
"suffixName": {
"description": "The suffix for the user's name, such as Jr, IV, PhD, etc.\n\nLimit: 50 characters. ",
"type": "string"
},
"title": {
"description": "The title of the user.",
"type": "string"
},
"uri": {
"description": "A URI containing the user ID.",
"type": "string"
},
"userAddedToAccountDateTime": {
"description": "The date and time that the user was added to the account.",
"type": "string"
},
"userId": {
"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.",
"type": "string"
},
"userName": {
"description": "The name of the user.",
"type": "string"
},
"userProfileLastModifiedDate": {
"description": "The date and time that the user's profile was last modified.",
"type": "string"
},
"userSettings": {
"$ref": "#/definitions/userSettingsInformation",
"description": "The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings."
},
"userStatus": {
"description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n",
"type": "string"
},
"userType": {
"description": "The type of user, for example `CompanyUser`.",
"type": "string"
},
"workAddress": {
"$ref": "#/definitions/addressInformation",
"description": ""
}
},
"type": "object",
"x-ds-definition-name": "userInformation",
"x-ms-summary": "User information."
},
"userInformationList": {
"description": "Contains a list of account users.",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
},
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/userInformation"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userInformationList",
"x-ms-summary": "Contains a list of account users."
},
"userPasswordInformation": {
"description": "",
"properties": {
"currentPassword": {
"description": "The user's current password to be changed.",
"type": "string"
},
"email": {
"description": "The user's email address for the associated account.",
"type": "string"
},
"forgottenPasswordInfo": {
"$ref": "#/definitions/forgottenPasswordInformation",
"description": "A complex element containing up to four Question/Answer pairs for forgotten password information."
},
"newPassword": {
"description": "The user's new password.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userPasswordInformation",
"x-ms-summary": ""
},
"userPasswordRules": {
"description": "Contains details about the password rules for a user.",
"properties": {
"passwordRules": {
"$ref": "#/definitions/accountPasswordRules",
"description": "Contains details about the password rules for the user."
},
"userId": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userPasswordRules",
"x-ms-summary": "Contains details about the password rules for a user."
},
"userProfile": {
"description": "",
"properties": {
"address": {
"$ref": "#/definitions/addressInformation",
"description": "The user's address."
},
"authenticationMethods": {
"description": "Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. ",
"items": {
"$ref": "#/definitions/authenticationMethod"
},
"type": "array"
},
"companyName": {
"description": "The name of the user's company.",
"type": "string"
},
"displayOrganizationInfo": {
"description": " When **true,** the user's company and title information display on the ID card. ",
"type": "string"
},
"displayPersonalInfo": {
"description": "When **true,** the user's address and phone number display on the ID card.",
"type": "string"
},
"displayProfile": {
"description": "When **true,** the user's ID card can be viewed from signed documents and envelope history.",
"type": "string"
},
"displayUsageHistory": {
"description": "When **true,** the user's usage information displays on the ID card.",
"type": "string"
},
"profileImageUri": {
"description": "The URL for retrieving the user's profile image.",
"type": "string"
},
"title": {
"description": "The title of the user.",
"type": "string"
},
"usageHistory": {
"$ref": "#/definitions/usageHistory",
"description": "A complex element consisting of: \n\n- `lastSentDateTime`: The date and time the user last sent an envelope. \n- `lastSignedDateTime`: The date and time the user last signed an envelope.\n- `sentCount`: The number of envelopes the user has sent.\n- `signedCount`: The number of envelopes the user has signed. \n"
},
"userDetails": {
"$ref": "#/definitions/userInformation",
"description": ""
},
"userProfileLastModifiedDate": {
"description": "The date and time that the user's profile was last modified.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userProfile",
"x-ms-summary": ""
},
"userSettingsInformation": {
"description": "Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)",
"properties": {
"accountAgreementsAccessType": {
"description": "",
"type": "string"
},
"accountAgreementsAccessTypeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"accountManagementGranular": {
"$ref": "#/definitions/userAccountManagementGranularInformation",
"description": "Describes which account management capabilities a user has."
},
"adminOnly": {
"description": "Reserved for Docusign.",
"type": "string"
},
"adminOnlyMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"allowAccessToAllAccountAgreements": {
"description": "",
"type": "string"
},
"allowAccessToAllAccountAgreementsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"allowAutoTagging": {
"description": "When **true,** the API returns suggested tabs for documents for this user.",
"type": "string"
},
"allowEnvelopeTransferTo": {
"description": "When **true,** this user can participate in envelope transfers on the account.",
"type": "string"
},
"allowEnvelopeTransferToMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"allowEsealRecipients": {
"description": "When **true,** this user can create [electronic seal recipients][eseal].\n\n[eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient",
"type": "string"
},
"allowEsealRecipientsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `allowEsealRecipientsMetadata` property."
},
"allowPowerFormsAdminToAccessAllPowerFormEnvelope": {
"description": "When **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**",
"type": "string"
},
"allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property."
},
"allowRecipientLanguageSelection": {
"description": "When **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.",
"type": "string"
},
"allowRecipientLanguageSelectionMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata for allowRecipientLanguageSelection."
},
"allowSendOnBehalfOf": {
"description": "When **true,** this user can send envelopes \"on behalf of\" other users through the API.",
"type": "string"
},
"allowSendOnBehalfOfMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata for allowSendOnBehalfOf."
},
"allowSupplementalDocuments": {
"description": "When **true,** this user can include supplemental documents.",
"type": "string"
},
"allowSupplementalDocumentsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable."
},
"allowTransactions": {
"description": "",
"type": "string"
},
"allowTransactionsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"allowedDocumentTemplateLibraryAccess": {
"description": "",
"type": "string"
},
"allowedDocumentTemplateLibraryAccessMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"allowedOrchestrationAccess": {
"description": "",
"type": "string"
},
"allowedOrchestrationAccessMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"anchorTagVersionedPlacementEnabled": {
"description": "Reserved for Docusign.\n",
"type": "string"
},
"apiAccountWideAccess": {
"description": "When **true,** indicates that this user can send envelope-specific API requests on the account.",
"type": "string"
},
"apiAccountWideAccessMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata for apiAccountWideAccess."
},
"apiCanExportAC": {
"description": "When **true,** this user can export authoritative copy for the account.",
"type": "string"
},
"apiCanExportACMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `apiCanExportACMetadata` property."
},
"bulkSend": {
"description": "When **true,** this user can use the bulk send feature for the account.",
"type": "string"
},
"bulkSendMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `bulkSend` property is editable.\n"
},
"canBulkUploadAgreements": {
"description": "",
"type": "string"
},
"canBulkUploadAgreementsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canChargeAccount": {
"description": "Reserved for Docusign.",
"type": "string"
},
"canChargeAccountMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"canCreateTransaction": {
"description": "",
"type": "string"
},
"canCreateTransactionMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canDeleteDocumentsInTransaction": {
"description": "",
"type": "string"
},
"canDeleteDocumentsInTransactionMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canDeleteTransaction": {
"description": "",
"type": "string"
},
"canDeleteTransactionMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canEditSharedAddressbook": {
"description": "When true, this user can edit the shared address book for the account.",
"type": "string"
},
"canEditSharedAddressbookMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canEditSharedAddressbookMetadata` property."
},
"canLockEnvelopes": {
"description": "Reserved for Docusign.",
"type": "string"
},
"canLockEnvelopesMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"canManageAccount": {
"description": "When **true,** this user is an administrator for the account.",
"type": "string"
},
"canManageAccountMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canManageAccountMetadata` property."
},
"canManageAgreementParties": {
"description": "",
"type": "string"
},
"canManageAgreementPartiesMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canManageDistributor": {
"description": "Reserved for Docusign.",
"type": "string"
},
"canManageDistributorMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canManageDistributor` property."
},
"canManageTemplates": {
"description": "When **true,** this user can manage templates for the account.",
"type": "string"
},
"canManageTemplatesMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canManageTemplates` property."
},
"canSendAPIRequests": {
"description": "When **true,** this user can send API requests on the account.",
"type": "string"
},
"canSendAPIRequestsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canSendAPIRequests` property."
},
"canSendEnvelope": {
"description": "When **true,** this user can send envelopes on the account.",
"type": "string"
},
"canSendEnvelopeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canSendEnvelope` property."
},
"canSendEnvelopesViaSMS": {
"description": "",
"type": "string"
},
"canSendEnvelopesViaSMSMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"canSignEnvelope": {
"description": "When **true,** this user can sign envelopes.",
"type": "string"
},
"canSignEnvelopeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canSignEnvelope` property."
},
"canUseScratchpad": {
"description": "When **true,** this user can use a scratchpad to edit information.",
"type": "string"
},
"canUseScratchpadMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `canUseScratchpad` property."
},
"canUseSmartContracts": {
"description": "Reserved for Docusign.",
"type": "string"
},
"canUseSmartContractsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"disableDocumentUpload": {
"description": "When **true,** this user is prohibited from uploading documents during sending.",
"type": "string"
},
"disableDocumentUploadMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `disableDocumentUpload` property is editable.\n"
},
"disableOtherActions": {
"description": "When **true,** this user can access the **Other Actions** menu.",
"type": "string"
},
"disableOtherActionsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `disableOtherActions` property is editable.\n"
},
"enableDSPro": {
"description": "Reserved for Docusign.",
"type": "string"
},
"enableDSProMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableDSPro` property is editable.\n"
},
"enableKeyTermsSuggestionsByDocumentType": {
"description": "",
"type": "string"
},
"enableKeyTermsSuggestionsByDocumentTypeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableSequentialSigningAPI": {
"description": "When **true,** the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note:** Only SysAdmin users can change this setting.",
"type": "string"
},
"enableSequentialSigningAPIMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableSequentialSigningAPI` property is editable.\n"
},
"enableSequentialSigningUI": {
"description": "When **true,** the account can define the routing order\nof recipients for envelopes sent by using the Docusign application.\n\n**Note:** Only SysAdmin users can change this setting.\n",
"type": "string"
},
"enableSequentialSigningUIMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableSequentialSigningUI` property is editable.\n"
},
"enableSignOnPaperOverride": {
"description": "When **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note:** Only Admin users can change this setting.",
"type": "string"
},
"enableSignOnPaperOverrideMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableSignOnPaperOverride` property is editable.\n"
},
"enableSignerAttachments": {
"description": "When **true,** this user can use the signing attachments feature.",
"type": "string"
},
"enableSignerAttachmentsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableSignerAttachments` property is editable.\n"
},
"enableTransactionPoint": {
"description": "Reserved for Docusign.",
"type": "string"
},
"enableTransactionPointMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"enableVaulting": {
"description": "When **true,** Vaulting is enabled for the account.",
"type": "string"
},
"enableVaultingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableVaulting` property is editable.\n"
},
"expressSendOnly": {
"description": "When **false,** this user can apply tabs to documents during the sending experience.",
"type": "string"
},
"isManagedByScim": {
"description": "",
"type": "string"
},
"isManagedByScimMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"isMembershipManagedByScim": {
"description": "",
"type": "string"
},
"isMembershipManagedByScimMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"locale": {
"description": "The user's locale code. Valid values are:\n- `zh_CN`\n- `zh_TW`\n- `nl`\n- `en`\n- `fr`\n- `de`\n- `it`\n- `ja`\n- `ko`\n- `pt`\n- `pt_BR`\n- `ru`\n- `es`",
"type": "string"
},
"localeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `locale` property."
},
"localePolicy": {
"$ref": "#/definitions/localePolicy",
"description": "Locale-specific settings."
},
"manageClickwrapsMode": {
"description": "When **true,** this user can create and manage [Clickwraps](/docs/click-api/).",
"type": "string"
},
"manageClickwrapsModeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `manageClickwrapsMode` property."
},
"modifiedBy": {
"description": "The user ID (GUID) of the user who last modified this user record. This property is read-only.",
"type": "string"
},
"modifiedByMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `modifiedBy` property."
},
"modifiedDate": {
"description": "The date on which this user record was last modified.",
"type": "string"
},
"modifiedDateMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `modifiedDate` property."
},
"modifiedPage": {
"description": "Note referencing the page that modified this user record.",
"type": "string"
},
"modifiedPageMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `modifiedPage` property."
},
"newSendUI": {
"description": "Reserved for Docusign.",
"type": "string"
},
"newSendUIMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `newSendUI` property."
},
"powerFormMode": {
"description": "Indicates the Power Form mode setting for the user:\n- `none`\n- `admin`\n- `user`",
"type": "string"
},
"powerFormModeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `powerFormMode` property."
},
"recipientViewedNotification": {
"description": "When **true,** this user receives notifications when envelopes are viewed.",
"type": "string"
},
"recipientViewedNotificationMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `recipientViewedNotification` property."
},
"sealIdentifiers": {
"description": "Information about the seals associated with this user.",
"items": {
"$ref": "#/definitions/sealIdentifier"
},
"type": "array"
},
"selfSignedRecipientEmailDocument": {
"description": "Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\n in the email.\n\n**Note:** Only Admin users can change this setting.\n",
"type": "string"
},
"selfSignedRecipientEmailDocumentMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable.\n"
},
"senderEmailNotifications": {
"$ref": "#/definitions/senderEmailNotifications",
"description": " \nAn array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from Docusign. \n\nThe user inherits the default account sender email notification settings when the user is created. The email notifications are:\n\n* envelopeComplete\n* changedSigner \n* senderEnvelopeDeclined \n* withdrawnConsent \n* recipientViewed \n* deliveryFailed \n "
},
"signerEmailNotifications": {
"$ref": "#/definitions/signerEmailNotifications",
"description": "An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created.\n"
},
"supplementalDocumentIncludeInDownload": {
"description": "When **true,** this user gets supplemental documents when downloading documents.",
"type": "string"
},
"supplementalDocumentsMustAccept": {
"description": "When **true,** this user must accept supplemental documents.",
"type": "string"
},
"supplementalDocumentsMustAcceptMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n"
},
"supplementalDocumentsMustRead": {
"description": "When **true,** this user must both view and accept supplemental documents.",
"type": "string"
},
"supplementalDocumentsMustReadMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.\n"
},
"supplementalDocumentsMustView": {
"description": "When **true,** this user must view supplemental documents.",
"type": "string"
},
"supplementalDocumentsMustViewMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.\n"
},
"templateActiveCreation": {
"description": "When **true,** a new template is created each time the user sends an envelope.",
"type": "string"
},
"templateActiveCreationMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `templateActiveCreation` property."
},
"templateApplyNotify": {
"description": "When **true,** the system notifies this user before applying a matching template.",
"type": "string"
},
"templateApplyNotifyMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `templateApplyNotify` property."
},
"templateAutoMatching": {
"description": "When **true,** the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.",
"type": "string"
},
"templateAutoMatchingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `templateAutoMatching` property."
},
"templateMatchingSensitivity": {
"description": "Percentage used when matching templates.",
"type": "string"
},
"templateMatchingSensitivityMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `tempalteMatchingSensitivity` property."
},
"templatePageLevelMatching": {
"description": "When **true,** users see template matching functionality.",
"type": "string"
},
"templatePageLevelMatchingMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `templatePageLevelMatching` property."
},
"timezoneDST": {
"description": "When true, daylight savings time is in effect for this user's time zone.",
"type": "string"
},
"timezoneDSTMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `timezoneDST` property."
},
"timezoneMask": {
"description": "The custom DateTime format setting for this user.",
"type": "string"
},
"timezoneMaskMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `timezoneMask` property."
},
"timezoneOffset": {
"description": "The timezone offset for the user. Valid values:\n- `tz_01_afghanistan`\n- `tz_02_alaskan`\n- `tz_03_arab`\n- `tz_04_arabian`\n- `tz_05_arabic`\n- `tz_06_argentina`\n- `tz_07_atlantic`\n- `tz_08_aus_central`\n- `tz_09_aus_eastern`\n- `tz_10_azerbaijan`\n- `tz_11_azores`\n- `tz_12_bangladesh`\n- `tz_13_canada_central`\n- `tz_14_cape_verde`\n- `tz_15_caucasus`\n- `tz_16_central_australia`\n- `tz_17_central_america`\n- `tz_18_central_asia`\n- `tz_19_central_brazilian`\n- `tz_20_central_europe`\n- `tz_21_central_european`\n- `tz_22_central_pacific`\n- `tz_23_central`\n- `tz_24_central_mexico`\n- `tz_25_china`\n- `tz_26_dateline`\n- `tz_27_east_africa`\n- `tz_28_east_australia`\n- `tz_29_east_europe`\n- `tz_30_east_south_america`\n- `tz_31_eastern`\n- `tz_32_egypt`\n- `tz_33_ekaterinburg`\n- `tz_34_fiji`\n- `tz_35_fli`\n- `tz_36_georgian`\n- `tz_37_gmt`\n- `tz_38_greenland`\n- `tz_39_greenwich`\n- `tz_40_gtb`\n- `tz_41_hawaiian`\n- `tz_42_india`\n- `tz_43_iran`\n- `tz_44_israel`\n- `tz_45_jordan`\n- `tz_46_kaliningrad`\n- `tz_47_kamchatka`\n- `tz_48_korea`\n- `tz_49_magadan`\n- `tz_50_mauritius`\n- `tz_51_mid_atlantic`\n- `tz_52_middle_east`\n- `tz_53_montevideo`\n- `tz_54_morocco`\n- `tz_55_mountain`\n- `tz_56_mountain_mexico`\n- `tz_57_myanmar`\n- `tz_58_north_central_asia`\n- `tz_59_namibia`\n- `tz_60_nepal`\n- `tz_61_new_zealand`\n- `tz_62_new_foundland`\n- `tz_63_north_asia_east`\n- `tz_64_north_asia`\n- `tz_65_pacific_sa`\n- `tz_66_pacific`\n- `tz_67_pacific_mexico`\n- `tz_68_pakistan`\n- `tz_69_paraguay`\n- `tz_70_romance`\n- `tz_71_russian`\n- `tz_72_sa_eastern`\n- `tz_73_sa_pacific`\n- `tz_74_sa_western`\n- `tz_75_samoa`\n- `tz_76_se_asia`\n- `tz_77_singapore`\n- `tz_78_south_africa`\n- `tz_79_sriLanka`\n- `tz_80_syria`\n- `tz_81_taipei`\n- `tz_82_tasmania`\n- `tz_83_tokyo`\n- `tz_84_tonga`\n- `tz_85_turkey`\n- `tz_86_ulaanbaatar`\n- `tz_87_us_eastern`\n- `tz_88_us_mountain`\n- `tz_89_venezuela`\n- `tz_90_vladivostok`\n- `tz_91_west_australia`\n- `tz_92_west_central_africa`\n- `tz_93_west_europe`\n- `tz_94_west_asia`\n- `tz_95_west_pacific`\n- `tz_96_yakutsk`",
"type": "string"
},
"timezoneOffsetMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `timezoneOffset` property."
},
"timezoneSendingPref": {
"description": "Reserved for Docusign.",
"type": "string"
},
"timezoneSendingPrefMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"timezoneSigningPref": {
"description": "Reserved for Docusign.",
"type": "string"
},
"timezoneSigningPrefMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"transactionPointSiteNameURL": {
"description": "Reserved for Docusign.",
"type": "string"
},
"transactionPointSiteNameURLMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"transactionPointUserName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"transactionPointUserNameMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Reserved for Docusign."
},
"vaultingMode": {
"description": "Indicates the specified Vaulting mode:\n- `none`\n- `estored`\n- `electronic_original`",
"type": "string"
},
"vaultingModeMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata about the `vaultingMode` property."
},
"webForms": {
"description": "",
"type": "string"
},
"webFormsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
}
},
"type": "object",
"x-ds-definition-name": "userSettingsInformation",
"x-ms-summary": "Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)"
},
"userSharedItem": {
"description": "Information about a shared item.",
"properties": {
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"shared": {
"description": "How the item is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`\n",
"type": "string"
},
"user": {
"$ref": "#/definitions/userInfo",
"description": "The user whose sharing information is being requested."
}
},
"type": "object",
"x-ds-definition-name": "userSharedItem",
"x-ms-summary": "Information about a shared item."
},
"userSignature": {
"description": "",
"properties": {
"adoptedDateTime": {
"description": "The date and time the user adopted their signature.",
"type": "string"
},
"createdDateTime": {
"description": "The UTC DateTime when the item was created.",
"type": "string"
},
"customField": {
"description": "",
"type": "string"
},
"dateStampProperties": {
"$ref": "#/definitions/dateStampProperties",
"description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle."
},
"disallowUserResizeStamp": {
"description": "When **true,** users may not resize the stamp.",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"externalID": {
"description": "Optionally specify an external identifier for the user's signature.",
"type": "string"
},
"imageBase64": {
"description": "A Base64-encoded representation of the signature image.",
"type": "string"
},
"imageType": {
"description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`",
"type": "string"
},
"initials150ImageId": {
"description": "The ID of the user's initials image.",
"type": "string"
},
"initialsImageUri": {
"description": "The URI for retrieving the image of the user's initials.",
"type": "string"
},
"isDefault": {
"description": "Boolean that specifies whether the signature is the default signature for the user.",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
},
"nrdsId": {
"description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.",
"type": "string"
},
"nrdsLastName": {
"description": "The realtor's last name.",
"type": "string"
},
"nrdsStatus": {
"description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`",
"type": "string"
},
"phoneticName": {
"description": "The phonetic spelling of the `signatureName`.",
"type": "string"
},
"signature150ImageId": {
"description": "The ID of the user's signature image.",
"type": "string"
},
"signatureFont": {
"description": "The font type for the signature, if the signature is not drawn. The supported font types are:\n\n\"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\"\n",
"type": "string"
},
"signatureId": {
"description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.",
"type": "string"
},
"signatureImageUri": {
"description": "An endpoint URI that you can use to retrieve the user's signature image.",
"type": "string"
},
"signatureInitials": {
"description": " The initials associated with the signature.",
"type": "string"
},
"signatureName": {
"description": "Specifies the user's signature name.",
"type": "string"
},
"signatureRights": {
"description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`",
"type": "string"
},
"signatureType": {
"description": "Specifies the type of signature.",
"type": "string"
},
"stampFormat": {
"description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ",
"type": "string"
},
"stampImageUri": {
"description": "The URI for retrieving the image of the user's stamp.",
"type": "string"
},
"stampSizeMM": {
"description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.",
"type": "string"
},
"stampType": {
"description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null",
"type": "string"
},
"status": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userSignature",
"x-ms-summary": ""
},
"userSignatureDefinition": {
"description": "",
"properties": {
"dateStampProperties": {
"$ref": "#/definitions/dateStampProperties",
"description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle."
},
"disallowUserResizeStamp": {
"description": "When **true,** users may not resize the stamp.",
"type": "string"
},
"externalID": {
"description": "Optionally specify an external identifier for the user's signature.",
"type": "string"
},
"imageType": {
"description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`",
"type": "string"
},
"isDefault": {
"description": "Boolean that specifies whether the signature is the default signature for the user.",
"type": "string"
},
"nrdsId": {
"description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor.",
"type": "string"
},
"nrdsLastName": {
"description": "The realtor's last name.",
"type": "string"
},
"phoneticName": {
"description": "The phonetic spelling of the `signatureName`.",
"type": "string"
},
"signatureFont": {
"description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n",
"type": "string"
},
"signatureId": {
"description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.",
"type": "string"
},
"signatureInitials": {
"description": "Specifies the user's signature in initials format.",
"type": "string"
},
"signatureName": {
"description": "Specifies the user's signature name.",
"type": "string"
},
"signatureType": {
"description": "Specifies the type of signature.",
"type": "string"
},
"stampFormat": {
"description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. ",
"type": "string"
},
"stampSizeMM": {
"description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userSignatureDefinition",
"x-ms-summary": ""
},
"userSignaturesInformation": {
"description": "",
"properties": {
"userSignatures": {
"description": "An array of `userSignature` objects.",
"items": {
"$ref": "#/definitions/userSignature"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "userSignaturesInformation",
"x-ms-summary": ""
},
"userSocialIdResult": {
"description": "",
"properties": {
"socialAccountInformation": {
"description": "Contains properties that map a Docusign user to a social account such as Facebook or Yahoo.",
"items": {
"$ref": "#/definitions/socialAccountInformation"
},
"type": "array"
},
"userId": {
"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.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "userSocialIdResult",
"x-ms-summary": ""
},
"usersResponse": {
"description": "",
"properties": {
"endPosition": {
"description": "The last index position in the result set. ",
"type": "string"
},
"nextUri": {
"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. ",
"type": "string"
},
"previousUri": {
"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. ",
"type": "string"
},
"resultSetSize": {
"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`.",
"type": "string"
},
"startPosition": {
"description": "The starting index position of the current result set.",
"type": "string"
},
"totalSetSize": {
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.",
"type": "string"
},
"users": {
"description": "User management information.",
"items": {
"$ref": "#/definitions/userInfo"
},
"type": "array"
}
},
"type": "object",
"x-ds-definition-name": "usersResponse",
"x-ms-summary": ""
},
"view": {
"description": "This tab is used with the Approve tab to handle supplemental documents.",
"properties": {
"agreementAttribute": {
"description": "",
"type": "string"
},
"agreementAttributeLocked": {
"description": "",
"type": "string"
},
"anchorAllowWhiteSpaceInCharacters": {
"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, Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"buttonText": {
"description": "The text to display on the button.",
"type": "string"
},
"buttonTextMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `buttonText` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"required": {
"description": "When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"requiredRead": {
"description": "When **true,** the recipient must read through the document.",
"type": "string"
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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`).",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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\n",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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\n",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "view",
"x-ms-summary": "This tab is used with the Approve tab to handle supplemental documents."
},
"viewUrl": {
"description": "",
"properties": {
"url": {
"description": "URL for the template edit view.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "viewUrl",
"x-ms-summary": ""
},
"watermark": {
"description": "",
"properties": {
"displayAngle": {
"description": "The display angle of the watermark. Valid values:\n\n* 0 (horizontal)\n* 45 (diagonal)\n* 90 (vertical)",
"type": "string"
},
"enabled": {
"description": "When **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied.",
"type": "string"
},
"font": {
"description": "The watermark's font. Valid values:\n\n- `courier`\n- `helvetica`\n- `timesnewroman`\n",
"type": "string"
},
"fontColor": {
"description": "The watermark's font color. Valid values:\n\n* `black`\n* `blue`\n* `red`\n* `gray`\n* `yellow`",
"type": "string"
},
"fontSize": {
"description": "The watermark's font size. Valid values:\n\n* `30`\n* `40`\n* `50`\n* `60`\n* `70`\n* `80`\n* `90`",
"type": "string"
},
"id": {
"description": "The ID of the watermark.",
"type": "string"
},
"imageBase64": {
"description": "The Base64 representation of the watermark image.\n\nThis property is read-only.",
"type": "string"
},
"transparency": {
"description": "The transparency percentage of the watermark image. Valid values:\n\n* `5`\n* `10`\n* `15`\n* `20`\n* `25`\n* `30`\n* `35`\n* `40`\n* `45`",
"type": "string"
},
"watermarkText": {
"description": "The text for the watermark.",
"type": "string"
}
},
"type": "object",
"x-ds-definition-name": "watermark",
"x-ms-summary": ""
},
"witness": {
"description": "A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.",
"properties": {
"accessCode": {
"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.",
"type": "string"
},
"accessCodeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `accessCode` property is editable. This property is read-only."
},
"addAccessCodeToEmail": {
"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.",
"type": "string"
},
"additionalNotifications": {
"description": "An array of additional notification objects.",
"items": {
"$ref": "#/definitions/recipientAdditionalNotification"
},
"type": "array"
},
"agentCanEditEmail": {
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.",
"type": "string"
},
"agentCanEditName": {
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.",
"type": "string"
},
"allowSystemOverrideForLockedRecipient": {
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.",
"type": "string"
},
"autoNavigation": {
"description": "When **true,** autonavigation is set for the recipient.\n",
"type": "string"
},
"autoRespondedReason": {
"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",
"type": "string"
},
"bulkRecipientsUri": {
"description": "Reserved for Docusign.",
"type": "string"
},
"bulkSendV2Recipient": {
"description": "",
"type": "string"
},
"canSignOffline": {
"description": "When **true,** specifies that the signer can perform the signing ceremony offline.",
"type": "string"
},
"clientUserId": {
"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters. \n",
"type": "string"
},
"completedCount": {
"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.",
"type": "string"
},
"consentDetailsList": {
"description": "",
"items": {
"$ref": "#/definitions/consentDetails"
},
"type": "array"
},
"creationReason": {
"description": "The reason why the recipient was created (for example, `sender`). This property is read-only.",
"type": "string"
},
"customFields": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"declinedDateTime": {
"description": "The date and time the recipient declined the document. This property is read-only.",
"type": "string"
},
"declinedReason": {
"description": "The reason the recipient declined the document. This property is read-only.",
"type": "string"
},
"defaultRecipient": {
"description": "When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.",
"type": "string"
},
"delegatedBy": {
"$ref": "#/definitions/delegationInfo",
"description": ""
},
"delegatedTo": {
"description": "",
"items": {
"$ref": "#/definitions/delegationInfo"
},
"type": "array"
},
"deliveredDateTime": {
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only.",
"type": "string"
},
"deliveryMethod": {
"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 or WhatsApp 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-whatsapp/",
"type": "string"
},
"deliveryMethodMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"designatorId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"designatorIdGuid": {
"description": "Reserved for Docusign.",
"type": "string"
},
"documentTemplateId": {
"description": "",
"type": "string"
},
"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.**",
"items": {
"$ref": "#/definitions/documentVisibility"
},
"type": "array"
},
"email": {
"description": "The recipient's email address.",
"type": "string"
},
"emailMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `email` property is editable. This property is read-only."
},
"emailNotification": {
"$ref": "#/definitions/recipientEmailNotification",
"description": "This optional property allows you to set a specific email subject and\nbody for this recipient's notification email.\n\n**Note:** If you use this property, you _must_\nprovide a value for the `supportedLanguage` sub-property.\n\n\nYou can set the `emailNotification` property separately\nfor each recipient. If you set the value only for certain\nrecipients, the other recipients are assigned the values from\nthe top-level `emailSubject` and `emailBlurb`."
},
"emailRecipientPostSigningURL": {
"description": "",
"type": "string"
},
"embeddedRecipientStartURL": {
"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]]` ",
"type": "string"
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"excludedDocuments": {
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.",
"items": {
"type": "string"
},
"type": "array"
},
"faxNumber": {
"description": "Reserved for Docusign.",
"type": "string"
},
"faxNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"firstName": {
"description": "The recipient's first name. Maximum Length: 50 characters.",
"type": "string"
},
"firstNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `firstName` property is editable. This property is read-only."
},
"fullName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"fullNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"idCheckConfigurationName": {
"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.",
"type": "string"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only."
},
"idCheckInformationInput": {
"$ref": "#/definitions/idCheckInformationInput",
"description": "An object that contains input information related to a recipient ID check."
},
"identityVerification": {
"$ref": "#/definitions/recipientIdentityVerification",
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. Docu Sign 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 Docu Sign will match.\n\nThe default value is **true.**\n",
"type": "string"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable."
},
"anchorCaseSensitive": {
"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/",
"type": "string"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable."
},
"anchorHorizontalAlignment": {
"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\u2019s 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",
"type": "string"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable."
},
"anchorIgnoreIfNotPresent": {
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.",
"type": "string"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable."
},
"anchorMatchWholeWord": {
"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",
"type": "string"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable."
},
"anchorString": {
"description": "Specifies the string to find in the document and use as the basis for tab placement.",
"type": "string"
},
"anchorStringMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorString` property is editable."
},
"anchorTabProcessorVersion": {
"description": "Reserved for Docusign.",
"type": "string"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"anchorTabScope": {
"description": "",
"type": "string"
},
"anchorUnits": {
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n",
"type": "string"
},
"anchorUnitsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorUnits` property is editable."
},
"anchorXOffset": {
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorXOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorXOffset` property is editable."
},
"anchorYOffset": {
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"type": "string"
},
"anchorYOffsetMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `anchorYOffset` property is editable."
},
"bold": {
"description": "When **true,** the information in the tab is bold.",
"type": "string"
},
"boldMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `bold` property is editable."
},
"caption": {
"description": "",
"type": "string"
},
"captionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `caption` property is editable."
},
"concealValueOnDocument": {
"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.",
"type": "string"
},
"concealValueOnDocumentMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `concealValueOnDocument` property is editable."
},
"conditionalParentLabel": {
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.",
"type": "string"
},
"conditionalParentLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentLabel` property is editable."
},
"conditionalParentValue": {
"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",
"type": "string"
},
"conditionalParentValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `conditionalParentValue` property is editable."
},
"connectedObjectDetails": {
"$ref": "#/definitions/connectedObjectDetails",
"description": ""
},
"customTabId": {
"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.",
"type": "string"
},
"customTabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `customTabId` property is editable."
},
"disableAutoSize": {
"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.",
"type": "string"
},
"disableAutoSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `disableAutoSize` property is editable."
},
"documentId": {
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"type": "string"
},
"documentIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `documentId` property is editable."
},
"errorDetails": {
"$ref": "#/definitions/errorDetails",
"description": "This object describes errors that occur. It is only valid for responses and ignored in requests."
},
"extensionData": {
"$ref": "#/definitions/extensionData",
"description": ""
},
"font": {
"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",
"type": "string"
},
"fontColor": {
"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",
"type": "string"
},
"fontColorMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontColor` property is editable."
},
"fontMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `font` property is editable."
},
"fontSize": {
"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",
"type": "string"
},
"fontSizeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fontSize` property is editable."
},
"formOrder": {
"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.",
"type": "string"
},
"formOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formOrder` property is editable."
},
"formPageLabel": {
"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.",
"type": "string"
},
"formPageLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `formPageLabel` property is editable."
},
"formPageNumber": {
"description": "An integer specifying the order in which to present the guided form pages.",
"type": "string"
},
"formPageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `fromPageNumber` property is editable."
},
"height": {
"description": "The height of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"heightMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `height` property is editable."
},
"italic": {
"description": "When **true,** the information in the tab is italic.",
"type": "string"
},
"italicMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `italic` property is editable."
},
"localePolicy": {
"$ref": "#/definitions/localePolicyTab",
"description": "Locale-specific settings."
},
"locked": {
"description": "When **true,** the signer cannot change the data of the custom tab.",
"type": "string"
},
"lockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `locked` property is editable."
},
"maxLength": {
"description": "An optional value that describes the maximum length of the property when the property is a string.",
"type": "string"
},
"maxLengthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `maxLength` property is editable."
},
"mergeField": {
"$ref": "#/definitions/mergeField",
"description": "Contains the information necessary to map the tab to a field in SalesForce."
},
"mergeFieldXml": {
"description": "Reserved for Docusign.",
"type": "string"
},
"name": {
"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.",
"type": "string"
},
"nameMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `name` property is editable. This property is read-only."
},
"originalValue": {
"description": "The initial value of the tab. ",
"type": "string"
},
"originalValueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `originalValue` property is editable."
},
"pageNumber": {
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.",
"type": "string"
},
"pageNumberMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `pageNumber` property is editable."
},
"recipientId": {
"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",
"type": "string"
},
"recipientIdGuid": {
"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.",
"type": "string"
},
"recipientIdGuidMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientIdGuid` property is editable."
},
"recipientIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `recipientId` property is editable."
},
"requireAll": {
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ",
"type": "string"
},
"requireAllMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireAll` property is editable."
},
"requireInitialOnSharedChange": {
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.",
"type": "string"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable."
},
"required": {
"description": "When **true,** the signer is required to fill out this tab.",
"type": "string"
},
"requiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `required` property is editable."
},
"senderRequired": {
"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.",
"type": "string"
},
"senderRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `senderRequired` property is editable."
},
"shareToRecipients": {
"description": "Reserved for Docusign.",
"type": "string"
},
"shareToRecipientsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Reserved for Docusign."
},
"shared": {
"description": "When **true,** this custom tab is shared.",
"type": "string"
},
"sharedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `shared` property is editable."
},
"smartContractInformation": {
"$ref": "#/definitions/smartContractInformation",
"description": "Reserved for Docusign."
},
"source": {
"description": "Reserved for Docusign.",
"type": "string"
},
"status": {
"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",
"type": "string"
},
"statusMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `status` property is editable."
},
"tabFullyQualifiedPath": {
"description": "",
"type": "string"
},
"tabGroupLabels": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"tabGroupLabelsMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabGroupLabels` property is editable."
},
"tabId": {
"description": "The unique identifier for the tab.",
"type": "string"
},
"tabIdMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabId` property is editable."
},
"tabLabel": {
"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",
"type": "string"
},
"tabLabelMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabLabel` property is editable."
},
"tabOrder": {
"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.",
"type": "string"
},
"tabOrderMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabOrder` property is editable."
},
"tabType": {
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`).",
"type": "string"
},
"tabTypeMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `tabType` property is editable."
},
"templateLocked": {
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"type": "string"
},
"templateLockedMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateLocked` property is editable."
},
"templateRequired": {
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.",
"type": "string"
},
"templateRequiredMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `templateRequired` property is editable."
},
"toolTipMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `toolTip` property is editable.\n"
},
"tooltip": {
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n",
"type": "string"
},
"underline": {
"description": "When **true,** the information in the tab is underlined.",
"type": "string"
},
"underlineMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `underline` property is editable."
},
"useDash4": {
"description": "When **true,** ZIP+4 format is used.",
"type": "string"
},
"useDash4Metadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `useDash4` property is editable."
},
"validationMessage": {
"description": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"type": "string"
},
"validationMessageMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationMessage` property is editable."
},
"validationPattern": {
"description": "A regular expression used to validate input for the tab.",
"type": "string"
},
"validationPatternMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `validationPattern` property is editable."
},
"value": {
"description": "Specifies the value of the tab. ",
"type": "string"
},
"valueMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `value` property is editable."
},
"warningDetails": {
"$ref": "#/definitions/errorDetails",
"description": ""
},
"width": {
"description": "The width of the tab in pixels.\nMust be an integer.",
"type": "string"
},
"widthMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `width` property is editable."
},
"xPosition": {
"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",
"type": "string"
},
"xPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `xPosition` property is editable."
},
"yPosition": {
"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",
"type": "string"
},
"yPositionMetadata": {
"$ref": "#/definitions/propertyMetadata",
"description": "Metadata that indicates whether the `yPosition` property is editable."
}
},
"type": "object",
"x-ds-definition-name": "zip",
"x-ms-summary": "A tab that allows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n"
}
},
"externalDocs": {
"description": "See the Docusign eSignature REST API Guide for more information.",
"url": "https://docs.docusign.com/esign"
},
"host": "www.docusign.net",
"info": {
"contact": {
"email": "devcenter@docusign.com",
"name": "Docusign Developer Center",
"url": "https://developers.docusign.com/"
},
"description": "The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.",
"termsOfService": "https://www.docusign.com/company/terms-and-conditions/web",
"title": "Docusign eSignature REST API",
"version": "v2.1"
},
"parameters": {},
"paths": {
"/service_information": {
"get": {
"consumes": [],
"deprecated": false,
"description": "Retrieves the available REST API versions.\n\nDocusign Production system: https://www.docusign.net/restapi/service_information\nDocusign Demo system: https://demo.docusign.net/restapi/service_information\n\nYou do not need an integration key to view the REST API versions and resources.",
"operationId": "ServiceInformation_GetServiceInformation",
"parameters": [],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/serviceInformation"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Retrieves the available REST API versions.",
"tags": [
"Services"
],
"x-ds-in-sdk": true,
"x-ds-method": "get",
"x-ds-methodname": "getService",
"x-ds-service": "Diagnostics"
},
"parameters": []
},
"/v2.1": {
"get": {
"consumes": [],
"deprecated": false,
"description": "Retrieves the base resources available for the eSignature REST API.\n\nYou do not need an integrator key to view the REST API versions and resources.\n\n",
"operationId": "ServiceInformation_GetResourceInformation",
"parameters": [],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/resourceInformation"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Lists resources for REST version specified",
"tags": [
"Resources"
],
"x-ds-in-sdk": true,
"x-ds-method": "get",
"x-ds-methodname": "getResources",
"x-ds-service": "Diagnostics"
},
"parameters": []
},
"/v2.1/accounts": {
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "Creates new Docusign accounts.\nYou can use this method to create\na single account\nor up to 100 accounts at a time.\n\n**Note:** This method is restricted to partner integrations.\nYou must work with Docusign Professional Services\nor Docusign Business Development,\nwho will provide you with the Distributor Code\nand Distributor Password\nthat you need to include in the request body.\n\n\nWhen creating a single account,\nthe body of the request is a\n[`newAccountRequest`][newAccountRequest]\nobject.\n\nExample:\n\n```\n{\n \"newAccountRequest\": [\n {\n \"accountName\":\"Test Account\",\n \"distributorCode\":\"MY_DIST_CODE\",\n \"distributorPassword\":\"MY_DIST_PWD\",\n \"initialUser\":{\n \"email\":\"user@emaildomain.com\",\n \"firstName\":\"John\",\n \"middleName\": \"Harry\",\n \"lastName\":\"Doe\",\n \"suffixName\": \"\",\n \"userName\": \"John Doe\",\n \"jobTitle\": \"Engineer\",\n \"company\": \"Test Company\"\n },\n \"addressInformation\":{\n \"address1\": \"1234 Main Street\",\n \"address2\": \"Suite 100\",\n \"city\": \"Seattle\",\n \"state\": \"WA\",\n \"postalCode\": \"98101\",\n \"country\": \"US\",\n \"phone\": \"1234567890\",\n \"fax\": \"1234567891\"\n },\n \"planInformation\":{\n \"planId\":\"37085696-xxxx-xxxx-xxxx-7ea067752959\"\n },\n \"referralInformation\":{\n \"includedSeats\": \"1\",\n \"referralCode\": \"code\",\n \"referrerName\": \"name\"\n }\n }\n ]\n}\n\n```\nIf the request succeeds,\nit returns a\n201 (Created) HTTP response code.\nThe response returns the new account ID, password, and the default user\ninformation for each newly created account.\n\n\nWhen creating multiple accounts,\nthe body of the request is a\n`newAccountRequests`\nobject,\nwhich contains one or more\n[`newAccountDefinition`][newAccountDefinition]\nobjects.\nYou can create up to 100 new accounts\nat a time this way.\n\nThe body for a multi-account\ncreation request\nlooks like this in JSON:\n\n```\n{\n \"newAccountRequests\": [\n {\n \"accountName\": \"accountone\",\n . . .\n },\n {\n \"accountName\": \"accounttwo\",\n . . .\n }\n ]\n}\n```\n\nA multi-account request\nlooks like this in XML:\n\n```\nGET implementation of this method, include the envelope IDs in a comma-separated list. PUT version of this method, you should use the request_body value for this parameter and include the list of envelope IDs in the request body.request_body |\n\nWhen you use the special value `request_body`, the request body looks like this:\n\n```\n{\n \"envelopeIds\": [\n \"44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15\",\n \"8e26040d-xxxx-xxxx-xxxx-1e29b924d237\",\n \"c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95\"\n ]\n}\n```\n\n{}.\n<img> elements with the src attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this:<img src=\"data:image/gif;base64,R0lGODlh...IQAAOw==\" alt=\"Base64 encoded image\" width=\"150\" height=\"150\"/>\n<img> elements with the src attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this:<img src=\"data:image/gif;base64,R0lGODlh...IQAAOw==\" alt=\"Base64 encoded image\" width=\"150\" height=\"150\"/>\nsmartSection\nand\npolyLineOverlay\ntabs.\nsmartSection\nand\npolyLineOverlay\ntabs.\n\n\n```\n\"recipientAuthenticationStatus\": {\n \"identityVerificationResult\": { \n \"status\": \"Failed\",\n \"eventTimestamp\": \"2020-09-04T16:59:42.8045667Z\",\n \"vendorFailureStatusCode\": \"MANUAL_REVIEW_STARTED\"\n }\n }\n```",
"in": "path",
"name": "recipientId",
"required": true,
"type": "string"
}
],
"produces": [],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/viewUrl"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Create the link to the page for manually reviewing IDs.",
"tags": [
"EnvelopeRecipients"
],
"x-ds-in-sdk": true,
"x-ds-method": "createRecipientManualReviewView",
"x-ds-methodname": "createRecipientManualReviewView",
"x-ds-service": "Uncategorized"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview": {
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n",
"operationId": "ResponsiveHtml_PostResponsiveHtmlPreview",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "documentHtmlDefinition",
"required": false,
"schema": {
"$ref": "#/definitions/documentHtmlDefinition"
}
}
],
"produces": [],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentHtmlDefinitions"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Creates a preview of the responsive versions of all of the documents in an envelope.",
"tags": [
"ResponsiveHtmlPreview"
],
"x-ds-in-sdk": true,
"x-ds-method": "create",
"x-ds-methodname": "createResponsiveHtmlPreview",
"x-ds-service": "Uncategorized"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares": {
"delete": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_DeleteEnvelopesShares",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "envelopesSharesRequest",
"required": false,
"schema": {
"$ref": "#/definitions/envelopesSharesRequest"
}
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response."
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "deleteEnvelopesShares",
"x-ds-methodname": "deleteEnvelopesShares",
"x-ds-service": "Uncategorized"
},
"get": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_GetEnvelopesShares",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/envelopesSharesResponse"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "getEnvelopesShares",
"x-ds-methodname": "getEnvelopesShares",
"x-ds-service": "Uncategorized"
},
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_PostEnvelopesShares",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "envelopesSharesRequest",
"required": false,
"schema": {
"$ref": "#/definitions/envelopesSharesRequest"
}
}
],
"produces": [],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/envelopesSharesResponse"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "createEnvelopesShares",
"x-ds-methodname": "createEnvelopesShares",
"x-ds-service": "Uncategorized"
},
"put": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_PutEnvelopesShares",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "envelopesSharesRequest",
"required": false,
"schema": {
"$ref": "#/definitions/envelopesSharesRequest"
}
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/envelopesSharesResponse"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "updateEnvelopesShares",
"x-ds-methodname": "updateEnvelopesShares",
"x-ds-service": "Uncategorized"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}": {
"delete": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_DeleteEnvelopesShare",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "path",
"name": "shareId",
"required": true,
"type": "string"
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response."
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "deleteEnvelopesShare",
"x-ds-methodname": "deleteEnvelopesShare",
"x-ds-service": "Uncategorized"
},
"get": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_GetEnvelopesShare",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "path",
"name": "shareId",
"required": true,
"type": "string"
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/envelopesShareResponse"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "getEnvelopesShare",
"x-ds-methodname": "getEnvelopesShare",
"x-ds-service": "Uncategorized"
},
"parameters": [],
"put": {
"consumes": [],
"deprecated": false,
"description": "",
"operationId": "EnvelopesShares_PutEnvelopesShare",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "path",
"name": "shareId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "envelopesSharePermissionRequest",
"required": false,
"schema": {
"$ref": "#/definitions/envelopesSharePermissionRequest"
}
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/envelopesShareResponse"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "",
"tags": [
"EnvelopeShares"
],
"x-ds-in-sdk": true,
"x-ds-method": "updateEnvelopesShare",
"x-ds-methodname": "updateEnvelopesShare",
"x-ds-service": "Uncategorized"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob": {
"get": {
"consumes": [],
"deprecated": false,
"description": "This endpoint has been deprecated.",
"operationId": "TabsBlob_GetTabsBlob",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response."
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Reserved for Docusign.",
"tags": [
"TabsBlob"
],
"x-ds-in-sdk": true,
"x-ds-method": "getTabsBlob",
"x-ds-methodname": "getTabsBlob",
"x-ds-service": "Uncategorized"
},
"parameters": [],
"put": {
"consumes": [],
"deprecated": false,
"description": "This endpoint has been deprecated.",
"operationId": "TabsBlob_PutTabsBlob",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response."
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Reserved for Docusign.",
"tags": [
"TabsBlob"
],
"x-ds-in-sdk": true,
"x-ds-method": "putTabsBlob",
"x-ds-methodname": "putTabsBlob",
"x-ds-service": "Uncategorized"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates": {
"get": {
"consumes": [],
"deprecated": false,
"description": "This returns a list of the server-side templates, their name and ID, used in an envelope.\n",
"operationId": "Templates_GetEnvelopeTemplates",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "Filters the results by template type. Valid values:\n* `applied`: Returns the templates applied to an envelope.\n* `matching`: Returns the [matching templates](https://support.docusign.com/s/document-item?language=en_US&bundleId=jux1643235969954&topicId=far1578456612069.html&_LANG=enus) for an envelope.\n\nThe default value is `applied`.",
"in": "query",
"name": "include",
"required": false,
"type": "string"
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/templateInformation"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Gets templates used in an envelope.",
"tags": [
"EnvelopeTemplates"
],
"x-ds-in-sdk": true,
"x-ds-method": "list",
"x-ds-methodname": "listTemplates",
"x-ds-service": "Envelopes"
},
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "Adds templates to the specified envelope.",
"operationId": "Templates_PostEnvelopeTemplates",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text. \n\nWhen **true,** the recipients _will be preserved_ after the template is applied.\n\n",
"in": "query",
"name": "preserve_template_recipient",
"required": false,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "documentTemplateList",
"required": false,
"schema": {
"$ref": "#/definitions/documentTemplateList"
}
}
],
"produces": [],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/documentTemplateList"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Adds templates to an envelope.",
"tags": [
"EnvelopeTemplates"
],
"x-ds-in-sdk": true,
"x-ds-method": "apply",
"x-ds-methodname": "applyTemplate",
"x-ds-service": "Envelopes"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct": {
"delete": {
"consumes": [],
"deprecated": false,
"description": "This API method is obsolete. Your application should not call it. It acts as a null operation.",
"operationId": "Views_DeleteEnvelopeCorrectView",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "correctViewRequest",
"required": false,
"schema": {
"$ref": "#/definitions/correctViewRequest"
}
}
],
"produces": [],
"responses": {
"200": {
"description": "Successful response."
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Revokes the correction view URL to the Envelope UI.",
"tags": [
"EnvelopeViews"
],
"x-ds-in-sdk": true,
"x-ds-method": "deleteEnvelopeCorrectView",
"x-ds-methodname": "deleteEnvelopeCorrectView",
"x-ds-service": "Uncategorized"
},
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "Returns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe. \n\n**API request update**\n\nThe request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information. \n\n**Best practices**\n\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\n\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\n\n## Customizing the user experience\n\nBy default, the view includes two pages: the **Prepare** and **Tagger** pages. The settings object is used to control the user experience. For example, to limit the user to the **Tagger** page, and not allow the user to change the recipient information:\n\n* `\"startingScreen\": \"Tagger\"`\n* `\"showBackButton\": \"false\"`\n* `\"showEditRecipients\": \"false\"`\n\n\nUse the [Embedded Views Test Too](https://docusign.github.io/app-examples/embedded-views-v2/) to try the different UX controls. Some UI settings attributes are not yet implemented.\n\n### The envelope must be in the correct state for the Embedded View\n\nTo use the Correct View, the envelope **must** be in the `sent` or `delivered` state. Otherwise, a 400 error will be returned with an error message in the response body:\n```\n{\n \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n \"message\": \"Invalid envelope status. Correct view cannot be created for an envelope in a Created state.\"\n}\n```\n\n### Modifying the envelope after redirection\nIf you set `\"sendButtonAction\": \"redirect\"` or `\"backButtonAction\": \"redirect\"`, and your app will modify the envelope before or after the view completes, you must lock the envelope before the API call and provide the lock as the lockToken attribute in the API request object.\n\nDelete the lock token after the browser has been redirected to your application.\n\n### Closing the view's iframe\n\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\n\n* (One time) create a standalone \u00e2\u0080\u009creturn\u00e2\u0080\u009d page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. Here's an [example return page](https://github.com/docusign/docusign.github.io/blob/master/jsfiddleDsResponse.html). In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\n* In your application, use `window.addEventListener(\"message\", function_name)` to register a listener for incoming messages.\n* To show the view, use this API method, then set the iframe to load the URL from the API response.\n* In your application, receive the completion message, validate it, and then close the iframe.\n\n### Information security\n\nThis view only has write access to the specific envelope referenced in the API call. It also has read access to templates and other secondary information that a user can access to modify the envelope. The read access corresponds to the access rights of the user associated with the access token used for the API call.\n\n>**Recommendations:**\n>* Use the access token of a service user who can access the templates appropriate for your use case. \n>* Do not use the access token of a user with administrator privileges.\n\n## Migrating to the current version of the request object\n\nThis section only applies to existing applications that use the older version of the request object.\n\nMigrating from the old API request object to the new version will take under a day of developer time.\n\n**Step 1.** Does your application set the `returnUrl` attribute?\n\nYes: continue with step 2.\n\nNo: In this case, your users first update the envelope, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\n* Set the `returnUrl` to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests. \n* When the new endpoint is called, use the [EnvelopeViews:createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) API call to obtain and then display the Docusign eSignature home page to your application's user.\n\n**Step 2.** Does your application modify the default UI of the view?\n\nNo: continue with step 3.\n\nYes: With the new API request object, UI controls for the view are now set when you make the API call via the `settings` attribute. \n\n* Note the UI settings your application is currently modifying by adding and updating query parameters on the URL _returned_ by the API method.\n\n* Using the reference documentation below, create a settings object that accomplishes your UI goals. You can use the [Embedded Views Test tool](https://docusign.github.io/app-examples/embedded-views-v2/) to check your UI settings. Note that the `settings` object includes multiple objects and subobjects for various UI settings.\n\n* **Delete the code** in your application that modifies and adds query parameters to the URL returned by the API. With the new API format, your application will not make any changes to the returned URL. Exception: If you set the view's locale specifically, that is still accomplished by appending the `locale` query parameter.\n\n**Step 3.** Is the envelope always in the right state before you call the Embedded View?\n\nIf your software may try to create the Embedded View when the envelope is not in the right state (see above), then you must add additional checks and logic to prevent this.\n\n**Step 4.** Check that these API attributes are set:\n* `\"view\" = \"envelope\"`\n* The `returnUrl` is set\n\n**Step 5.** All done! Test your application.\n",
"operationId": "Views_PostEnvelopeCorrectView",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "envelopeViewRequest",
"required": false,
"schema": {
"$ref": "#/definitions/envelopeViewRequest"
}
}
],
"produces": [],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeViews"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Returns a URL to the envelope correction UI. Use after an envelope has been sent.",
"tags": [
"EnvelopeViews"
],
"x-ds-in-sdk": true,
"x-ds-method": "createCorrect",
"x-ds-methodname": "createCorrectView",
"x-ds-service": "Envelopes"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit": {
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "This API method has been replaced by the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method. The two API methods work exactly the same,\n\n**Migration required**\n\nTo solve an application security issue, you must migrate to the new API request format. See the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method for more information. Backwards compatibility will be provided for a limited time.",
"operationId": "Views_PostEnvelopeEditView",
"parameters": [
{
"description": "The external account number (int) or account ID GUID.",
"in": "path",
"name": "accountId",
"required": true,
"type": "string"
},
{
"description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n",
"in": "path",
"name": "envelopeId",
"required": true,
"type": "string"
},
{
"description": "",
"in": "body",
"name": "envelopeViewRequest",
"required": false,
"schema": {
"$ref": "#/definitions/envelopeViewRequest"
}
}
],
"produces": [],
"responses": {
"201": {
"description": "Successful response.",
"schema": {
"$ref": "#/definitions/EnvelopeViews"
}
},
"400": {
"description": "Error encountered.",
"schema": {
"$ref": "#/definitions/errorDetails"
}
}
},
"summary": "Returns a URL to the edit view UI. Use before an envelope has been sent.",
"tags": [
"EnvelopeViews"
],
"x-ds-examples": [
{
"description": "The response contains the URL\nof the embeddable edit view\nfor a specified envelope.\n\nThe request body contains\na `returnUrl`.\nThis is the URL\nthat the Docusign platform\nwill redirect the user to\nwhen the view is closed.\n\n",
"direction": "both",
"format": "json",
"request": {
"returnUrl": "https://dsapp.example.com/return/from/edit/view"
},
"response": {
"url": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=c8dc7c1e-xxxx-xxxx-xxxx-405ba1f7d38b&DocuEnvelope=4b728be4-xxxx-xxxx-xxxx-d63e23f822b6&send=1"
},
"style": "custom",
"title": "Getting an Edit View URL and Setting a Return URL"
}
],
"x-ds-in-sdk": true,
"x-ds-method": "createEdit",
"x-ds-methodname": "createEditView",
"x-ds-service": "Envelopes"
}
},
"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient": {
"parameters": [],
"post": {
"consumes": [],
"deprecated": false,
"description": "Returns a URL that enables you to\n[embed the recipient view](/docs/esign-rest-api/esign101/concepts/embedding/)\nof the\nDocuSign UI in your applications. If the recipient is a signer,\nthen the view will provide the signing ceremony.\n\nThis method is only used with envelopes in the `sent` status.\n\n<iframe> for embedded operations on mobile devices.\nFor iOS devices, Docusign recommends using a WebView.\nreturnUrl\nalone as the single source of truth for envelope\nstatus for your integration.\n