externalPrimaryAccountRecipientAuthRequirements
{
"type": "object",
"properties": {
"kba": {
"type": "string",
"description": ""
},
"phone": {
"type": "string",
"description": ""
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"idVerification": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "externalPrimaryAccountRecipientAuthRequirements"
}
favoriteTemplatesContentItem
{
"type": "object",
"properties": {
"templateId": {
"type": "string",
"description": "The ID of the template."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"favoritedDate": {
"type": "string",
"description": "Time at which the template was marked as favorite."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "favoriteTemplatesContentItem"
}
favoriteTemplatesInfo
{
"type": "object",
"properties": {
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"favoriteTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/favoriteTemplatesContentItem"
},
"description": "The favorite templates acted upon by the call."
},
"templatesUpdatedCount": {
"type": "integer",
"format": "int32",
"description": "The number of templates successfully updated by the call. This property is read-only."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "favoriteTemplatesInfo"
}
featureAvailableMetadata
{
"type": "object",
"properties": {
"availabilty": {
"type": "string",
"description": ""
},
"featureName": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "featureAvailableMetadata"
}
featureSet
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Reserved for DocuSign."
},
"seatFee": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fixedFee": {
"type": "string",
"description": "Reserved for DocuSign."
},
"isActive": {
"type": "string",
"description": "Reserved for DocuSign."
},
"isEnabled": {
"type": "string",
"description": "When **true,** the feature set is actively enabled as part of the plan."
},
"envelopeFee": {
"type": "string",
"description": "Reserved for DocuSign."
},
"featureSetId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"is21CFRPart11": {
"type": "string",
"description": "Reserved for DocuSign."
},
"currencyFeatureSetPrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/currencyFeatureSetPrice"
},
"description": "Reserved for DocuSign."
}
},
"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.",
"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.",
"x-ds-definition-name": "featureSet"
}
fileType
{
"type": "object",
"properties": {
"mimeType": {
"type": "string",
"description": "The mime-type of a file type listed in a fileTypes collection."
},
"fileExtension": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "fileType"
}
fileTypeList
{
"type": "object",
"properties": {
"fileTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/fileType"
},
"description": "A collection of file types."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "fileTypeList"
}
filter
{
"type": "object",
"properties": {
"order": {
"type": "string",
"description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
},
"status": {
"type": "string",
"description": "The status of the envelope. By default, all statuses are returned.\n\nFor details, see [Envelope Status Code Descriptions](https://raw.githubusercontent.com)."
},
"expires": {
"type": "string",
"description": "The number of days a sent envelope remains active before it expires."
},
"orderBy": {
"type": "string",
"description": "The field used to sort the results.\n\nExample: `Created`"
},
"folderIds": {
"type": "string",
"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`"
},
"isTemplate": {
"type": "string",
"description": "When **true,** the item is a template."
},
"searchText": {
"type": "string",
"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."
},
"toDateTime": {
"type": "string",
"description": "The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date."
},
"fromDateTime": {
"type": "string",
"description": "The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days."
},
"searchTarget": {
"type": "string",
"description": "Reserved for DocuSign."
},
"actionRequired": {
"type": "string",
"description": "When **true,** the current user needs to take action on the item."
}
},
"description": "Use this object to create a filtered view of the items in a folder.",
"x-ms-summary": "Use this object to create a filtered view of the items in a folder.",
"x-ds-definition-name": "filter"
}
firstName
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the recipient's 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",
"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",
"x-ds-definition-name": "firstName"
}
folder
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The URI for the folder."
},
"name": {
"type": "string",
"description": "The name of the folder."
},
"type": {
"type": "string",
"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)"
},
"owner": {
"$ref": "#/components/schemas/userInfo"
},
"filter": {
"$ref": "#/components/schemas/filter"
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "A collection of folder objects returned in a response."
},
"folderId": {
"type": "string",
"description": "The ID of the folder."
},
"hasAccess": {
"type": "string",
"description": "When **true,** the current user has access to the folder."
},
"itemCount": {
"type": "string",
"description": "The number of items in the folder."
},
"folderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folderItem_v2"
},
"description": "A list of envelopes and templates that the folder contains."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"hasSubFolders": {
"type": "string",
"description": "When **true,** the folder has subfolders."
},
"parentFolderId": {
"type": "string",
"description": "The ID of the parent folder, or the special value `root` for the root folder."
},
"subFolderCount": {
"type": "string",
"description": "The number of subfolders."
},
"parentFolderUri": {
"type": "string",
"description": "The URI of the parent folder."
}
},
"description": "This object contains details about a folder.",
"x-ms-summary": "This object contains details about a folder.",
"x-ds-definition-name": "folder"
}
folderItemResponse
{
"type": "object",
"properties": {
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"totalRows": {
"type": "string",
"description": "The total number of items in the result."
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"folderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folderItem_v2"
},
"description": "A list of the envelopes in the specified folder or folders. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "Results from a folder item request.",
"x-ms-summary": "Results from a folder item request.",
"x-ds-definition-name": "folderItemResponse"
}
folderItem_v2
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"subject": {
"type": "string",
"description": "The subject of the envelope."
},
"folderId": {
"type": "string",
"description": "The ID of the folder."
},
"folderUri": {
"type": "string",
"description": "If the item is a subfolder, this is the URI for retrieving it."
},
"ownerName": {
"type": "string",
"description": "The name of the user who owns the folder."
},
"envelopeId": {
"type": "string",
"description": "If the item is an envelope, this is the ID of the envelope."
},
"recipients": {
"$ref": "#/components/schemas/EnvelopeRecipients"
},
"senderName": {
"type": "string",
"description": "The sender's name."
},
"templateId": {
"type": "string",
"description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
},
"envelopeUri": {
"type": "string",
"description": "If the item is an envelope, this is the URI for retrieving it."
},
"senderEmail": {
"type": "string",
"description": "The sender's email address."
},
"templateUri": {
"type": "string",
"description": "The URI for retrieving the template."
},
"senderUserId": {
"type": "string",
"description": "The sender's id."
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"is21CFRPart11": {
"type": "string",
"description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
},
"recipientsUri": {
"type": "string",
"description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
},
"senderCompany": {
"type": "string",
"description": "The name of the sender's company."
},
"expireDateTime": {
"type": "string",
"description": "The date and time the envelope is set to expire."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
},
"completedDateTime": {
"type": "string",
"description": "If the item is an envelope, this is the UTC DateTime when the envelope was completed."
},
"lastModifiedDateTime": {
"type": "string",
"description": "The date and time that the item was last modified."
}
},
"description": "Information about folder item results.",
"x-ms-summary": "Information about folder item results.",
"x-ds-definition-name": "folderItem_v2"
}
folderItemsResponse
{
"type": "object",
"properties": {
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "A list of folder objects."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeSummary"
},
"description": ""
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "folderItemsResponse"
}
folderSharedItem
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "A URI containing the user ID."
},
"name": {
"type": "string",
"description": "The name of the folder."
},
"user": {
"$ref": "#/components/schemas/userInfo"
},
"owner": {
"$ref": "#/components/schemas/userInfo"
},
"shared": {
"type": "string",
"description": "Indicates how the folder is shared. Valid values are:\n\n- `not_shared`\n- `shared_to`"
},
"folderId": {
"type": "string",
"description": "The ID of the folder."
},
"sharedUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userSharedItem"
},
"description": "A list of users that share the folder."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"sharedGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/memberGroupSharedItem"
},
"description": "A list of groups that share the folder."
},
"parentFolderId": {
"type": "string",
"description": "The ID of the parent folder."
},
"parentFolderUri": {
"type": "string",
"description": "The URI for the parent folder."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "folderSharedItem"
}
foldersRequest
{
"type": "object",
"properties": {
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "Not used."
},
"envelopeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of envelope ID GUIDs."
},
"fromFolderId": {
"type": "string",
"description": " The ID of the folder that the envelope is being moved from."
}
},
"description": "Information for a folder request.",
"x-ms-summary": "Information for a folder request.",
"x-ds-definition-name": "foldersRequest"
}
foldersResponse
{
"type": "object",
"properties": {
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folder"
},
"description": "A list of folder objects."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeSummary"
},
"description": ""
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "foldersResponse"
}
forgottenPasswordInformation
{
"type": "object",
"properties": {
"forgottenPasswordAnswer1": {
"type": "string",
"description": "The answer to the first forgotten password challenge question."
},
"forgottenPasswordAnswer2": {
"type": "string",
"description": "The answer to the second forgotten password challenge question."
},
"forgottenPasswordAnswer3": {
"type": "string",
"description": "The answer to the third forgotten password challenge question."
},
"forgottenPasswordAnswer4": {
"type": "string",
"description": "The answer to the fourth forgotten password challenge question."
},
"forgottenPasswordQuestion1": {
"type": "string",
"description": "The first challenge question presented to a user who has forgotten their password."
},
"forgottenPasswordQuestion2": {
"type": "string",
"description": "The second challenge question presented to a user who has forgotten their password."
},
"forgottenPasswordQuestion3": {
"type": "string",
"description": "The third challenge question presented to a user who has forgotten their password."
},
"forgottenPasswordQuestion4": {
"type": "string",
"description": "The fourth challenge question presented to a user who has forgotten their password."
}
},
"description": "A complex element that has up to four Question/Answer pairs for forgotten password information.",
"x-ms-summary": "A complex element that has up to four Question/Answer pairs for forgotten password information.",
"x-ds-definition-name": "forgottenPasswordInformation"
}
formDataItem
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form field."
},
"value": {
"type": "string",
"description": "The current value associated with the form field."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"originalValue": {
"type": "string",
"description": "The initial value associated with the form field."
},
"numericalValue": {
"type": "string",
"description": ""
},
"listSelectedValue": {
"type": "string",
"description": "The selected value in a list."
},
"originalNumericalValue": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "formDataItem"
}
formulaTab
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"hidden": {
"type": "string",
"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"
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** this custom tab is shared."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"formula": {
"type": "string",
"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"
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"required": {
"type": "string",
"description": "When **true,** the signer is required to fill out this tab."
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"maxLength": {
"type": "string",
"description": "An optional value that describes the maximum length of the property when the property is a string."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
},
"requireAll": {
"type": "string",
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"originalValue": {
"type": "string",
"description": "The initial value of the tab. "
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"hiddenMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"paymentDetails": {
"$ref": "#/components/schemas/paymentDetails"
},
"senderRequired": {
"type": "string",
"description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope."
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"disableAutoSize": {
"type": "string",
"description": "When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes."
},
"formulaMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"maxLengthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"shareToRecipients": {
"type": "string",
"description": "Reserved for DocuSign."
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationMessage": {
"type": "string",
"description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
},
"validationPattern": {
"type": "string",
"description": "A regular expression used to validate input for the tab."
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireAllMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"roundDecimalPlaces": {
"type": "string",
"description": "The number of decimal places to round to."
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"originalValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"concealValueOnDocument": {
"type": "string",
"description": "When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"disableAutoSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"isPaymentAmountMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"shareToRecipientsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationMessageMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationPatternMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"roundDecimalPlacesMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChange": {
"type": "string",
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
},
"concealValueOnDocumentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "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",
"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",
"x-ds-definition-name": "formulaTab"
}
fullName
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the recipient's full name.\n",
"x-ms-summary": "A tab that displays the recipient's full name.\n",
"x-ds-definition-name": "fullName"
}
graphicsContext
{
"type": "object",
"properties": {
"fillColor": {
"type": "string",
"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)."
},
"lineColor": {
"type": "string",
"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)."
},
"lineWeight": {
"type": "string",
"description": "The line weight or thickness to use for the overlay."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "graphicsContext"
}
group
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "A list of the users in the group. This property is not used by [Groups: list](https://raw.githubusercontent.com). To get a list of users see [GroupUsers: list](https://raw.githubusercontent.com)\n"
},
"groupId": {
"type": "string",
"description": "The DocuSign group ID for the group.\nThis is a read-only property."
},
"dsGroupId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"groupName": {
"type": "string",
"description": "The name of the group."
},
"groupType": {
"type": "string",
"description": "The group type."
},
"usersCount": {
"type": "string",
"description": "The total number of users in the group."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"permissionProfileId": {
"type": "string",
"description": "The ID of the permission profile associated with the group.\n\nUse [AccountPermissionProfiles: list](https://raw.githubusercontent.com)\nto get a list of permission profiles and their IDs."
}
},
"description": "This object contains information about a group.",
"x-ms-summary": "This object contains information about a group.",
"x-ds-definition-name": "group"
}
groupInformation
{
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
},
"description": "A collection group objects containing information about the groups."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "This object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](https://raw.githubusercontent.com).\n",
"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](https://raw.githubusercontent.com).\n",
"x-ds-definition-name": "groupInformation"
}
idCheckConfiguration
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the signature."
},
"authSteps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/idCheckSecurityStep"
},
"description": "A list of ID check security steps, each specifying an authorization type."
},
"isDefault": {
"type": "string",
"description": "Boolean that specifies whether the signature is the default signature for the user."
}
},
"description": "A complex object specifying ID check configuration.",
"x-ms-summary": "A complex object specifying ID check configuration.",
"x-ds-definition-name": "idCheckConfiguration"
}
idCheckInformationInput
{
"type": "object",
"properties": {
"dobInformationInput": {
"$ref": "#/components/schemas/dobInformationInput"
},
"ssn4InformationInput": {
"$ref": "#/components/schemas/ssn4InformationInput"
},
"ssn9InformationInput": {
"$ref": "#/components/schemas/ssn9InformationInput"
},
"addressInformationInput": {
"$ref": "#/components/schemas/addressInformationInput"
}
},
"description": "A complex element that contains input information related to a recipient ID check.",
"x-ms-summary": "A complex element that contains input information related to a recipient ID check.",
"x-ds-definition-name": "idCheckInformationInput"
}
idCheckSecurityStep
{
"type": "object",
"properties": {
"authType": {
"type": "string",
"description": "Type of authorization used for the security check."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "idCheckSecurityStep"
}
idEvidenceResourceToken
{
"type": "object",
"properties": {
"proofBaseURI": {
"type": "string",
"description": ""
},
"resourceToken": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "idEvidenceResourceToken"
}
idEvidenceViewLink
{
"type": "object",
"properties": {
"viewLink": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "idEvidenceViewLink"
}
inPersonSigner
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The signer's full legal name in an eNotary flow.\n\nRequired when `inPersonSigningType` is `notary`.\nFor a regular in-person-signer flow, use `signerName` instead.\n\nMaximum Length: 100 characters.\n"
},
"note": {
"type": "string",
"description": "A note sent to the in-person signer in the signing email.\nThis note is visible only to this recipient.\n\nMaximum Length: 1000 characters.\n"
},
"tabs": {
"$ref": "#/components/schemas/EnvelopeRecipientTabs"
},
"email": {
"type": "string",
"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"
},
"status": {
"type": "string",
"description": "The recipient's status. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"hostName": {
"type": "string",
"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"
},
"notaryId": {
"type": "string",
"description": ""
},
"roleName": {
"type": "string",
"description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"hostEmail": {
"type": "string",
"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"
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"notaryHost": {
"$ref": "#/components/schemas/notaryHost"
},
"signerName": {
"type": "string",
"description": "Required. The full legal name of a signer for the envelope. \n\nMaximum Length: 100 characters.\n\n\n"
},
"statusCode": {
"type": "string",
"description": "The code associated with the recipient's status. This property is read-only."
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
},
"signerEmail": {
"type": "string",
"description": "The in-person signer's email address.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n\n"
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"designatorId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"noteMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"emailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientType": {
"type": "string",
"description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
},
"signatureInfo": {
"$ref": "#/components/schemas/recipientSignatureInformation"
},
"totalTabCount": {
"type": "string",
"description": "The total number of tabs in the documents. This property is read-only."
},
"autoNavigation": {
"type": "string",
"description": "When **true,** autonavigation is set for the recipient.\n"
},
"canSignOffline": {
"type": "string",
"description": "When **true,** specifies that the signer can perform the signing ceremony offline."
},
"completedCount": {
"type": "string",
"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."
},
"creationReason": {
"type": "string",
"description": "The reason why the recipient was created (for example, `sender`). This property is read-only."
},
"declinedReason": {
"type": "string",
"description": "The reason the recipient declined the document. This property is read-only."
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signerLastName": {
"type": "string",
"description": "The signer's last name."
},
"signingGroupId": {
"type": "string",
"description": "Not applicable. You cannot use a signing group for an in-person signer."
},
"suppressEmails": {
"type": "string",
"description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"requireIdLookup": {
"type": "string",
"description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
},
"signerFirstName": {
"type": "string",
"description": "The signer's first name."
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"defaultRecipient": {
"type": "string",
"description": "When **true,**\nthis is the default recipient for the envelope.\nThis option is used when creating an envelope from a template.\n"
},
"designatorIdGuid": {
"type": "string",
"description": "Reserved for DocuSign."
},
"hostNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupName": {
"type": "string",
"description": "Not applicable."
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"excludedDocuments": {
"type": "array",
"items": {
"type": "string"
},
"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."
},
"faxNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"hostEmailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"offlineAttributes": {
"$ref": "#/components/schemas/offlineAttributes"
},
"signingGroupUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "Not applicable."
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"accessCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
},
"requireSignOnPaper": {
"type": "string",
"description": "When **true,** the signer must print, sign, and upload or fax the signed documents to DocuSign."
},
"signInEachLocation": {
"type": "string",
"description": "When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once)."
},
"signerNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"autoRespondedReason": {
"type": "string",
"description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
},
"bulkSendV2Recipient": {
"type": "string",
"description": ""
},
"inPersonSigningType": {
"type": "string",
"description": "Specifies whether the envelope uses the eNotary feature.\nValid values:\n\n* `inPersonSigner`: The envelope uses the normal in-person signing flow.\n* `notary`: The envelope uses the eNotary in-person signing flow.\n"
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"signerEmailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"addAccessCodeToEmail": {
"type": "string",
"description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"recipientAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAttachment"
},
"description": "Reserved for DocuSign."
},
"routingOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientSuppliesTabs": {
"type": "string",
"description": "When **true,** specifies that the recipient creates the tabs."
},
"recipientTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"deliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireUploadSignature": {
"type": "string",
"description": "When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account."
},
"signerLastNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"requireIdLookupMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signerFirstNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"recipientFeatureMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureAvailableMetadata"
},
"description": "Metadata about the features that are supported for the recipient type. This property is read-only."
},
"requireSignerCertificate": {
"type": "string",
"description": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"lockedRecipientSmsEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signInEachLocationMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"inPersonSigningTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientSignatureProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientSignatureProvider"
},
"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.](https://raw.githubusercontent.com)"
},
"recipientAuthenticationStatus": {
"$ref": "#/components/schemas/authenticationStatus"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedRecipientPhoneAuthEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowSystemOverrideForLockedRecipient": {
"type": "string",
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
},
"inheritEmailNotificationConfiguration": {
"type": "string",
"description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
}
},
"description": "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",
"x-ms-summary": "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",
"x-ds-definition-name": "inPersonSigner"
}
initialHere
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"optional": {
"type": "string",
"description": "When **true,** the recipient does not need to complete this tab to complete the signing process."
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -7)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -7)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`."
},
"scaleValue": {
"type": "string",
"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."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"handDrawRequired": {
"type": "string",
"description": "Reserved for DocuSign."
},
"optionalMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"scaleValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows the recipient to initial the document. May\nbe optional.\n",
"x-ms-summary": "A tab that allows the recipient to initial the document. May\nbe optional.\n",
"x-ds-definition-name": "initialHere"
}
inlineTemplate
{
"type": "object",
"properties": {
"envelope": {
"$ref": "#/components/schemas/envelope"
},
"sequence": {
"type": "string",
"description": "Specifies the order in which templates are overlaid."
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/document"
},
"description": "A complex element that contains details about the documents associated with the envelope."
},
"recipients": {
"$ref": "#/components/schemas/EnvelopeRecipients"
},
"customFields": {
"$ref": "#/components/schemas/AccountCustomFields"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "inlineTemplate"
}
integratedConnectUserInfoList
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectUserInfo"
},
"description": "User management information."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "integratedConnectUserInfoList"
}
integratedUserInfoList
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "User management information."
},
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
},
"allUsersSelected": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "integratedUserInfoList"
}
intermediary
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set."
},
"note": {
"type": "string",
"description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
},
"email": {
"type": "string",
"description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. "
},
"status": {
"type": "string",
"description": "The recipient's status. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipientâÂÂs email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`.\n"
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"fullName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lastName": {
"type": "string",
"description": "The recipient's last name."
},
"roleName": {
"type": "string",
"description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"firstName": {
"type": "string",
"description": "The recipient's first name. Maximum Length: 50 characters."
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"statusCode": {
"type": "string",
"description": "The code associated with the recipient's status. This property is read-only."
},
"phoneNumber": {
"$ref": "#/components/schemas/recipientPhoneNumber"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"designatorId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"noteMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"emailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientType": {
"type": "string",
"description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
},
"totalTabCount": {
"type": "string",
"description": "The total number of tabs in the documents. This property is read-only."
},
"completedCount": {
"type": "string",
"description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only."
},
"declinedReason": {
"type": "string",
"description": "The reason the recipient declined the document. This property is read-only."
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
},
"suppressEmails": {
"type": "string",
"description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"requireIdLookup": {
"type": "string",
"description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"designatorIdGuid": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fullNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lastNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"excludedDocuments": {
"type": "array",
"items": {
"type": "string"
},
"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."
},
"faxNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"firstNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "A complex type that contains information about users in the signing group."
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"accessCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"consentDetailsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consentDetails"
},
"description": ""
},
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
},
"autoRespondedReason": {
"type": "string",
"description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
},
"bulkSendV2Recipient": {
"type": "string",
"description": ""
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"addAccessCodeToEmail": {
"type": "string",
"description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"recipientAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAttachment"
},
"description": "Reserved for DocuSign."
},
"routingOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"deliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"additionalNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAdditionalNotification"
},
"description": "An array of additional notification objects."
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"requireIdLookupMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"recipientFeatureMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureAvailableMetadata"
},
"description": "Metadata about the features that are supported for the recipient type. This property is read-only."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"lockedRecipientSmsEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"emailRecipientPostSigningURL": {
"type": "string",
"description": ""
},
"recipientAuthenticationStatus": {
"$ref": "#/components/schemas/authenticationStatus"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedRecipientPhoneAuthEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowSystemOverrideForLockedRecipient": {
"type": "string",
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
},
"inheritEmailNotificationConfiguration": {
"type": "string",
"description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
}
},
"description": "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.",
"x-ms-summary": "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.",
"x-ds-definition-name": "intermediary"
}
jurisdiction
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the jurisdiction. Typically the state name."
},
"county": {
"type": "string",
"description": "The county of the jurisdiction."
},
"enabled": {
"type": "string",
"description": "When **true,** this jurisdiction is enabled."
},
"countyInSeal": {
"type": "string",
"description": "When **true,** the county name appears in the seal."
},
"jurisdictionId": {
"type": "string",
"description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n- `5 - California`\n- `6 - Colorado`\n- `9 - Florida`\n- `10 - Georgia`\n- `12 - Idaho`\n- `13 - Illinois`\n- `14 - Indiana`\n- `15 - Iowa`\n- `17 - Kentucky`\n- `23 - Minnesota`\n- `25 - Missouri`\n- `30 - New Jersey`\n- `32 - New York`\n- `33 - North Carolina`\n- `35 - Ohio`\n- `37 - Oregon`\n- `38 - Pennsylvania`\n- `40 - South Carolina`\n- `43 - Texas`\n- `44 - Utah`\n- `47 - Washington`\n- `48 - West Virginia`\n- `49 - Wisconsin`\n- `62 - Florida Commissioner of Deeds`\n"
},
"stateNameInSeal": {
"type": "string",
"description": "When **true,** the name of the state appears in the seal."
},
"commissionIdInSeal": {
"type": "string",
"description": "When **true,** the notary's `comissionId` appears in the seal."
},
"notaryPublicInSeal": {
"type": "string",
"description": "When **true,** the name of the notary appears in the seal."
},
"allowUserUploadedSeal": {
"type": "string",
"description": "When **true,** the seal can be uploaded by the user."
},
"allowSystemCreatedSeal": {
"type": "string",
"description": "When **true,** the seal can be generated by the platform."
}
},
"description": "Describes the jurisdiction of a notary.\nThis is read-only object.",
"x-ms-summary": "Describes the jurisdiction of a notary.\nThis is read-only object.",
"x-ds-definition-name": "jurisdiction"
}
jurisdictionSummary
{
"type": "object",
"properties": {
"jurisdictionId": {
"type": "string",
"description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n- `5 - California`\n- `6 - Colorado`\n- `9 - Florida`\n- `10 - Georgia`\n- `12 - Idaho`\n- `13 - Illinois`\n- `14 - Indiana`\n- `15 - Iowa`\n- `17 - Kentucky`\n- `23 - Minnesota`\n- `25 - Missouri`\n- `30 - New Jersey`\n- `32 - New York`\n- `33 - North Carolina`\n- `35 - Ohio`\n- `37 - Oregon`\n- `38 - Pennsylvania`\n- `40 - South Carolina`\n- `43 - Texas`\n- `44 - Utah`\n- `47 - Washington`\n- `48 - West Virginia`\n- `49 - Wisconsin`\n- `62 - Florida Commissioner of Deeds`\n"
},
"authorizedForRon": {
"type": "string",
"description": ""
},
"jurisdictionName": {
"type": "string",
"description": ""
},
"authorizedForIPen": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "jurisdictionSummary"
}
lastName
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the recipient's 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",
"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",
"x-ds-definition-name": "lastName"
}
linkedExternalPrimaryAccount
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": ""
},
"linkId": {
"type": "string",
"description": ""
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* `sent` - The envelope is sent to the recipients. \n* `created` - The envelope is saved as a draft and can be modified to be sent later."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"accountName": {
"type": "string",
"description": "The name on the account."
},
"configurationId": {
"type": "string",
"description": ""
},
"pdfFieldHandlingOption": {
"type": "string",
"description": ""
},
"recipientAuthRequirements": {
"$ref": "#/components/schemas/externalPrimaryAccountRecipientAuthRequirements"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "linkedExternalPrimaryAccount"
}
list
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "The value to use when the item is selected."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** this custom tab is shared."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"required": {
"type": "string",
"description": "When **true,** the signer is required to fill out this tab."
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"listItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/listItem"
},
"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"
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
},
"requireAll": {
"type": "string",
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"originalValue": {
"type": "string",
"description": "The initial value of the tab. "
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequired": {
"type": "string",
"description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope."
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"listSelectedValue": {
"type": "string",
"description": "The value in the list that is selected by default."
},
"shareToRecipients": {
"type": "string",
"description": "Reserved for DocuSign."
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireAllMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"originalValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"listSelectedValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"shareToRecipientsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChange": {
"type": "string",
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://raw.githubusercontent.com)\nobjects to specify the selectable options.\n",
"x-ms-summary": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://raw.githubusercontent.com)\nobjects to specify the selectable options.\n",
"x-ds-definition-name": "list"
}
listCustomField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom field."
},
"show": {
"type": "string",
"description": "When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope."
},
"value": {
"type": "string",
"description": "The value of the custom field. This is the value that the user who creates or sends the envelope selects from the list."
},
"fieldId": {
"type": "string",
"description": "The ID of the custom field."
},
"required": {
"type": "string",
"description": "When **true,** senders are required to select an option from the list before they can send the envelope."
},
"listItems": {
"type": "array",
"items": {
"type": "string"
},
"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."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"configurationType": {
"type": "string",
"description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`."
}
},
"description": "This object represents a list custom field from which envelope creators and senders can select custom data.",
"x-ms-summary": "This object represents a list custom field from which envelope creators and senders can select custom data.",
"x-ds-definition-name": "listCustomField"
}
listItem
{
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Specifies the text that is shown in the dropdown list. "
},
"value": {
"type": "string",
"description": "Specifies the value that is used when the list item is selected."
},
"selected": {
"type": "string",
"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."
},
"textMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"selectedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://raw.githubusercontent.com) tab.",
"x-ms-summary": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://raw.githubusercontent.com) tab.",
"x-ds-definition-name": "listItem"
}
localePolicy
{
"type": "object",
"properties": {
"timeZone": {
"type": "string",
"description": "Specifies the time zone. Valid values:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
},
"dateFormat": {
"type": "string",
"description": "Specifies the date format. Valid values:\n\n- `default` <br> used the UI's \n- `longformat` <br> use the UI's long format\n- `dd_mm_yy` <br> dd-MM-yy\n- `dd_mmm_yy` <br> dd-MMM-yy\n- `dd_mm_yyyy` <br> dd-MM-yyyy\n- `dd_mmm_yyyy` <br> dd-MMM-yyyy\n- `ddmmmmyyyy` <br> dd MMMM yyyy\n- `ddmmyyyy` <br> dd/MM/yyyy\n- `ddmmyyyy_de` <br> dd.MM.yyyy\n- `dmyyyy` <br> d/M/yyyy\n- `d_m_yyyy` <br> d-M-yyyy\n- `mmmd_yyyy` <br> MMM d, yyyy\n- `mmm_dd_yyyy` <br> MMM-dd-yyyy\n- `mmmmd_yyyy` <br> MMMM d, yyyy\n- `mm_dd_yyyy` <br> MM-dd-yyyy\n- `mdyyyy` <br> M/d/yyyy\n- `yyyy_mmm_dd` <br> yyyy-MMM-dd\n- `yyyy_mm_dd` <br> yyyy-MM-dd\n- `yyyymmdd` <br> yyyy/MM/dd\n- `yyyymd` <br> yyyy/M/d\n- `custom` <br> Customer set own value\n- `mmddyyyy` <br> MM/dd/yyyy\n- `mmddyy` <br> MM/dd/yy\n- `yyyy_mmmm_d` <br> yyyy MMMM d\n"
},
"nameFormat": {
"type": "string",
"description": "Describes how names are displayed. Valid values:\n\n- `first_middle_last`<br>William Henry Gates\n- `full`<br>Mr William Henry Gates III\n- `last_first`<br>Gates William\n- `lastfirst`<br>GatesWilliam\n- `last_first_cjk`<br>Gates William only with CJK characters\n- `lastfirst_cjk`<br>GatesWilliam only with CJK characters\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->\n"
},
"timeFormat": {
"type": "string",
"description": "Specifies the time format. Valid values:\n\n- `none` <br>None\n- `hh_mm` <br>hh:mm \n- `hhmm` <br>HH:mm\n- `hhmmss` <br>HH:mm:ss\n- `hhmmsstt` <br>HH:mm:ss tt\n- `hhmmtt` <br> HH:mm tt\n- `hmm` <br>h:mm\n- `hmmss` <br>h:mm:ss\n- `hmmsstt` <br>h:mm:ss tt\n- `hmmtt` <br>h:mm tt\n- `custom` <br>Customer-set format\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->"
},
"allowRegion": {
"type": "string",
"description": ""
},
"cultureName": {
"type": "string",
"description": "The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code."
},
"calendarType": {
"type": "string",
"description": "Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`\n"
},
"currencyCode": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n"
},
"addressFormat": {
"type": "string",
"description": "Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`\n"
},
"initialFormat": {
"type": "string",
"description": "When a user is required to enter their initials,\nthis property\nspecifies how initials are rendered.\nThe examples show the\ninitials for \"William Henry Gates\".\n\n\n- `first1last1`<br> \"WG\"\n- `last2`<br> \"GA\"\n- `first2`<br> \"WI\"\n- `last2_cjk`<br> first two characters from last name in CJK characters.\n\n<!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->\n"
},
"signDateFormat": {
"type": "string",
"description": "The format for the signature date. Valid values are:\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n**Note:** Only Admin users can change this setting.\n"
},
"signTimeFormat": {
"type": "string",
"description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n"
},
"customDateFormat": {
"type": "string",
"description": ""
},
"customTimeFormat": {
"type": "string",
"description": ""
},
"timeZoneMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"effectiveTimeZone": {
"type": "string",
"description": ""
},
"dateFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"nameFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"timeFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"cultureNameMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"effectiveDateFormat": {
"type": "string",
"description": ""
},
"effectiveNameFormat": {
"type": "string",
"description": ""
},
"effectiveTimeFormat": {
"type": "string",
"description": ""
},
"calendarTypeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"currencyCodeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"customSignDateFormat": {
"type": "string",
"description": ""
},
"customSignTimeFormat": {
"type": "string",
"description": ""
},
"addressFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"effectiveCalendarType": {
"type": "string",
"description": ""
},
"effectiveCurrencyCode": {
"type": "string",
"description": ""
},
"initialFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"currencyNegativeFormat": {
"type": "string",
"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`<br>\n `0`\n- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>\n `($1,234,567.89)`\n- `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>\n `-$1,234,567.89`\n- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n `-$ 1.234.567,89`\n- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>\n `$ -1.234.567,89`\n- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n `-1.234.567,89 $`\n- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>\n `(1 234 567,89 $)`\n- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n `-1 234 567,89 $`\n- `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>\n `$-1'234'567.89`\n- `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>\n `-$1.234.567,89`\n- `Minus_CSym_1_Comma_234_Comma_567`<br>\n `-$1,234,567`\n- `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>\n `-$12,34,567.89`\n- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>\n `($ 1234,567.89)`\n- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>\n `$ -12,34,567.89`\n- `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>\n `$-1,234,567.89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>\n `$ -1 234 567,89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>\n `$ -1 234 567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n `-$ 1 234 567,89`\n- `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>\n `-1 234 567,89$`\n- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n `-1 234 567.89 $`\n- `OPar_CSym_1_Period_234_Period_567_CPar`<br>\n `(1.234.567)`\n- `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>\n `($1,234,567)`\n- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n `-1,234,567.89 $`\n- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n `-$ 1,234,567.89`\n- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>\n `($ 1.234.567,89)`\n- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>\n `($ 1'234'567.89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>\n `($ 1 234 567,89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>\n `($ 1 234 567.89)`\n- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>\n `($12,34,567.89)`\n- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>\n `($ 12,34,567.89)`\n- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>\n `(1,234,567.89 $)`\n- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>\n `(1.234.567,89 $)`\n- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>\n `(1 234 567,89$)`\n- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>\n `(1 234 567.89 $)`\n- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>\n `($ 1,234,567.89)`\n- `Minus_CSym_1_Period_234_Period_567`<br>\n `-$ 1.234.567`\n- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n `-$ 1'234'567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>\n `-$ 1 234 567.89`\n- `CSym_Minus_1_Comma_234_Comma_567`<br>\n `$-1,234,567`\n- `CSym_Minus_1_Period_234_Period_567`<br>\n `$-1.234.567`\n- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>\n `$ -1'234'567.89`\n- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>\n `$ -1,234,567.89`\n- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n `-$ 12,34,567.89`\n- `Minus_1_Period_234_Period_567_Space_CSym`<br>\n `-123.456.789 $`\n- `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>\n `$-123 456 789,00`\n- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n `-123'456'789.00 $`\n- `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>\n `$123,456,789.00-`\n- `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>\n `$-123.456.789,00`\n- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>\n `($123.456.789,00)`\n- `Minus_CSym_1234_Comma_567_Period_89`<br>\n `-$123456,789.00`\n- `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>\n `-$123 456 789,00`\n"
},
"currencyPositiveFormat": {
"type": "string",
"description": "Determines how positive 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\n- `Default`<br>\n Uses the current locale.\n- `CSym_1_Comma_234_Comma_567_Period_89`<br>\n `$1,234,567.89`\n- `CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n `$ 1.234.567,89`\n- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n `1.234.567,89 $`\n- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n `1 234 567,89 $`\n- `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n `$ 1'234'567.89`\n- `CSym_1_Comma_234_Comma_567`<br>\n `$1,234,567`\n- `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n `$ 12,34,567.89`\n- `CSym_12_Comma_34_Comma_567_Period_89`<br>\n `$12,34,567.89`\n- `CSym_Space_1234_Comma_567_Period_89`<br>\n `$ 1234,567.89`\n- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n `1 234 567.89 $`\n- `CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n `$ 1 234 567,89`\n- `CSym_Space_1_Space_234_Space_567_Period_89`<br>\n `$ 1 234 567.89`\n- `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>\n `1 234 567,89$`\n- `CSym_1_Period_234_Period_567`<br>\n `$1.234.567`\n- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n `1,234,567. $` (New Armenian)\n- `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n `$ 1,234,567.89` (Persian)\n- `CSym_1_Period_234_Period_567_Comma_89`<br>\n `$123.456.789,00` (es-CO)\n- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n `123'456'789.00 $` (fr-ch)\n- `CSym_1234_Comma_567_Period_89`<br>\n `$123456,789.00` (es-PR)\n- `Leading_1_Period_234_Period_567_Space_CSym`<br>\n `123.456.789 $`\n- `CSym_1_Space_234_Space_567_Comma_89`<br>\n `$123 456 789,00` (en-ZA, es-CR)\n"
},
"effectiveAddressFormat": {
"type": "string",
"description": ""
},
"effectiveInitialFormat": {
"type": "string",
"description": ""
},
"signDateFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signTimeFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"effectiveCustomDateFormat": {
"type": "string",
"description": ""
},
"effectiveCustomTimeFormat": {
"type": "string",
"description": ""
},
"currencyNegativeFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"currencyPositiveFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"effectiveCurrencyNegativeFormat": {
"type": "string",
"description": ""
},
"effectiveCurrencyPositiveFormat": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "localePolicy"
}
localePolicyTab
{
"type": "object",
"properties": {
"timeZone": {
"type": "string",
"description": "Specifies the time zone. Valid values:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
},
"dateFormat": {
"type": "string",
"description": "Specifies the date format. Valid values:\n\n- `default` <br> used the UI's \n- `longformat` <br> use the UI's long format\n- `dd_mm_yy` <br> dd-MM-yy\n- `dd_mmm_yy` <br> dd-MMM-yy\n- `dd_mm_yyyy` <br> dd-MM-yyyy\n- `dd_mmm_yyyy` <br> dd-MMM-yyyy\n- `ddmmmmyyyy` <br> dd MMMM yyyy\n- `ddmmyyyy` <br> dd/MM/yyyy\n- `ddmmyyyy_de` <br> dd.MM.yyyy\n- `dmyyyy` <br> d/M/yyyy\n- `d_m_yyyy` <br> d-M-yyyy\n- `mmmd_yyyy` <br> MMM d, yyyy\n- `mmm_dd_yyyy` <br> MMM-dd-yyyy\n- `mmmmd_yyyy` <br> MMMM d, yyyy\n- `mm_dd_yyyy` <br> MM-dd-yyyy\n- `mdyyyy` <br> M/d/yyyy\n- `yyyy_mmm_dd` <br> yyyy-MMM-dd\n- `yyyy_mm_dd` <br> yyyy-MM-dd\n- `yyyymmdd` <br> yyyy/MM/dd\n- `yyyymd` <br> yyyy/M/d\n- `custom` <br> Customer set own value\n- `mmddyyyy` <br> MM/dd/yyyy\n- `mmddyy` <br> MM/dd/yy\n- `yyyy_mmmm_d` <br> yyyy MMMM d\n"
},
"nameFormat": {
"type": "string",
"description": "Describes how names are displayed. Valid values:\n\n- `first_middle_last`<br>William Henry Gates\n- `full`<br>Mr William Henry Gates III\n- `last_first`<br>Gates William\n- `lastfirst`<br>GatesWilliam\n- `last_first_cjk`<br>Gates William only with CJK characters\n- `lastfirst_cjk`<br>GatesWilliam only with CJK characters\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->\n"
},
"timeFormat": {
"type": "string",
"description": "Specifies the time format. Valid values:\n\n- `none` <br>None\n- `hh_mm` <br>hh:mm \n- `hhmm` <br>HH:mm\n- `hhmmss` <br>HH:mm:ss\n- `hhmmsstt` <br>HH:mm:ss tt\n- `hhmmtt` <br> HH:mm tt\n- `hmm` <br>h:mm\n- `hmmss` <br>h:mm:ss\n- `hmmsstt` <br>h:mm:ss tt\n- `hmmtt` <br>h:mm tt\n- `custom` <br>Customer-set format\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->"
},
"cultureName": {
"type": "string",
"description": "The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code."
},
"calendarType": {
"type": "string",
"description": "Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`\n"
},
"currencyCode": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n\nSupported formats:\n\n- `AED`\n- `AFN`\n- `ALL`\n- `AMD`\n- `ANG`\n- `AOA`\n- `ARS`\n- `AUD`\n- `AWG`\n- `AZN`\n- `BAM`\n- `BBD`\n- `BDT`\n- `BGN`\n- `BHD`\n- `BIF`\n- `BMD`\n- `BND`\n- `BOB`\n- `BOV`\n- `BRL`\n- `BSD`\n- `BTN`\n- `BWP`\n- `BYN`\n- `BYR`\n- `BZD`\n- `CAD`\n- `CDF`\n- `CHE`\n- `CHF`\n- `CHW`\n- `CLF`\n- `CLP`\n- `CNY`\n- `COP`\n- `COU`\n- `CRC`\n- `CUC`\n- `CUP`\n- `CVE`\n- `CZK`\n- `DJF`\n- `DKK`\n- `DOP`\n- `DZD`\n- `EGP`\n- `ERN`\n- `ETB`\n- `EUR`\n- `FJD`\n- `FKP`\n- `GBP`\n- `GEL`\n- `GHS`\n- `GIP`\n- `GMD`\n- `GNF`\n- `GTQ`\n- `GYD`\n- `HKD`\n- `HNL`\n- `HRK`\n- `HTG`\n- `HUF`\n- `IDR`\n- `ILS`\n- `INR`\n- `IQD`\n- `IRR`\n- `ISK`\n- `JMD`\n- `JOD`\n- `JPY`\n- `KES`\n- `KGS`\n- `KHR`\n- `KMF`\n- `KPW`\n- `KRW`\n- `KWD`\n- `KYD`\n- `KZT`\n- `LAK`\n- `LBP`\n- `LKR`\n- `LRD`\n- `LSL`\n- `LYD`\n- `MAD`\n- `MDL`\n- `MGA`\n- `MKD`\n- `MMK`\n- `MNT`\n- `MOP`\n- `MRO`\n- `MUR`\n- `MVR`\n- `MWK`\n- `MXN`\n- `MXV`\n- `MYR`\n- `MZN`\n- `NAD`\n- `NGN`\n- `NIO`\n- `NOK`\n- `NPR`\n- `NZD`\n- `OMR`\n- `PAB`\n- `PEN`\n- `PGK`\n- `PHP`\n- `PKR`\n- `PLN`\n- `PYG`\n- `QAR`\n- `RON`\n- `RSD`\n- `RUB`\n- `RWF`\n- `SAR`\n- `SBD`\n- `SCR`\n- `SDG`\n- `SEK`\n- `SGD`\n- `SHP`\n- `SLL`\n- `SOS`\n- `SRD`\n- `SSP`\n- `STD`\n- `SVC`\n- `SYP`\n- `SZL`\n- `THB`\n- `TJS`\n- `TMT`\n- `TND`\n- `TOP`\n- `TRY`\n- `TTD`\n- `TWD`\n- `TZS`\n- `UAH`\n- `UGX`\n- `USD`\n- `USN`\n- `UYI`\n- `UYU`\n- `UZS`\n- `VEF`\n- `VND`\n- `VUV`\n- `WST`\n- `XAF`\n- `XAG`\n- `XAU`\n- `XBA`\n- `XBB`\n- `XBC`\n- `XBD`\n- `XCD`\n- `XDR`\n- `XOF`\n- `XPD`\n- `XPF`\n- `XPT`\n- `XSU`\n- `XTS`\n- `XUA`\n- `XXX`\n- `YER`\n- `ZAR`\n- `ZMW`\n- `ZWL`\n"
},
"addressFormat": {
"type": "string",
"description": "Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`\n"
},
"initialFormat": {
"type": "string",
"description": "When a user is required to enter their initials,\nthis property\nspecifies how initials are rendered.\nThe examples show the\ninitials for \"William Henry Gates\".\n\n\n- `first1last1`<br> \"WG\"\n- `last2`<br> \"GA\"\n- `first2`<br> \"WI\"\n- `last2_cjk`<br> first two characters from last name in CJK characters.\n\n<!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->\n"
},
"customDateFormat": {
"type": "string",
"description": ""
},
"customTimeFormat": {
"type": "string",
"description": ""
},
"useLongCurrencyFormat": {
"type": "string",
"description": "When **true,** use the long currency format for the locale."
},
"currencyNegativeFormat": {
"type": "string",
"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`<br>\n `0`\n- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>\n `($1,234,567.89)`\n- `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>\n `-$1,234,567.89`\n- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n `-$ 1.234.567,89`\n- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>\n `$ -1.234.567,89`\n- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n `-1.234.567,89 $`\n- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>\n `(1 234 567,89 $)`\n- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n `-1 234 567,89 $`\n- `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>\n `$-1'234'567.89`\n- `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>\n `-$1.234.567,89`\n- `Minus_CSym_1_Comma_234_Comma_567`<br>\n `-$1,234,567`\n- `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>\n `-$12,34,567.89`\n- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>\n `($ 1234,567.89)`\n- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>\n `$ -12,34,567.89`\n- `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>\n `$-1,234,567.89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>\n `$ -1 234 567,89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>\n `$ -1 234 567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n `-$ 1 234 567,89`\n- `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>\n `-1 234 567,89$`\n- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n `-1 234 567.89 $`\n- `OPar_CSym_1_Period_234_Period_567_CPar`<br>\n `(1.234.567)`\n- `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>\n `($1,234,567)`\n- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n `-1,234,567.89 $`\n- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n `-$ 1,234,567.89`\n- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>\n `($ 1.234.567,89)`\n- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>\n `($ 1'234'567.89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>\n `($ 1 234 567,89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>\n `($ 1 234 567.89)`\n- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>\n `($12,34,567.89)`\n- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>\n `($ 12,34,567.89)`\n- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>\n `(1,234,567.89 $)`\n- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>\n `(1.234.567,89 $)`\n- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>\n `(1 234 567,89$)`\n- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>\n `(1 234 567.89 $)`\n- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>\n `($ 1,234,567.89)`\n- `Minus_CSym_1_Period_234_Period_567`<br>\n `-$ 1.234.567`\n- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n `-$ 1'234'567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>\n `-$ 1 234 567.89`\n- `CSym_Minus_1_Comma_234_Comma_567`<br>\n `$-1,234,567`\n- `CSym_Minus_1_Period_234_Period_567`<br>\n `$-1.234.567`\n- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>\n `$ -1'234'567.89`\n- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>\n `$ -1,234,567.89`\n- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n `-$ 12,34,567.89`\n- `Minus_1_Period_234_Period_567_Space_CSym`<br>\n `-123.456.789 $`\n- `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>\n `$-123 456 789,00`\n- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n `-123'456'789.00 $`\n- `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>\n `$123,456,789.00-`\n- `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>\n `$-123.456.789,00`\n- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>\n `($123.456.789,00)`\n- `Minus_CSym_1234_Comma_567_Period_89`<br>\n `-$123456,789.00`\n- `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>\n `-$123 456 789,00`\n"
},
"currencyPositiveFormat": {
"type": "string",
"description": "Determines how positive 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\n- `Default`<br>\n Uses the current locale.\n- `CSym_1_Comma_234_Comma_567_Period_89`<br>\n `$1,234,567.89`\n- `CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n `$ 1.234.567,89`\n- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n `1.234.567,89 $`\n- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n `1 234 567,89 $`\n- `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n `$ 1'234'567.89`\n- `CSym_1_Comma_234_Comma_567`<br>\n `$1,234,567`\n- `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n `$ 12,34,567.89`\n- `CSym_12_Comma_34_Comma_567_Period_89`<br>\n `$12,34,567.89`\n- `CSym_Space_1234_Comma_567_Period_89`<br>\n `$ 1234,567.89`\n- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n `1 234 567.89 $`\n- `CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n `$ 1 234 567,89`\n- `CSym_Space_1_Space_234_Space_567_Period_89`<br>\n `$ 1 234 567.89`\n- `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>\n `1 234 567,89$`\n- `CSym_1_Period_234_Period_567`<br>\n `$1.234.567`\n- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n `1,234,567. $` (New Armenian)\n- `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n `$ 1,234,567.89` (Persian)\n- `CSym_1_Period_234_Period_567_Comma_89`<br>\n `$123.456.789,00` (es-CO)\n- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n `123'456'789.00 $` (fr-ch)\n- `CSym_1234_Comma_567_Period_89`<br>\n `$123456,789.00` (es-PR)\n- `Leading_1_Period_234_Period_567_Space_CSym`<br>\n `123.456.789 $`\n- `CSym_1_Space_234_Space_567_Comma_89`<br>\n `$123 456 789,00` (en-ZA, es-CR)\n"
}
},
"description": "Allows you to customize locale settings.",
"x-ms-summary": "Allows you to customize locale settings.",
"x-ds-definition-name": "localePolicyTab"
}
lockInformation
{
"type": "object",
"properties": {
"lockType": {
"type": "string",
"description": "The type of lock. Currently `edit` is the only supported type."
},
"lockToken": {
"type": "string",
"description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock."
},
"lockedByApp": {
"type": "string",
"description": "The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"lockedByUser": {
"$ref": "#/components/schemas/userInfo"
},
"useScratchPad": {
"type": "string",
"description": "When **true,** a scratchpad is used to edit information.\n "
},
"lockedUntilDateTime": {
"type": "string",
"description": "The date and time that the lock expires."
},
"lockDurationInSeconds": {
"type": "string",
"description": "The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "lockInformation"
}
lockRequest
{
"type": "object",
"properties": {
"lockType": {
"type": "string",
"description": "The type of lock. Currently `edit` is the only supported type."
},
"lockedByApp": {
"type": "string",
"description": "A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur."
},
"useScratchPad": {
"type": "string",
"description": "When **true,** a scratchpad is used to edit information.\n "
},
"templatePassword": {
"type": "string",
"description": "The [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes."
},
"lockDurationInSeconds": {
"type": "string",
"description": "The number of seconds to lock the envelope for editing. Must be greater than 0 seconds."
}
},
"description": "This request object contains information about the lock that you want to create or update.",
"x-ms-summary": "This request object contains information about the lock that you want to create or update.",
"x-ds-definition-name": "lockRequest"
}
loginAccount
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name associated with the account."
},
"email": {
"type": "string",
"description": "The email address for the user."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"baseUrl": {
"type": "string",
"description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl."
},
"userName": {
"type": "string",
"description": "The name of this user as defined by the account."
},
"accountId": {
"type": "string",
"description": "The account ID associated with the envelope."
},
"isDefault": {
"type": "string",
"description": "This value is true if this is the default account for the user, otherwise false is returned."
},
"accountIdGuid": {
"type": "string",
"description": "The GUID associated with the account ID."
},
"siteDescription": {
"type": "string",
"description": "An optional descirption of the site that hosts the account."
},
"loginUserSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "A list of user-level settings that indicate what user-specific features are available."
},
"loginAccountSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "A list of settings on the account that indicate what features are available."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "loginAccount"
}
loginInformation
{
"type": "object",
"properties": {
"apiPassword": {
"type": "string",
"description": "Contains a token that can be used for authentication in API calls instead of using the user name and password. Only returned if the `api_password=true` query string is added to the URL."
},
"loginAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/loginAccount"
},
"description": "The list of accounts that authenticating user is a member of."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "loginInformation"
}
matchBox
{
"type": "object",
"properties": {
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "matchBox"
}
memberGroupSharedItem
{
"type": "object",
"properties": {
"group": {
"$ref": "#/components/schemas/group"
},
"shared": {
"type": "string",
"description": "How the item is shared. One of:\n\n\n- `not_shared`: The item is not shared.\n\n- `shared_to`: The item is shared."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
}
},
"description": "Information about items shared among groups.",
"x-ms-summary": "Information about items shared among groups.",
"x-ds-definition-name": "memberGroupSharedItem"
}
memberSharedItems
{
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/userInfo"
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/folderSharedItem"
},
"description": "List of information about shared folders."
},
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sharedItem"
},
"description": "List of information about shared envelopes."
},
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/templateSharedItem"
},
"description": "List of information about shared templates."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
}
},
"description": "Information about shared items.",
"x-ms-summary": "Information about shared items.",
"x-ds-definition-name": "memberSharedItems"
}