{"openapi":"3.1.0","info":{"title":"Docusign eSignature REST API","version":"1.0.0"},"paths":{"/v2.1/accounts/{accountId}/brands":{"post":{"operationId":"accounts_Brands_PostBrands","summary":"Creates one or more brand profiles for an account.","description":"This method creates one or more brand profile files for an account.\n\nTo specify logos for the brand,\nuse the\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)\nmethod\nafter you create the brand.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `brand`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"accounts_Brands_DeleteBrands","summary":"Deletes one or more brand profiles.","description":"This method deletes one or more brand profiles from an account, based on the brand IDs that you include in the `brandsRequest`.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `brandsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandsRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_Brands_GetBrands","summary":"Gets a list of brands.","description":"This method returns details about all of the [brands](/docs/esign-rest-api/esign101/concepts/branding/) associated with an account,\nincluding the default brand profiles.\n\nEither or both of the following settings must be enabled for the account to use this method:\n\n- `canSelfBrandSign`\n- `canSelfBrandSend`\n\n### Related topics\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n- [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"exclude_distributor_brand","in":"query","description":"When **true,** excludes distributor brand information from the response set.","required":false,"schema":{"type":"string"}},{"name":"include_logos","in":"query","description":"When **true,** returns the logos associated with the brand.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/brands/{brandId}":{"delete":{"operationId":"accounts_Brand_DeleteBrand","summary":"Deletes a brand.","description":"This method deletes a brand from an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_Brand_DeleteBrand_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_Brand_GetBrand","summary":"Gets information about a brand.","description":"This method returns details about an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"include_external_references","in":"query","description":"When **true,** the landing pages and links associated with the brand are included in the response.","required":false,"schema":{"type":"string"}},{"name":"include_logos","in":"query","description":"When **true,** the URIs for the logos associated with the brand are included in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_Brand_PutBrand","summary":"Updates an existing brand.","description":"This method updates an account brand. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"replace_brand","in":"query","description":"When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is **false.**","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `brand`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}":{"delete":{"operationId":"accounts_BrandLogo_DeleteBrandLogo","summary":"Deletes a brand logo.","description":"This method deletes a single logo from an account brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"logoType","in":"path","description":"The type of logo. Valid values are:\n\n- `primary`\n- `secondary`\n- `email`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_BrandLogo_DeleteBrandLogo_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_BrandLogo_GetBrandLogo","summary":"Gets a brand logo.","description":"This method returns a specific logo that is used in a brand.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"logoType","in":"path","description":"The type of logo. Valid values are:\n\n- `primary`\n- `secondary`\n- `email`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_BrandLogo_PutBrandLogo","summary":"Updates a brand logo.","description":"This method updates a single brand logo.\n\nYou pass in the new version of the resource in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"logoType","in":"path","description":"The type of logo. Valid values are:\n\n- `primary`\n- `secondary`\n- `email`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_BrandLogo_PutBrandLogo_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/brands/{brandId}/file":{"get":{"operationId":"accounts_BrandExport_GetBrandExportFile","summary":"Exports a brand.","description":"This method exports information about a brand to an XML file.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_BrandExport_GetBrandExportFile_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}":{"get":{"operationId":"accounts_BrandResources_GetBrandResources","summary":"Returns a branding resource file.","description":"This method returns a specific branding resource file.\n\nA brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences.  You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.\n\n**Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. \n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"resourceContentType","in":"path","description":"The type of brand resource file to return. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`","required":true,"schema":{"type":"string"}},{"name":"langcode","in":"query","description":"The ISO 3166-1 alpha-2 codes for the languages that the brand supports.","required":false,"schema":{"type":"string"}},{"name":"return_master","in":"query","description":"Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements that you modified are returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_BrandResources_GetBrandResources_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_BrandResources_PutBrandResources","summary":"Updates a branding resource file.","description":"This method updates a branding resource file.\n\nYou pass in the new version of the resource file in the `Content-Disposition` header. Example:\n\n`Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"`\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\n\n**Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed.\n\nWhen you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}},{"name":"resourceContentType","in":"path","description":"The type of brand resource file that you are updating. Valid values are:\n\n- `sending`\n- `signing`\n- `email`\n- `signing_captive`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandResources"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file.xml":{"type":"string","format":"binary","description":"Brand resource XML file."}},"required":["file.xml"]}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/brands/{brandId}/resources":{"get":{"operationId":"accounts_BrandResources_GetBrandResourcesList","summary":"Returns metadata about the branding resources for an account.","description":"This method returns metadata about the branding resources that are associated with an account.\n\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"brandId","in":"path","description":"The ID of the brand.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandResourcesList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}":{"get":{"operationId":"accounts_ConsumerDisclosure_GetConsumerDisclosureLangCode","summary":"Gets the Electronic Record and Signature Disclosure for an account.","description":"Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\n\n**Note:** The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the `langCode` parameter to specify the signer language version that you want to retrieve.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"langCode","in":"path","description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_ConsumerDisclosure_PutConsumerDisclosure","summary":"Updates the Electronic Record and Signature Disclosure for an account.","description":"Account administrators can use this method to perform the following tasks:\n\n- Customize values in the default disclosure.\n- Switch to a custom disclosure that uses your own text and HTML formatting.\n- Change values in your existing consumer disclosure. \n\nTo specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.\n\n**Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. \n\n## Updating the default disclosure\n\nWhen you update the default disclosure, you can edit all properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure.\n- `esignAgreement`: This property is read-only.\n- `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`.\n- Metadata properties: These properties are read-only.\n\n**Note:** The text of the default disclosure is always in English.\n\n## Switching to a custom disclosure\n\nTo switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. \n\nYou can also edit all of the other properties except for the following ones:\n\n- `accountEsignId`: This property is read-only.\n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.\n\n**Important:**  When you switch from a default to a custom disclosure, note the following information:\n\n- You will not be able to return to using the default disclosure.\n- Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n## Updating a custom disclosure\n\nWhen you update a custom disclosure, you can update all of the properties except for the following ones:\n\n- `accountEsignId`: This property is read-only. \n- `esignAgreement`: This property is read-only.\n- Metadata properties: These properties are read-only.\n\n**Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\n\n","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"langCode","in":"path","description":"The code for the signer language version of the disclosure that you want to update. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","required":true,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"(Optional) When true, the response includes metadata indicating which properties are editable.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `consumerDisclosure`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/consumer_disclosure":{"get":{"operationId":"accounts_ConsumerDisclosure_GetConsumerDisclosure","summary":"Get default consumer disclosure","description":"Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account.\n\nThis is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"langCode","in":"query","description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/custom_fields":{"post":{"operationId":"accounts_AccountCustomFields_PostAccountCustomFields","summary":"Creates an account custom field.","description":"This method creates a custom field and makes it available for all new envelopes associated with an account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"apply_to_templates","in":"query","description":"(Optional) When **true,** the new custom field is applied to all of the templates on the account.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customField`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customField"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_AccountCustomFields_GetAccountCustomFields","summary":"Gets a list of custom fields.","description":"This method returns a list of the envelope and document custom fields associated with an account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/custom_fields/{customFieldId}":{"delete":{"operationId":"accounts_AccountCustomFields_DeleteAccountCustomFields","summary":"Deletes an account custom field.","description":"This method deletes an existing account custom field.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"customFieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"apply_to_templates","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_AccountCustomFields_DeleteAccountCustomFields_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_AccountCustomFields_PutAccountCustomFields","summary":"Updates an account custom field.","description":"This method updates an existing account custom field.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"customFieldId","in":"path","description":"The ID of the custom field.","required":true,"schema":{"type":"string"}},{"name":"apply_to_templates","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customField`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customField"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings/password_rules":{"get":{"operationId":"accounts_AccountPasswordRules_GetAccountPasswordRules","summary":"Gets the password rules for an account.","description":"This method retrieves the password rules for an account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountPasswordRules"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_AccountPasswordRules_PutAccountPasswordRules","summary":"Updates the password rules for an account.","description":"This method updates the password rules for an account.\n\n**Note:** To update the password rules for an account, you must be an account administrator.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountPasswordRules"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `accountPasswordRules`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountPasswordRules"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/current_user/password_rules":{"get":{"operationId":"accounts_PasswordRules_GetPasswordRules","summary":"Gets membership account password rules.","description":"Gets membership account password rules.","tags":["accounts"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userPasswordRules"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/permission_profiles":{"post":{"operationId":"accounts_PermissionProfiles_PostPermissionProfiles","summary":"Creates a new permission profile for an account.","description":"This method creates a new permission profile for an account.\n\n### Related topics\n\n- [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)\n","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permissionProfile"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `permissionProfile`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permissionProfile"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_PermissionProfiles_GetPermissionProfiles","summary":"Gets a list of permission profiles.","description":"This method returns a list of permission profiles that are associated with an account.\n\nExample:\n\n```json\n{\n  \"permissionProfiles\": [\n    {\n      \"permissionProfileId\": \"1665536\",\n      \"permissionProfileName\": \"Account Administrator\",\n      \"modifiedDateTime\": \"2018-03-26T03:54:40.4470000Z\",\n      \"modifiedByUsername\": \"\"\n    },\n    {\n      \"permissionProfileId\": \"1665537\",\n      \"permissionProfileName\": \"DocuSign Sender\",\n      \"modifiedDateTime\": \"2018-03-26T03:54:40.4470000Z\",\n      \"modifiedByUsername\": \"\"\n    },\n    {\n      \"permissionProfileId\": \"1665538\",\n      \"permissionProfileName\": \"DocuSign Viewer\",\n      \"modifiedDateTime\": \"2016-06-02T01:53:15.6830000Z\",\n      \"modifiedByUsername\": \"\"\n    },\n    {\n      \"permissionProfileId\": \"10325926\",\n      \"permissionProfileName\": \"DS Manage Company Member Accounts\",\n      \"modifiedDateTime\": \"2020-05-15T00:28:36.8230000Z\",\n      \"modifiedByUsername\": \"Nat Irving\"\n    }\n  ]\n}\n```","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list of additional properties to return in the response. Valid values are:\n\n- `user_count`: The total number of users associated with the permission profile.\n- `closed_users`: Includes closed users in the `user_count`.\n- `account_management`: The account management settings.\n- `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable.\n\nExample: `user_count,closed_users`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permissionProfileInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}":{"delete":{"operationId":"accounts_PermissionProfiles_DeletePermissionProfiles","summary":"Deletes a permission profile from an account.","description":"This method deletes a permission profile from an account.\n\nTo delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter.\n\n\n### Related topics\n\n- [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"permissionProfileId","in":"path","description":"The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page.","required":true,"schema":{"type":"string"}},{"name":"move_users_to","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_PermissionProfiles_DeletePermissionProfiles_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_PermissionProfiles_GetPermissionProfile","summary":"Returns a permission profile for an account.","description":"This method returns information about a specific permission profile that is associated with an account.\n\n### Related topics\n\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\n","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"permissionProfileId","in":"path","description":"The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permissionProfile"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_PermissionProfiles_PutPermissionProfiles","summary":"Updates a permission profile.","description":"This method updates an account permission profile.\n\n### Related topics\n\n- [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)\n","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"permissionProfileId","in":"path","description":"The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permissionProfile"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `permissionProfile`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/permissionProfile"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts":{"post":{"operationId":"accounts_postaccounts","summary":"Creates new accounts.","description":"Creates new Docusign accounts.\nYou can use this method to create\na single account\nor up to 100 accounts at a time.\n\n**Note:** This method is restricted to partner integrations.\nYou must work with Docusign Professional Services\nor Docusign Business Development,\nwho will provide you with the Distributor Code\nand Distributor Password\nthat you need to include in the request body.\n\nWhen creating a single account,\nthe body of the request is a\n[`newAccountRequest`](#/definitions/newAccountRequest)\nobject.\n\nExample:\n\n```json\n{\n  \"newAccountRequest\": [\n    {\n      \"accountName\":\"Test Account\",\n      \"distributorCode\":\"MY_DIST_CODE\",\n      \"distributorPassword\":\"MY_DIST_PWD\",\n      \"initialUser\":{\n        \"email\":\"user@emaildomain.com\",\n        \"firstName\":\"John\",\n        \"middleName\": \"Harry\",\n        \"lastName\":\"Doe\",\n        \"suffixName\": \"\",\n        \"userName\": \"John Doe\",\n        \"jobTitle\": \"Engineer\",\n        \"company\": \"Test Company\"\n      },\n      \"addressInformation\":{\n        \"address1\": \"1234 Main Street\",\n        \"address2\": \"Suite 100\",\n        \"city\": \"Seattle\",\n        \"state\": \"WA\",\n        \"postalCode\": \"98101\",\n        \"country\": \"US\",\n        \"phone\": \"1234567890\",\n        \"fax\": \"1234567891\"\n      },\n      \"planInformation\":{\n        \"planId\":\"37085696-xxxx-xxxx-xxxx-7ea067752959\"\n      },\n      \"referralInformation\":{\n        \"includedSeats\": \"1\",\n        \"referralCode\": \"code\",\n        \"referrerName\": \"name\"\n      }\n    }\n  ]\n}\n```\n\nIf the request succeeds,\nit returns a\n201 (Created) HTTP response code.\nThe response returns the new account ID, password, and the default user\ninformation for each newly created account.\n\nWhen creating multiple accounts,\nthe body of the request is a\n`newAccountRequests`\nobject,\nwhich contains one or more\n[`newAccountDefinition`](#/definitions/newAccountDefinition)\nobjects.\nYou can create up to 100 new accounts\nat a time this way.\n\nThe body for a multi-account\ncreation request\nlooks like this in JSON:\n\n```json\n{\n  \"newAccountRequests\": [\n    {\n      \"accountName\": \"accountone\",\n      . . .\n    },\n    {\n      \"accountName\": \"accounttwo\",\n      . . .\n    }\n  ]\n}\n```\n\nA multi-account request\nlooks like this in XML:\n\n```xml\n<newAccountsDefinition xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://www.docusign.com/restapi\">\n  <newAccountRequests>\n    <newAccountDefinition>\n      . . .\n    </newAccountDefinition>\n    <newAccountDefinition>\n      . . .\n    </newAccountDefinition>\n  </newAccountRequests>\n</newAccountsDefinition>\n```\n\nA multi-account creation request\nmay succeed (report a 201 code)\neven if some accounts could not be created.\nIn this case, the `errorDetails` property\nin the response contains specific information\nabout the failure.","tags":["accounts"],"parameters":[{"name":"preview_billing_plan","in":"query","description":"When set to **true**, creates the account using a preview billing plan.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/newAccountSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `newAccountDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/newAccountDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}":{"delete":{"operationId":"accounts_deleteaccount","summary":"Deletes the specified account.","description":"This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"redact_user_data","in":"query","description":"Valid only for individual accounts; not applicable to organization accounts. When set to `true`, user data is redacted at account deletion in compliance with [GDPR right to erasure](https://gdpr-info.eu/art-17-gdpr/) rules. Otherwise, `false`: user data is retained at account deletion and the account may be reactivated upon request of Docusign Support.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_deleteaccount_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_getaccount","summary":"Retrieves the account information for the specified account.","description":"Retrieves the account information for the specified account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"include_account_settings","in":"query","description":"When **true,** includes account settings in the response. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"include_trial_eligibility","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}":{"delete":{"operationId":"accounts_CaptiveRecipients_DeleteCaptiveRecipientsPart","summary":"Deletes the signature for one or more captive recipient records.","description":"This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientPart","in":"path","description":"Signature is the only supported value.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/captiveRecipientInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `captiveRecipientInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/captiveRecipientInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_charges":{"get":{"operationId":"accounts_BillingCharges_GetAccountBillingCharges","summary":"Gets list of recurring and usage charges for the account.","description":"Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. \n\nPrivileges required: account administrator ","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"include_charges","in":"query","description":"Specifies which billing charges to return.\nValid values are:\n\n* envelopes\n* seats\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingChargeResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings/envelope_purge_configuration":{"get":{"operationId":"uncategorized_EnvelopePurgeConfiguration_GetEnvelopePurgeConfiguration","summary":"Gets the envelope purge configuration for an account.","description":"An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account.\n\n**Note:** To use this method, you must be an account administrator.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopePurgeConfiguration"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopePurgeConfiguration_PutEnvelopePurgeConfiguration","summary":"Sets the envelope purge configuration for an account.","description":"An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account.\n\n**Note:** To use this method, you must be an account administrator.\n\nFor more information, see [Purge Envelopes](https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes).","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopePurgeConfiguration"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopePurgeConfiguration`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopePurgeConfiguration"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings/notification_defaults":{"get":{"operationId":"uncategorized_NotificationDefaults_GetNotificationDefaults","summary":"Gets envelope notification defaults.","description":"This method returns the default settings for the email notifications that signers and senders receive about envelopes.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notificationDefaults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_NotificationDefaults_PutNotificationDefaults","summary":"Updates envelope notification default settings.","description":"This method changes the default settings for the email notifications that signers and senders receive about envelopes.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notificationDefaults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `notificationDefaults`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notificationDefaults"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/provisioning":{"get":{"operationId":"accounts_getprovisioning","summary":"Retrieves the account provisioning information for the account.","description":"Retrieves the account provisioning information for the account.","tags":["accounts"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/provisioningInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings":{"get":{"operationId":"accounts_Settings_GetSettings","summary":"Gets account settings information.","description":"Retrieves the account settings information for the specified account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_Settings_PutSettings","summary":"Updates the account settings for an account.","description":"Updates the account settings for the specified account.\n\nAlthough the request body for this method\nis a complete\n`accountSettingsInformation` object,\nyou only need to provide\nthe properties that\nyou are updating.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_Settings_PutSettings_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `accountSettingsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSettingsInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/shared_access":{"get":{"operationId":"accounts_SharedAccess_GetSharedAccess","summary":"Reserved: Gets the shared item status for one or more users.","description":"Retrieves shared item status for one or more users and types of items.\n\nUsers with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the `shared` parameter to `shared_from`.\n\n**Note:** This endpoint returns the shared status for the legacy Shared Envelopes feature. To use the new Shared Access feature, use the [Authorizations resource](/docs/esign-rest-api/reference/accounts/authorizations/).\n\n### Related topics\n\n- [How to share access to a Docusign envelope inbox](/docs/esign-rest-api/how-to/shared-access/)","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nDefault: `1000`","required":false,"schema":{"type":"string"}},{"name":"envelopes_not_shared_user_status","in":"query","description":"This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:\n\n- `ActivationRequired`: Membership Activation required\n- `ActivationSent`: Membership activation sent to user\n- `Active`: User Membership is active\n- `Closed`: User Membership is closed\n- `Disabled`: User Membership is disabled","required":false,"schema":{"type":"string"}},{"name":"folder_ids","in":"query","description":"A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder ID is required.","required":false,"schema":{"type":"string"}},{"name":"item_type","in":"query","description":"Specifies the type of shared item being requested. Valid values:\n\n- `envelopes`: Get information about envelope sharing between users.\n- `templates`: Get information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.","required":false,"schema":{"type":"string"}},{"name":"shared","in":"query","description":"A comma-separated list of sharing filters that specifies which users appear in the response.\n\n- `not_shared`: The response lists users who do not share items of `item_type` with the current user.\n\n- `shared_to`: The response lists users in `user_list` who are sharing items to current user.\n\n- `shared_from`: The response lists users in `user_list` who are sharing items from the current user.\n\n- `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and from the current user.\n\nIf the current user does not have administrative privileges, only the `shared_to` option is valid.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"user_ids","in":"query","description":"A comma separated list of userIds for whom the shared item information is being requested.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSharedAccess"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_SharedAccess_PutSharedAccess","summary":"Reserved: Sets the shared access information for users.","description":"This sets the shared access status for one or more users or templates.\n\nWhen setting user shared access, only users with account administration privileges can set shared access status for envelopes.\n\nWhen setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates.\n\nChanges to the shared items status are not additive. The change always replaces the current status.\n\nTo change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required.\n\n**Note:** This functionality is a newer version of the [Update Group Share](/docs/esign-rest-api/reference/templates/templates/updategroupshare/) functionality.\n\n### Related topics\n\n- [How to share access to a Docusign envelope inbox](/docs/esign-rest-api/how-to/shared-access/)","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"item_type","in":"query","description":"Specifies the type of shared item being set:\n\n- `envelopes`: Set envelope sharing between users.\n- `templates`: Set information about template sharing among users and groups.\n- `folders`: Get information about folder sharing among users and groups.","required":false,"schema":{"type":"string"}},{"name":"preserve_existing_shared_access","in":"query","description":"When **true,** preserve the existing shared access settings.","required":false,"schema":{"type":"string"}},{"name":"user_ids","in":"query","description":"A comma-separated list of IDs for users whose shared item access is being set.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSharedAccess"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `accountSharedAccess`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSharedAccess"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/supported_languages":{"get":{"operationId":"accounts_SupportedLanguages_GetSupportedLanguages","summary":"Gets the supported languages for envelope recipients.","description":"Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nFor more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/en/guides/ndse-user-guide-recipient-language).","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/supportedLanguages"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/unsupported_file_types":{"get":{"operationId":"accounts_UnsupportedFileTypes_GetUnsupportedFileTypes","summary":"Gets a list of unsupported file types.","description":"Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fileTypeList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/seals":{"get":{"operationId":"trustServiceProviders_AccountSignatureProviders_GetSealProviders","summary":"Returns available seals for specified account.","description":"Returns available seals for specified account.","tags":["trustServiceProviders"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSeals"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signatureProviders":{"get":{"operationId":"accounts_AccountSignatureProviders_GetSignatureProviders","summary":"Gets the available signature providers for an account.","description":"Returns a list of signature providers that the specified account can use.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignatureProviders"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signatures":{"post":{"operationId":"uncategorized_AccountSignatures_PostAccountSignatures","summary":"Adds or updates one or more account stamps.","description":"Adds or updates one or more account stamps.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"decode_only","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignaturesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `accountSignaturesInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignaturesInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_AccountSignatures_GetAccountSignatures","summary":"Returns a list of stamps available in the account.","description":"Returns a list of stamps available in the account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"stamp_format","in":"query","description":"The format of the stamp to return. Valid values:\n\n- `NameDateHanko`\n- `NameHanko`\n- `PlaceholderHanko`","required":false,"schema":{"type":"string"}},{"name":"stamp_name","in":"query","description":"The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.","required":false,"schema":{"type":"string"}},{"name":"stamp_type","in":"query","description":"The type of the stamps to return. Valid values:\n\n- `name_stamp`\n- `stamp`\n- `signature`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignaturesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_AccountSignatures_PutAccountSignature","summary":"Updates an account stamp.","description":"Adds or updates one or more account stamps. This request may include images in multi-part format.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignaturesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `accountSignaturesInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignaturesInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signatures/{signatureId}":{"delete":{"operationId":"uncategorized_AccountSignatures_DeleteAccountSignature","summary":"Deletes an account stamp.","description":"Deletes a stamp specified by `signatureId`.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_AccountSignatures_DeleteAccountSignature_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_AccountSignatures_GetAccountSignature","summary":"Returns information about the specified stamp.","description":"Returns information about the specified stamp.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_AccountSignatures_PutAccountSignatureById","summary":"Updates an account stamp by ID.","description":"Updates an account stamp specified by the `signatureId` query parameter.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"close_existing_signature","in":"query","description":"When **true,** closes the current signature.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `accountSignatureDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignatureDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}":{"delete":{"operationId":"uncategorized_AccountSignatures_DeleteAccountSignatureImage","summary":"Deletes the image for a stamp.","description":"Deletes the image for a stamp specified by `signatureId`.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"path","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_AccountSignatures_GetAccountSignatureImage","summary":"Returns the image for an account stamp.","description":"Returns the image for an account stamp.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"path","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"include_chrome","in":"query","description":"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_AccountSignatures_PutAccountSignatureImage","summary":"Sets a signature image, initials, or stamp.","description":"Sets a signature image, initials, or stamp.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"path","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"transparent_png","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings/tabs":{"get":{"operationId":"accounts_TabSettings_GetTabSettings","summary":"Returns tab settings list for specified account","description":"This method returns information about the tab types and tab functionality that is currently enabled for an account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabAccountSettings"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_TabSettings_PutSettings","summary":"Modifies tab settings for specified account","description":"This method modifies the tab types and tab functionality that is enabled for an account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabAccountSettings"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabAccountSettings`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabAccountSettings"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/watermark":{"get":{"operationId":"accounts_Watermark_GetWatermark","summary":"Get watermark information.","description":"Enables you to preview a watermark specified by the request.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_Watermark_PutWatermark","summary":"Update watermark information.","description":"Returns information about the watermark for the account.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `watermark`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/watermark/preview":{"put":{"operationId":"accounts_WatermarkPreview_PutWatermarkPreview","summary":"Get watermark preview.","description":"Update the watermark for the account.\n\n**Note:** Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `watermark`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/authorization":{"post":{"operationId":"uncategorized_UserAuthorization_CreateUserAuthorization","summary":"Creates a user authorization.","description":"Creates an authorization allowing one user to send and/or manage envelopes on behalf of another user.\n\nThe _agent_ user acts on behalf of the _principal_ user. The principal user is specified by the `userId` path parameter. The agent user is specified in the request body. Each principal user can only share signing permission with one agent user.\n\nSpecify in the request the level of access to share with the agent user. If you share signing access, the agent user will receive an email notification.\n\nTo call this endpoint:\n\n- You must be an account administrator or you must be the principal user.\n- The agent user and principal user must belong to the same account.\n- At least one of the following account settings must be enabled: `AllowDelegatedSigning`, `AllowManagingEnvelopesOnBehalfOfOthers`, `AllowEditingEnvelopesOnBehalfOfOthers`, `AllowSendingEnvelopesOnBehalfOfOthers`. These settings correspond to the level of access you can set for the authorization.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorization"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userAuthorizationCreateRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizationCreateRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/authorizations":{"post":{"operationId":"uncategorized_UserAuthorizations_PostUserAuthorizations","summary":"Create or update multiple user authorizations.","description":"Create or update multiple user authorizations in a single request. The body of the request is a list of userAuthorizationSomething objects. To create a new authorization, specify the `agentUser` and `permission` fields, with the optional `startDate` and `endDate` fields. To update an existing authorization, specify the `authorizationId` field and the `startDate` and/or `endDate` fields.\n\nFor example, to create a new authorization and update the end date of an existing authorization, your request body might look like this:\n\n```json\n{\n  \"authorizations\": [\n    {\n      \"agentUser\": {\n        \"userId\": \"1470ff66-xxxx-xxxx-xxxx-8c46f140da37\",\n        \"accountId\": \"230546a7-xxxx-xxxx-xxxx-af205d5494ad\"\n      },\n      \"permission\": \"manage\"\n    },\n    {\n      \"authorizationId\": \"b73ac983-xxxx-xxxx-xxxx-b3c0ea5b09d3\",\n      \"endDate\": \"2023-05-09T21:36:27.0000000+00:00\"\n    }\n  ]\n}\n```\n\nThe principal user is specified by the `userId` path parameter. To call this endpoint, you must be an account administrator or the principal user.\n\n**Note:** To create an authorization with signing permission, the `AllowDelegationSigning` setting must be enabled on the account. If you share signing access, the agent user will receive an email notification. Each principal user can only share signing permission with one agent user.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizationsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userAuthorizationsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizationsRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_UserAuthorizations_DeleteUserAuthorizations","summary":"Delete multiple user authorizations.","description":"Delete one or more user authorizations for a given principal user. The principal user is specified by the `userId` path parameter.\n\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorizations.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizationsDeleteResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userAuthorizationsDeleteRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizationsDeleteRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_UserAuthorizations_GetPrincipalUserAuthorizations","summary":"List principal user authorizations","description":"Returns the user authorizations for which the user specified by `userId` is the principal user.\n\nTo call this endpoint, you must be an account administrator or you must be the specified principal user.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}},{"name":"active_only","in":"query","description":"When **true,** return only active authorizations. The default value is **true.**","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"email_substring","in":"query","description":"Filters returned user records by full email address or a substring of email address.","required":false,"schema":{"type":"string"}},{"name":"include_closed_users","in":"query","description":"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when `active_only` is **false.**","required":false,"schema":{"type":"string"}},{"name":"permissions","in":"query","description":"Filters results by authorization permission. Valid values:\n\n- `Send`\n- `Manage`\n- `Sign`","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}},{"name":"task_source","in":"query","required":false,"schema":{"type":"string"}},{"name":"task_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","description":"Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizations"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}":{"delete":{"operationId":"uncategorized_UserAuthorization_DeleteUserAuthorization","summary":"Deletes the user authorization","description":"Deletes the user authorization specified by the `authorizationId`.\n\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"authorizationId","in":"path","description":"The ID of the user authorization.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_UserAuthorization_DeleteUserAuthorization_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_UserAuthorization_GetUserAuthorization","summary":"Returns the user authorization for a given authorization id","description":"Returns the details for the user authorization specified by the `authorizationId`.\n\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"authorizationId","in":"path","description":"The ID of the user authorization.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorization"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_UserAuthorization_UpdateUserAuthorization","summary":"Updates the start or end date for a user authorization.","description":"Updates the start and/or end date for a given user authorization. Specify the user authorization and principal user with the path parameters.\n\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"authorizationId","in":"path","description":"The ID of the user authorization.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The ID of the principal user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorization"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userAuthorizationUpdateRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizationUpdateRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/authorizations/agent":{"get":{"operationId":"uncategorized_UserAgentAuthorizations_GetAgentUserAuthorizations","summary":"Returns the authorizations for which the specified user is the agent user.","description":"Returns the user authorizations for which the user specified by `userId` is the agent user.\n\nIf the calling user is an account administrator, the full results will be returned. Otherwise, only authorizations for which the calling user is the principal user will be returned.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"The user who is acting as the agent.","required":true,"schema":{"type":"string"}},{"name":"active_only","in":"query","description":"When **true,** only active users are returned. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"email_substring","in":"query","description":"Filters returned user records by full email address or a substring of email address.","required":false,"schema":{"type":"string"}},{"name":"include_closed_users","in":"query","description":"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when `active_only` is **false.**","required":false,"schema":{"type":"string"}},{"name":"permissions","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}},{"name":"task_source","in":"query","required":false,"schema":{"type":"string"}},{"name":"task_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","description":"Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userAuthorizations"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings/enote_configuration":{"delete":{"operationId":"accounts_ENoteConfiguration_DeleteENoteConfiguration","summary":"Delete eNote configuration","description":"Deletes configuration information for the eNote eOriginal integration.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts_ENoteConfiguration_DeleteENoteConfiguration_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"accounts_ENoteConfiguration_GetENoteConfiguration","summary":"Get eNote configuration","description":"Returns the configuration information for the eNote eOriginal integration.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eNoteConfiguration"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"accounts_ENoteConfiguration_PutENoteConfiguration","summary":"Update eNote configuration","description":"Updates configuration information for the eNote eOriginal integration.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eNoteConfiguration"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `eNoteConfiguration`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eNoteConfiguration"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/favorite_templates":{"get":{"operationId":"uncategorized_FavoriteTemplates_GetFavoriteTemplates","summary":"Retrieves the list of favorite templates for the account.","description":"Retrieves the list of favorite templates for the account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/favoriteTemplatesInfo"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_FavoriteTemplates_UnFavoriteTemplate","summary":"Remove one or more templates from the account favorites.","description":"Remove one or more templates from the account favorites.\n\nYour request should include each template to remove as a separate `favoriteTemplatesContentItem` JSON object, like this:\n\n```json\n{\n    \"favoriteTemplates\": [\n        {\n            \"templateId\": \"6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1\"\n        },\n        {\n            \"templateId\": \"8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f\"\n        }\n    ]\n}\n```\n\nThe response includes the IDs of the templates that were successfully removed from your favorites. To get the account's remaining favorite templates, use the [getFavoriteTemplates](/docs/esign-rest-api/reference/accounts/favoritetemplates/getfavoritetemplates/) endpoint.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/favoriteTemplatesInfo"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `favoriteTemplatesInfo`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/favoriteTemplatesInfo"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_FavoriteTemplates_PutFavoriteTemplate","summary":"Set one or more templates as account favorites.","description":"Set one or more templates as account favorites.\n\nYour request should include each template as a separate `favoriteTemplatesContentItem` JSON object, like this:\n\n```json\n{\n    \"favoriteTemplates\": [\n        {\n            \"templateId\": \"6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1\"\n        },\n        {\n            \"templateId\": \"8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f\"\n        }\n    ]\n}\n```","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/favoriteTemplatesInfo"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `favoriteTemplatesInfo`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/favoriteTemplatesInfo"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/identity_verification":{"get":{"operationId":"uncategorized_AccountIdentityVerification_GetAccountIdentityVerification","summary":"Retrieves the Identity Verification workflows available to an account.","description":"This method returns a list of Identity Verification workflows that are available to an account.\n\n**Note:** To use this method, you must either be an account administrator or a sender.\n\n### Related topics\n\n- [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)\n\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"identity_verification_workflow_status","in":"query","description":"Filters the workflows returned according to status. Valid values:\n\n- `active`: Only active workflows are returned. This is the default.\n- `deactivated`: Only deactivated workflows are returned.\n- `all`: All workflows are returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountIdentityVerificationResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/billing_plans/{billingPlanId}":{"get":{"operationId":"billing_BillingPlans_GetBillingPlan","summary":"Gets billing plan details.","description":"Retrieves the billing plan details for the specified billing plan ID.","tags":["billing"],"parameters":[{"name":"billingPlanId","in":"path","description":"The ID of the billing plan being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPlanResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_plan":{"get":{"operationId":"billing_BillingPlan_GetBillingPlan","summary":"Get Account Billing Plan","description":"Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false.**\n\nResponse\n\nThe response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing: getBillingPlan](/docs/esign-rest-api/reference/billing/billingplans/get/) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing: updatePlan](/docs/esign-rest-api/reference/billing/billingplans/update/) reference.\n\n**Note:** When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"include_credit_card_information","in":"query","description":"When **true,** payment information including credit card information will show in the return.","required":false,"schema":{"type":"string"}},{"name":"include_downgrade_information","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to the `billingAddress` information.","required":false,"schema":{"type":"string"}},{"name":"include_successor_plans","in":"query","description":"When **true,** excludes successor information from the response.","required":false,"schema":{"type":"string"}},{"name":"include_tax_exempt_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountBillingPlanResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"billing_BillingPlan_PutBillingPlan","summary":"Updates an account billing plan.","description":"Updates the billing plan information, billing address, and credit card information for the specified account.","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"preview_billing_plan","in":"query","description":"When **true,** updates the account using a preview billing plan.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPlanUpdateResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `billingPlanInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPlanInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_plan/credit_card":{"get":{"operationId":"billing_BillingPlan_GetCreditCardInfo","summary":"Get credit card information","description":"This method returns information about a credit card associated with an account.","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/creditCardInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_plan/downgrade":{"get":{"operationId":"uncategorized_BillingPlan_GetDowngradeRequestBillingInfo","summary":"Returns downgrade plan information for the specified account.","description":"Returns downgrade plan information for the specified account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/downgradRequestBillingInfoResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_BillingPlan_PutDowngradeAccountBillingPlan","summary":"Queues downgrade billing plan request for an account.","description":"Queues downgrade billing plan request for an account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/downgradePlanUpdateResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `downgradeBillingPlanInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/downgradeBillingPlanInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/billing_plans":{"get":{"operationId":"billing_BillingPlans_GetBillingPlans","summary":"Gets a list of available billing plans.","description":"Retrieves a list of the billing plans associated with a distributor.","tags":["billing"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPlansResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes":{"put":{"operationId":"billing_PurchasedEnvelopes_PutPurchasedEnvelopes","summary":"Reserved: Purchase additional envelopes.","description":"Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing_PurchasedEnvelopes_PutPurchasedEnvelopes_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `purchasedEnvelopesInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purchasedEnvelopesInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}":{"get":{"operationId":"billing_BillingInvoices_GetBillingInvoice","summary":"Retrieves a billing invoice.","description":"Retrieves the specified invoice.\n\nThis method retrieves a specific invoice by `invoiceId`. To find past invoices for an account, first use the [listInvoices](/docs/esign-rest-api/reference/billing/invoices/list/) method to retrieve available invoices, optionally filtering by `from_date` and `to_date`. If no date range is specified, listInvoices returns invoices from the last 365 days. Then use the returned `invoiceId` with the `get` method to retrieve a specific invoice.\n\n**Note:** If the `pdfAvailable` property in the response is set to _true_, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.\n\nPrivileges required: account administrator\n\nThe response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.\n\n**Response**\nThe following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | Docusign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"invoiceId","in":"path","description":"The ID of the invoice.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingInvoice"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_invoices":{"get":{"operationId":"billing_BillingInvoices_GetBillingInvoices","summary":"Get a List of Billing Invoices","description":"Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.\n\nPrivileges required: account administrator ","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Specifies the date/time of the earliest invoice in the account to retrieve.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Specifies the date/time of the latest invoice in the account to retrieve.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingInvoicesResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_invoices_past_due":{"get":{"operationId":"billing_BillingInvoices_GetBillingInvoicesPastDue","summary":"Get a list of past due invoices.","description":"Returns a list past due invoices for the account and notes if payment can be made through the REST API. \n\nPrivileges Required: account administrator","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingInvoicesSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_payments":{"post":{"operationId":"billing_BillingPayments_PostPayment","summary":"Posts a payment to a past due invoice.","description":"Posts a payment to a past due invoice.\n\nThis method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [Billing::listInvoicesPastDue](/docs/esign-rest-api/reference/billing/invoices/listpastdue/).\n\nThe response returns information for a single payment\nif a payment ID was used in the endpoint, or a list of payments.\nIf the from date or to date queries or payment ID are not used,\nthe response returns payment information for the last 365 days.\n\nIf the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.\n\nPrivileges required: account administrator","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPaymentResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `billingPaymentRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPaymentRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"billing_BillingPayments_GetPaymentList","summary":"Gets payment information for one or more payments.","description":"Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. \n\nPrivileges required: account administrator ","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Specifies the date/time of the earliest payment in the account to retrieve.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Specifies the date/time of the latest payment in the account to retrieve.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPaymentsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/billing_payments/{paymentId}":{"get":{"operationId":"billing_BillingPayments_GetPayment","summary":"Gets billing payment information for a specific payment.","description":"Retrieves the information for a specified payment. \n\nPrivileges required: account administrator ","tags":["billing"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"paymentId","in":"path","description":"The ID of the payment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billingPaymentItem"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_lists":{"post":{"operationId":"uncategorized_BulkSendV2CRUD_PostBulkSendList","summary":"Creates a bulk send list.","description":"This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n### Errors\n\n| Error code | Description |\n| --- | --- |\n| BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |\n| BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |\n| BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |\n| BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient &#123;0&#125; has no name. Specify a name for the recipient. |\n| BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient &#123;0&#125; is an email recipient with no email address. Specify an email for the email recipient. |\n| BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient &#123;0&#125; is a fax recipient with no fax number. Specify a fax number for the fax recipient. |\n| BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient &#123;0&#125; specifies fax number &#123;1&#125;, which is not valid. Specify a valid fax number for the fax recipient. |\n| BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient &#123;0&#125; specifies email address &#123;1&#125;, which is not a valid email address. Specify a valid email address for the recipient. |\n| BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient &#123;0&#125; specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |\n| BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient &#123;0&#125; specifies phone number &#123;1&#125; for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |\n| BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role &#123;duplicateRecipientRole&#125; appears multiple times. Use unique roleNames for recipients. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; &#123;0&#125; has both. Specify a roleName or recipientId, but not both for the same recipient. |\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |\n| BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient &#123;0&#125; specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |\n| BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient &#123;0&#125; has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : &#123;0&#125; is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |\n| BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label &#123;0&#125; is duplicated. Needs to be unique. Use a unique tab label. |\n| BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. |\n| BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field &#123;0&#125; appears more than once in a copy. Use unique names for custom fields. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field &#123;0&#125; has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |\n| BULK_SEND_ENVELOPE_PREFILL_TAB_NAME_MUST_BE_UNIQUE | Prefill tabs must have distinct names. The field &#123;0&#125; appears more than once in a copy. |\n| BULK_SEND_ENVELOPE_PREFILL_TAB_NAME_REQUIRED | All prefill tabs must have names. |\n| BULK_SEND_ENVELOPE_PREFILL_TAB_VALUE_REQUIRED | Prefill tab &#123;0&#125; has no value. A prefill tab can have an empty value, but it cannot have a null value. |\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_PREFILL_TABS | Bulk sending list contains prefill tabs, but the specified envelope does not. |\n| BULK_SEND_ENVELOPE_PREFILL_TAB_DOES_NOT_EXIST_IN_ENVELOPE | PrefillTab &#123;0&#125; does not exist in the envelope. |\n| BULK_SEND_ENVELOPE_PREFILL_TAB_NAME_DOES_NOT_MATCH | PrefillTab names must match. &#123;0&#125; and &#123;1&#125; do not match. |","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The ID of the account.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bulkSendingList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_BulkSendV2CRUD_GetBulkSendLists","summary":"Gets bulk send lists.","description":"This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingListSummaries"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send":{"post":{"operationId":"uncategorized_BulkSendV2Send_PostBulkSendRequest","summary":"Creates a bulk send request.","description":"This method queues envelopes for bulk sending to multiple recipients. It requires an existing bulk send list (created using the [BulkSend::createBulkSendList](/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/) method) and an envelope or `templateID`.\n\nConsider using the [BulkSend::createBulkSendTestRequest](/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendtestrequest/) method to test your bulk send list against the envelope or template that you want to send first. To learn about the complete bulk send flow, see the [Bulk Send overview](/docs/esign-rest-api/reference/bulkenvelopes/bulksend/).\n\nIf the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.\n\n**Note:** The entire batch either queues successfully or fails. Partial success does not occur.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\n### Errors\n\nThis method returns the following errors:\n\n| Error code | Description |\n| --- | --- |\n| BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope &#123;0&#125; is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients. |\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than &#123;0&#125; copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |\n| BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |\n| BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact Docusign Support. |\n| BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of &#123;maxCopies&#125; in-flight envelopes. This account currently has &#123;unprocessedEnvelopes&#125; envelopes waiting to be processed. Please try again later, or contact Docusign Support to request a higher tier.\" |\n| BULK_SEND_ENVELOPE_NOT_FOUND | Envelope &#123;envelopeOrTemplateId&#125; does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |\n| BULK_SEND_LIST_NOT_FOUND | Bulk Sending list &#123;listId&#125; does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |\n| BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient &#123;0&#125; does not exist in the envelope. Add the missing recipient to the envelope. |\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID &#123;envelopeMember.ID&#125; does not match. Make sure the recipient information in the list and the envelope match up. |\n| BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient &#123;0&#125; is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |\n| BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role &#123;envelopeMember.RoleName&#125; does not match. Make sure the recipient information in the list and the envelope is compatible. |\n| BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients (&#123;0&#125;) not allowed, unless recipients have unique routing order specified on envelope. |\n| BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |\n| BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label &#123;0&#125; does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_TAB_DOES_NOT_MATCH | Tab &#123;0&#125; does not match &#123;0&#125; in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field &#123;0&#125; does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope. |\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. &#123;0&#125; and &#123;1&#125; do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendListId","in":"path","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bulkSendRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test":{"post":{"operationId":"uncategorized_BulkSendV2Test_PostBulkSendTestRequest","summary":"Creates a bulk send test.","description":"This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first.\n\nA successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred.\n\nIf the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest](/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/) method.\n\n## Envelope Compatibility Checks\n\nThis section describes the envelope compatibility checks that the system performs.\n\n**Top-Level Issues**\n\n- Envelopes must be in a sendable state.\n- The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.\n- The envelope must not be null and must be visible to the current user.\n- The account cannot have more queued envelopes than the maximum number configured for the account.\n- The bulk send list must exist.\n\n**Recipients**\n\n- The envelope must have recipients.\n- If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.\n- The envelope cannot contain a bulk recipient (an artifact of the legacy version of Docusign bulk send\nfunctionality).\n\n**Recipient Tabs**\n\n- Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.\n\n**Custom Fields**\n\n- Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the\nenvelope definition. You do not have to match the recipient-level custom fields.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendListId","in":"path","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendTestResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bulkSendRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}":{"delete":{"operationId":"uncategorized_BulkSendV2CRUD_DeleteBulkSendList","summary":"Deletes a bulk send list.","description":"This method deletes a bulk send list.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendListId","in":"path","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingListSummaries"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_BulkSendV2CRUD_GetBulkSendList","summary":"Gets a specific bulk send list","description":"This method returns all of the details associated with a specific bulk send list that belongs to the current user.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendListId","in":"path","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_BulkSendV2CRUD_PutBulkSendList","summary":"Updates a bulk send list.","description":"This method replaces the definition of an existing bulk send list.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendListId","in":"path","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bulkSendingList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendingList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes":{"get":{"operationId":"uncategorized_BulkSendV2Envelopes_GetBulkSendBatchEnvelopes","summary":"Gets envelopes from a specific bulk send batch","description":"This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendBatchId","in":"path","description":"The batch ID.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `1000`","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"When `recipients`, only envelopes with recipient nodes will be included in the response.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The order in which to sort the results. Valid values are:\n\n- Descending order: `desc` (default)\n- Ascending order: `asc`","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"The envelope attribute used to sort the results. Valid values are:\n\n- `created` (default)\n- `completed`\n- `last_modified`\n- `sent`\n- `status`\n- `subject`\n- `status_changed`","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Use this parameter to search for specific text.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Comma-separated list of envelope statuses.\n\nNote that `any` should not be included with other statuses. In other words, `any` is a valid parameter value, but `any,sent` is not.\n\nUse the value `deliveryfailure` to get all envelopes with `AuthFailed` and `AutoResponded` status. This value is specific to bulk sending.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_batch":{"get":{"operationId":"uncategorized_BulkSendV2Batch_GetBulkSendBatches","summary":"Returns a list of bulk send batch summaries.","description":"Returns a summary of bulk send batches.\n\nUse the `batch_ids` query parameter to narrow the list of batches.\n\nYou must specify exactly one of the following query parameters to get back a list of batch summaries:\n\n| Parameter | Description |\n| --- | --- |\n| `from_date` | A valid UTC DateTime: `2016-01-01` |\n| `batch_ids` | A comma-separated list of batch IDs to query. |\n\nIf neither query parameter is provided, a high-level, account-wide, overall bulk send status report is returned.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"batch_ids","in":"query","description":"A comma-separated list of batch IDs to query.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`\n\nDefault: `100`","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Required. The start date for a date range in UTC DateTime format.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Use this parameter to search for specific text.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The kind of results to collect. Must be one of:\n\n- all\n- failed\n- sent\n- queued","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchSummaries"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}":{"get":{"operationId":"uncategorized_BulkSendV2Batch_GetBulkSendBatchStatus","summary":"Gets the status of a specific bulk send batch.","description":"Gets the general status of a specific bulk send batch such as:\n\n- number of successes\n- number pending\n- number of errors\n\nThe `bulkErrors` property of the response object contains more information about the errors.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendBatchId","in":"path","description":"The batch ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchStatus"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_BulkSendV2Batch_PutBulkSendBatchStatus","summary":"Updates the name of a bulk send batch.","description":"Updates the name of a bulk send batch.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkSendBatchId","in":"path","description":"The batch ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchStatus"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bulkSendBatchRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}":{"put":{"operationId":"uncategorized_BulkSendV2Batch_PutBulkSendBatchAction","summary":"Applies a bulk action to all envelopes from a specified bulk send.","description":"Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bulkAction","in":"path","description":"The action to apply. Valid values:\n\n- `resend`\n- `correct`\n- `void`","required":true,"schema":{"type":"string"}},{"name":"bulkSendBatchId","in":"path","description":"The batch ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchStatus"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bulkSendBatchActionRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSendBatchActionRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}":{"get":{"operationId":"cloudStorage_CloudStorageFolder_GetCloudStorageFolder","summary":"Gets a list of items from a cloud storage provider.","description":"Retrieves a list of the user's items from the specified cloud storage provider.\n\nTo limit the scope of the items returned, provide a comma-separated list of folder IDs in the request.","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"cloud_storage_folder_path","in":"query","description":"The file path to a cloud storage folder.","required":false,"schema":{"type":"string"}},{"name":"cloud_storage_folderid_plain","in":"query","description":"A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder IDs as a comma-separated list.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nDefault: `25`","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The order in which to sort the results.\n\nValid values are:\n\n- `asc`: Ascending order.\n- `desc`: Descending order.","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"The file attribute to use to sort the results.\n\nValid values are:\n\n- `modified`\n- `name`","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Use this parameter to search for specific text.","required":false,"schema":{"type":"string"}},{"name":"sky_drive_skip_token","in":"query","description":"A OneDrive-only pagination token used to retrieve the next page of folders and files.\n\nDocusign’s OneDrive integration uses the Microsoft Graph API, which paginates results with a skip token instead of `start_position` and `end_position`. When a response includes a skip token, pass it in `sky_drive_skip_token` to request the next page. This property applies only to OneDrive connections and is ignored for other providers (Box, Dropbox, etc.).","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/externalFolder"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders":{"get":{"operationId":"cloudStorage_CloudStorageFolder_GetCloudStorageFolderAll","summary":"Retrieves a list of all the items in a specified folder from the specified cloud storage provider.","description":"Retrieves a list of all the items in a specified folder from the specified cloud storage provider. ","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"cloud_storage_folder_path","in":"query","description":"A comma separated list of folder IDs included in the request. ","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nDefault: `25`","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The order in which to sort the results.\n\nValid values are:\n\n- `asc`: Ascending order.\n- `desc`: Descending order.","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"The file attribute to use to sort the results.\n\nValid values are:\n\n- `modified`\n- `name`","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Use this parameter to search for specific text.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/externalFolder"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage":{"post":{"operationId":"cloudStorage_postcloudstorage","summary":"Configure cloud storage redirect URLs","description":"Configures the redirect URL information  for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `cloudStorageProviders`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"cloudStorage_deletecloudstorageproviders","summary":"Delete cloud storage providers","description":"Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `cloudStorageProviders`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"cloudStorage_getcloudstorageproviders","summary":"Get the Cloud Storage Provider configuration for the specified user.","description":"Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","description":" The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\n ","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}":{"delete":{"operationId":"cloudStorage_deletecloudstorage","summary":"Delete cloud storage provider","description":"Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"cloudStorage_getcloudstorage","summary":"Gets the specified Cloud Storage Provider configuration for the User.","description":"Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.","tags":["cloudStorage"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","description":" The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\n ","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudStorageProviders"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect":{"post":{"operationId":"connect_postconnectconfiguration","summary":"Creates a Connect configuration.","description":"Creates a custom Connect configuration for the specified account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\nConnect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create:\n\n- Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users\n- Recipient Connect configurations that are triggered when one or more of your account users receive an envelope\n\nTo set an account-level configuration, set `configurationType` to **custom.**\nTo set a Recipient Connect configuration, set `configurationType` to **customrecipient.**\n\nIf you want to listen for events on only one envelope, use the [eventNotification](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_eventnotification) object instead.\n\n## Data models\n\nThere are four possible data models for your Connect configuration. Consider:\n\n- Do you want the data in JSON or XML?\n- Do you want events sent individually (SIM) or in aggregate?\n\nDocusign recommends using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/).\n\n<div className=\"ds-lp-acc\">\n\n<details>\n<summary>JSON SIM (Recommended)</summary>\n\nSet `deliveryMode` to **SIM** and `eventData.version` to **restv2.1.** Use the `events` property to set the event statuses that will trigger your configuration.\n\nThe following sample request shows how to create an envelope-level configuration using JSON SIM:\n\n```json\n{\n  \"configurationType\": \"custom\",\n  \"urlToPublishTo\": \"YOUR-WEBHOOK-URL\",\n  \"allUsers\": \"true\",\n  \"name\": \"jsonSimTest\",\n  \"deliveryMode\": \"SIM\",\n  \"allowEnvelopePublish\": \"true\",\n  \"enableLog\": \"true\",\n  \"eventData\": {\n      \"version\": \"restv2.1\"\n  },\n  \"events\": [\n      \"envelope-sent\",\n      \"envelope-delivered\",\n      \"envelope-completed\"\n  ]\n}\n```\n\nThe following sample request shows how to create a Recipient Connect configuration using JSON SIM:\n\n```json\n{\n  \"configurationType\": \"customrecipient\",\n  \"urlToPublishTo\": \"YOUR-WEBHOOK-URL\",\n  \"allUsers\": \"true\",\n  \"name\": \"jsonSimTest\",\n  \"deliveryMode\": \"SIM\",\n  \"allowEnvelopePublish\": \"true\",\n  \"enableLog\": \"true\",\n  \"eventData\": {\n      \"version\": \"restv2.1\"\n  },\n  \"events\": [\n      \"recipient-sent\",\n      \"recipient-completed\"\n  ]\n}\n```\n\n</details>\n\n<details>\n<summary>JSON Aggregate</summary>\n\nSet `deliveryMode` to **aggregate** and `eventData.version` to **restv2.1.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n</details>\n\n<details>\n<summary>XML Aggregate</summary>\n\nSet `deliveryMode` to **aggregate.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n</details>\n\n<details>\n<summary>XML SIM (Legacy apps only)</summary>\n\n**Note:** This model [is deprecated](https://www.docusign.com/blog/developers/docusign-connect-xml-sim-messaging-format-deprecated).\n\nSet `deliveryMode` to **SIM.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\n\n</details>\n\n</div>\n\n## Troubleshooting\n\nIf your configuration is not working, check the following.\n\n- Connect must be enabled for your account to use this function.\n- If you are using `envelopeEvents` or `recipientEvents`, make sure that the event values are sentence case, not lowercase.\n- Make sure you have either set `allUsers` to **true** or set `userIds` to a non-empty array of IDs.\n- By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter `allowEnvelopePublish` to **true.** You can also enable the configuration in the UI.\n- To check if events are being emitted, set `enableLog` to **true** to view event logs in the Connect console.\n\n## Related topics\n\n- For more information about Connect, see the [Docusign Connect guide](/platform/webhooks/connect/).\n- Use the MyAPICalls sample app to see an [example of this endpoint](https://myapicalls.sampleapps.docusign.com/scenario/6) using the JSON SIM model.","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectCustomConfiguration"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `connectCustomConfiguration`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectCustomConfiguration"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"connect_getconnectconfigs","summary":"Get Connect Configuration Information","description":"Retrieves all the Docusign Custom Connect definitions for the specified account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectConfigResults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"connect_putconnectconfiguration","summary":"Updates a specified Connect configuration.","description":"Updates the specified Docusign Connect configuration in your account. To enable the configuration, set the `allowEnvelopePublish` property to **true.**\n\nAfter any updates, test your configuration to make sure it works as expected.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectCustomConfiguration"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `connectCustomConfiguration`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectCustomConfiguration"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/oauth":{"post":{"operationId":"uncategorized_ConnectOAuthConfig_PostConnectOAuthConfig","summary":"Set up Connect OAuth for the specified account.","description":"Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server.\n\nWhen you call this endpoint, Docusign requests an access token from your authorization server. Docusign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\n## Related topics:\n\n- [OAuth for Docusign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `connectOAuthConfig`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_ConnectOAuthConfig_DeleteConnectOAuthConfig","summary":"Delete the Connect OAuth configuration.","description":"Deletes the Connect OAuth configuration for the specified account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\n## Related topics:\n\n- [OAuth for Docusign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_ConnectOAuthConfig_DeleteConnectOAuthConfig_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_ConnectOAuthConfig_GetConnectOAuthConfig","summary":"Retrieves the Connect OAuth information for the account.","description":"Gets the Connect OAuth configuration for the specified account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\n## Related topics:\n\n- [OAuth for Docusign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_ConnectOAuthConfig_PutConnectOAuthConfig","summary":"Updates the existing Connect OAuth configuration for the account.","description":"Updates the existing Connect OAuth configuration for the account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `connectOAuthConfig`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectOAuthConfig"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/secret":{"post":{"operationId":"uncategorized_ConnectHMAC_CreateConnectSecret","summary":"Generates a new connect HMAC Secret.","description":"This endpoint generates a new shared HMAC secret, used to sign Connect webhook notifications. The secret is associated with the account and is required to validate the integrity and authenticity of incoming Connect payloads using HMAC signatures. See [Using HMAC Security with Docusign Connect](/platform/webhooks/connect/hmac/) for details.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_ConnectHMAC_CreateConnectSecret_Response_201"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_ConnectHMAC_GetConnectSecret","summary":"Get the connect HMAC Secrets for AccountID","description":"This endpoint returns an array of the specified account's HMAC secrets, truncated to preserve security. HMAC secrets are used to sign Connect webhook notifications, and can be required to validate the integrity and authenticity of incoming Connect payloads. See [Using HMAC Security with Docusign Connect](/platform/webhooks/connect/hmac/) for details.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_ConnectHMAC_GetConnectSecret_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/{connectId}":{"delete":{"operationId":"connect_deleteconnectconfig","summary":"Deletes the specified connect configuration.","description":"Deletes the specified Docusign Connect configuration.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"connectId","in":"path","description":"The ID of the custom Connect configuration being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connect_deleteconnectconfig_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"connect_getconnectconfig","summary":"Gets the details about a Connect configuration.","description":"Retrieves the information for the specified Docusign Connect configuration.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"connectId","in":"path","description":"The ID of the custom Connect configuration being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectConfigResults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/secret/{keyId}":{"delete":{"operationId":"uncategorized_ConnectHMAC_DeleteConnectSecret","summary":"Deletes the Connect HMAC Secret at the provided index from your account.","description":"The provided key ID is the index of key to be deleted in the one-based list of your keys. For example, to delete the first HMAC secret that you created, you would pass in a key ID value of 1.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"keyId","in":"path","description":"The index of the key to be deleted in the one-based list of your HMAC secrets.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_ConnectHMAC_DeleteConnectSecret_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/{connectId}/all/users":{"get":{"operationId":"uncategorized_Connect_GetConnectAllUsers","summary":"Returns all users from the configured Connect service.","description":"Returns all users from the configured Connect service.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"connectId","in":"path","description":"The ID of the custom Connect configuration being accessed.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"domain_users_only","in":"query","required":false,"schema":{"type":"string"}},{"name":"email_substring","in":"query","description":"Filters returned user records by full email address or a substring of email address.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The status of the item.","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","description":"Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integratedConnectUserInfoList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/{connectId}/users":{"get":{"operationId":"connect_getconnectusers","summary":"Returns users from the configured Connect service.","description":"Returns users from the configured Connect service.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"connectId","in":"path","description":"The ID of the custom Connect configuration being accessed.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.","required":false,"schema":{"type":"string"}},{"name":"email_substring","in":"query","description":"Filters returned user records by full email address or a substring of email address.","required":false,"schema":{"type":"string"}},{"name":"list_included_users","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filters the results by user status.\nYou can specify a comma-separated\nlist of the following statuses:\n\n- ActivationRequired\n- ActivationSent\n- Active\n- Closed\n- Disabled","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","description":"Filters results based on a full or partial user name.\n\n**Note:** When you enter a partial user name, you do not use a wildcard character.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integratedUserInfoList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/logs/{logId}":{"delete":{"operationId":"connect_ConnectLog_DeleteConnectLog","summary":"Deletes a specified Connect log entry.","description":"Deletes a specified entry from the Connect Log.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"logId","in":"path","description":"The ID of the Connect log entry. Use `all` to delete all entries for the account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connect_ConnectLog_DeleteConnectLog_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"connect_ConnectLog_GetConnectLog","summary":"Gets a Connect log entry.","description":"Retrieves the specified Connect log entry for your account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging.\nIf logging is not enabled, then no log entries are recorded.","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"logId","in":"path","description":"The ID of the connect log entry","required":true,"schema":{"type":"string"}},{"name":"additional_info","in":"query","description":"When **true,** the response includes the `connectDebugLog` information.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectLog"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/failures/{failureId}":{"delete":{"operationId":"connect_ConnectFailures_DeleteConnectFailureLog","summary":"Deletes a Connect failure log entry.","description":"Deletes a Connect failure log entry.\n\nTo delete all the Connect failure log entries,\nspecify `all` for the `failureId` path parameter.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"failureId","in":"path","description":"The ID of the Connect post failure. Use `all` to delete all failures for the account.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectDeleteFailureResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/logs":{"delete":{"operationId":"connect_ConnectLog_DeleteConnectLogs","summary":"Deletes a list of Connect log entries.","description":"Deletes a list of Connect log entries for your account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Connect_ConnectLog_DeleteConnectLogs_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"connect_ConnectLog_GetConnectLogs","summary":"Gets the Connect log.","description":"Retrieves a list of the 100 most recent Connect log entries for your account.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging. Log entries are deleted after 15 days.","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectLogs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/failures":{"get":{"operationId":"connect_ConnectFailures_GetConnectLogs","summary":"Gets the Connect failure log information.","description":"Retrieves the Connect failure log information.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\nUse this method to determine which envelopes failed to post.\nYou can then use\n[ConnectEvents: retryForEnvelopes](/docs/esign-rest-api/reference/connect/connectevents/retryforenvelopes/)\nto create a republish request.","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectLogs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue":{"put":{"operationId":"connect_ConnectPublish_PutConnectRetryByEnvelope","summary":"Republishes Connect information for the specified envelope.","description":"Republishes Connect information for the specified envelope.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectFailureResults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/envelopes/retry_queue":{"put":{"operationId":"connect_ConnectPublish_PutConnectRetry","summary":"Republish Connect events for envelopes","description":"Republishes Connect information for the specified set of envelopes.\n\n<Note>\nTo use this method, you must be an account administrator\nand Connect must be enabled on your account.\n</Note>\n\nThe primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [Connect::listEventLogs](/docs/esign-rest-api/reference/connect/connectevents/list/) retrieve the failure log.","tags":["connect"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectFailureResults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `connectFailureFilter`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectFailureFilter"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/tab_definitions":{"post":{"operationId":"customTabs_Tabs_PostTabDefinitions","summary":"Creates a custom tab.","description":"Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.\n\nCustom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.","tags":["customTabs"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabMetadata"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabMetadata`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabMetadata"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"customTabs_Tabs_GetTabDefinitions","summary":"Gets a list of all account tabs.","description":"Retrieves a list of all tabs associated with the account.","tags":["customTabs"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"custom_tab_only","in":"query","description":"When **true,** only custom tabs are returned in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabMetadataList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/tab_definitions/{customTabId}":{"delete":{"operationId":"customTabs_Tab_DeleteCustomTab","summary":"Deletes custom tab information.","description":"Deletes the custom from the specified account.","tags":["customTabs"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"customTabId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomTabs_Tab_DeleteCustomTab_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"customTabs_Tab_GetCustomTab","summary":"Gets custom tab information.","description":"Retrieves information about the requested custom tab on the specified account.","tags":["customTabs"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"customTabId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabMetadata"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"customTabs_Tab_PutCustomTab","summary":"Updates custom tab information.\n\n","description":"Updates the information in a custom tab for the specified account.","tags":["customTabs"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"customTabId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabMetadata"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabMetadata`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabMetadata"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/diagnostics/request_logs":{"delete":{"operationId":"diagnostics_APIRequestLog_DeleteRequestLogs","summary":"Deletes the request log files.","description":"Deletes the request log files.","tags":["diagnostics"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Diagnostics_APIRequestLog_DeleteRequestLogs_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"diagnostics_APIRequestLog_GetRequestLogs","summary":"Gets the API request logging log files.","description":"Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries.\n\nIf the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request.\n\nIf the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. ","tags":["diagnostics"],"parameters":[{"name":"encoding","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiRequestLogsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/diagnostics/request_logs/{requestLogId}":{"get":{"operationId":"diagnostics_APIRequestLog_GetRequestLog","summary":"Gets a request logging log file.","description":"Retrieves information for a single log entry.\n\n**Request**\nThe `requestLogId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.\n\n**Response**\nIf the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.","tags":["diagnostics"],"parameters":[{"name":"requestLogId","in":"path","description":"The ID of the log entry.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/diagnostics/settings":{"get":{"operationId":"diagnostics_APIRequestLog_GetRequestLogSettings","summary":"Gets the API request logging settings.","description":"Retrieves the current API request logging setting for the user and remaining log entries.\n\n**Response**\nThe response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.","tags":["diagnostics"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/diagnosticsSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"diagnostics_APIRequestLog_PutRequestLogSettings","summary":"Update request logging settings","description":"Enables or disables API request logging for troubleshooting.\n\nWhen enabled (`apiRequestLogging` is **true**),\nREST API requests and responses for the user are added to a log.\nA log can have up to 50 requests/responses\nand the current number of log entries can be determined\nby getting the settings.\nLogging is automatically disabled when the log limit of 50 is reached.\n\nYou can call\n[Diagnostics: getRequestLog](/docs/esign-rest-api/reference/diagnostics/requestlogs/get/)\nor\n[Diagnostics: listRequestLogs](/docs/esign-rest-api/reference/diagnostics/requestlogs/list/)\nto download the log files (individually or as a zip file).\nCall [Diagnostics: deleteRequestLogs](/docs/esign-rest-api/reference/diagnostics/requestlogs/delete/)\nto clear the log by deleting current entries.\n\nPrivate information, such as passwords and integration key information,\nwhich is normally located in the call header is omitted from the request/response log.\n\nAPI request logging only captures requests from the authenticated user.\nAny call that does not authenticate the user and resolve a userId is not logged.","tags":["diagnostics"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/diagnosticsSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `diagnosticsSettingsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/diagnosticsSettingsInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1":{"get":{"operationId":"diagnostics_ServiceInformation_GetResourceInformation","summary":"Lists resources for REST version specified","description":"Retrieves the base resources available for the eSignature REST API.\n\nYou do not need an integrator key to view the REST API versions and resources.","tags":["diagnostics"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resourceInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}}}},"/service_information":{"get":{"operationId":"diagnostics_ServiceInformation_GetServiceInformation","summary":"Retrieves the available REST API versions.","description":"Retrieves the available REST API versions.\n\nDocusign Production system: [https://www.docusign.net/restapi/service_information](https://www.docusign.net/restapi/service_information)\nDocusign Demo system: [https://demo.docusign.net/restapi/service_information](https://demo.docusign.net/restapi/service_information)\n\nYou do not need an integration key to view the REST API versions and resources.","tags":["diagnostics"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}}}},"/v2.1/accounts/{accountId}/settings/bcc_email_archives":{"post":{"operationId":"uncategorized_BCCEmailArchive_PostBCCEmailArchive","summary":"Creates a BCC email archive configuration.","description":"This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that Docusign generates).\n\nThe only property that you must set in the request body is the BCC email address that you want to use.\n\nSee [Email Archive Configuration﻿](https://support.docusign.com/s/document-item?language=en_US&bundleId=pik1583277475390&topicId=xjm1583277371373.html) for details and restrictions on creating or changing BCC email addresses.\n\n**Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bccEmailArchive"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `bccEmailArchive`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bccEmailArchive"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_BCCEmailArchive_GetBCCEmailArchiveList","summary":"Gets the BCC email archive configurations for an account.","description":"This method retrieves all of the BCC email archive configurations associated with an account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bccEmailArchiveList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}":{"delete":{"operationId":"uncategorized_BCCEmailArchive_DeleteBCCEmailArchive","summary":"Deletes a BCC email archive configuration.","description":"This method deletes a BCC email archive configuration from an account.\n\nWhen you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bccEmailArchiveId","in":"path","description":"The ID of the BCC email archive configuration.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_BCCEmailArchive_DeleteBCCEmailArchive_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_BCCEmailArchive_GetBCCEmailArchiveHistoryList","summary":"Get BCC email archive history","description":"This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"bccEmailArchiveId","in":"path","description":"The ID of the BCC email archive configuration.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of items to skip.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bccEmailArchiveHistoryList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}":{"put":{"operationId":"envelopes_ChunkedUploads_PutChunkedUploads","summary":"Commit a chunked upload.","description":"This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.\n\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\n\n**Note:** After you commit a chunked upload, it no longer accepts additional parts.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"(Required) The external account number (int) or account ID GUID.","required":true,"schema":{"type":"string"}},{"name":"chunkedUploadId","in":"path","description":"(Required) The ID of the chunked upload to commit.","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","description":"(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_ChunkedUploads_DeleteChunkedUpload","summary":"Deletes a chunked upload.","description":"Deletes a chunked upload that has been committed but not yet consumed.\n\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\n\n\n- Chunked uploads that have been consumed by use in another API call.\n- Expired chunked uploads.\n\n**Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"chunkedUploadId","in":"path","description":"The ID of the chunked upload.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_ChunkedUploads_GetChunkedUpload","summary":"Retrieves metadata about a chunked upload.","description":"Returns the details (but not the content) about a chunked upload.\n\n**Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"chunkedUploadId","in":"path","description":"The ID of the chunked upload.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/chunked_uploads":{"post":{"operationId":"envelopes_ChunkedUploads_PostChunkedUploads","summary":"Initiate a new ChunkedUpload.","description":"This method initiates a new chunked upload with the first part of the content.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `chunkedUploadRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}":{"put":{"operationId":"envelopes_ChunkedUploads_PutChunkedUploadPart","summary":"Add a chunk to an existing chunked upload.","description":"Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, \nuse this method to upload subsequent parts.\n\nFor simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.\n\nExample:\n\n\n```\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\n```\n\n**Note:** You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"chunkedUploadId","in":"path","description":"The ID of the chunked upload.","required":true,"schema":{"type":"string"}},{"name":"chunkedUploadPartSeq","in":"path","description":"The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`.\n\n**Note:** You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `chunkedUploadRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/chunkedUploadRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript":{"get":{"operationId":"uncategorized_Comments_GetCommentsTranscript","summary":"Gets a PDF transcript of all of the comments in an envelope.","description":"Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.\n\nThe response body of this method is the PDF file as a byte\nstream.\n\n\n**Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**). ","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"encoding","in":"query","description":"(Optional) The encoding to use for the file.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/archive_metadata":{"post":{"operationId":"uncategorized_GenAndSend_PostArchiveMetadataEnvelopes","summary":"Add archive metadata to envelopes","description":"Add metadata in the form of GenAndSend to existing envelopes in docusign.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeArchiveSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeGenAndSend`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeGenAndSend"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/generate_and_archive":{"post":{"operationId":"uncategorized_GenAndSend_PostGenAndArchiveEnvelopes","summary":"Generate and archive document","description":"Generates the document using DocuSign Spring CM template then returns the html content of the document.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeGenAndSend`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeGenAndSend"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/generate_and_convert":{"post":{"operationId":"uncategorized_GenAndSend_PostGenAndConvertEnvelopes","summary":"Generate and convert document","description":"Generates the document using DocuSign Spring CM template then returns the content of the document based on the return document type.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeGenAndSend`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeGenAndSend"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/generate_and_convert_multi":{"post":{"operationId":"uncategorized_GenAndSend_PostGenAndConvertMultiEnvelopes","summary":"Generate and convert multiple documents","description":"Generates multiple document using DocuSign Spring CM template then returns the content of the document based on the return document type.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeGenAndSend`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeGenAndSend"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/generate_and_send":{"post":{"operationId":"uncategorized_GenAndSend_PostGenAndSendEnvelopes","summary":"Generate documents and send envelope","description":"Generates the documents for an envelope using DocuSign Spring CM then creates the envelope.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeGenAndSend`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeGenAndSend"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/archive_metadata":{"post":{"operationId":"uncategorized_GenAndSend_PostLinkMetadataEnvelopes","summary":"Add envelope archive metadata","description":"Add metadata in the form of GenAndSend to existing envelopes in docusign.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelopeId Guid of the envelope being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeGenAndSend`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeGenAndSend"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields":{"get":{"operationId":"uncategorized_DocGenFormFields_GetEnvelopeDocGenFormFields","summary":"Returns sender fields for an envelope.","description":"Given an `envelopeId`, this method returns the sender fields found in that envelope's documents. After you retrieve the sender fields, use the [DocumentGeneration::updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) method to populate the fields.\n\nIf the specified envelope does not contain a document with sender fields, the method will return success (`200`) and an empty object (`{}`) in the response.\n\n### Next steps\n\n- [Learn about document generation in the eSignature concepts guide.](/docs/esign-rest-api/esign101/concepts/documents/document-generation/)\n- [Learn how to send an envelope with document generation in your preferred coding language](/docs/esign-rest-api/how-to/request-signature-email-document-generation/).","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docGenFormFieldResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_DocGenFormFields_PutEnvelopeDocGenFormFields","summary":"Updates sender fields for an envelope.","description":"This method dynamically generates an envelope's documents by populating its sender fields. The envelope must be in a draft state.\n\nUse the [DocumentGeneration::getEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/) response to retrieve the list of sender fields for your envelope. Use that list to build the request for this method. For each field, specify the field name and the value to populate.\n\nFor example, your request body might look like this:\n\n```json\n{\n  \"docGenFormFields\": [\n    {\n      \"documentId\": \"bf3202e1-xxxx-xxxx-xxxx-af4f41366879\",\n      \"docGenFormFieldList\": [\n        {\n          \"name\": \"Candidate_Name\",\n          \"value\": \"Peggy Olson\"\n        },\n        {\n          \"name\": \"Job_Title\",\n          \"value\": \"Technical Writer\"\n        },\n        {\n          \"name\": \"Manager_Name\",\n          \"value\": \"Donald Draper\"\n        },\n        {\n          \"name\": \"Start_Date\",\n          \"value\": \"1960-02-28\"\n        },\n        {\n          \"name\": \"Salary\",\n          \"value\": \"3380\"\n        }\n      ]\n    }\n  ]\n}\n```\n\n### Important notes\n\n- If `update_docgen_formfields_only` is false (the default), the `documentId` changes after the update.\n- This endpoint does not validate number, date, or select data field values. The request can succeed even if a number or date field value is not a valid number or date, or if a select field value is not one of the allowed values.\n\n### Related topics\n\n- [Learn about document generation in the eSignature concepts guide.](/docs/esign-rest-api/esign101/concepts/documents/document-generation/)\n- [See this method in use in your preferred coding language](/docs/esign-rest-api/how-to/request-signature-email-document-generation/).","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"update_docgen_formfields_only","in":"query","description":"When **false** or omitted,\nthe documents are updated.\n\nWhen **true,** only the form fields are updated. The documents are unchanged. This option is used by integrators to save form field values without merging.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docGenFormFieldResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `docGenFormFieldRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/docGenFormFieldRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview":{"post":{"operationId":"uncategorized_ResponsiveHtml_PostDocumentResponsiveHtmlPreview","summary":"Creates a preview of the responsive version of a document.","description":"Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/)\nHTML version of a specific document.\nThis method enables you to preview a PDF document\nconversion to responsive HTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitions"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentHtmlDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments":{"put":{"operationId":"envelopes_Attachments_PutAttachments","summary":"Add envelope attachments","description":"Adds one or more envelope attachments to a draft or in-process envelope.\nEach envelope can have a maximum of 12 attachments.\n\nEnvelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the Docusign web application for them.\n\nFor a list of supported file formats, see [Supported File Formats](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=xln1578456261162.html).\n\n<Note>\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n</Note>","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeAttachmentsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_Attachments_DeleteAttachments","summary":"Deletes one or more envelope attachments from a draft envelope.","description":"Deletes one or more envelope attachments from a draft envelope.\n\n<Note>\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n</Note>","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeAttachmentsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Attachments_GetAttachments","summary":"Returns a list of envelope attachments associated with a specified envelope.","description":"Returns a list of envelope attachments associated with a specified envelope.\n\n<Note>\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo get a list of user-visible attachments,\nuse [EnvelopeDocuments: get](/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/).\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n</Note>","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}":{"get":{"operationId":"envelopes_Attachments_GetAttachment","summary":"Retrieves an envelope attachment from an envelope.","description":"Retrieves an envelope attachment from an envelope.\n\n<Note>\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n</Note>","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"The unique identifier for the attachment.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Attachments_PutAttachment","summary":"Update envelope attachment","description":"Updates an envelope attachment to a draft or in-process envelope.\n\n<Note>\nIt's easy to confuse envelope attachments,\nwhich are developer-only files associated with an envelope,\nwith signer attachments.\n\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\n</Note>","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"The unique identifier for the attachment.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAttachmentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `attachment`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/attachment"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}":{"get":{"operationId":"envelopes_ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientIdLangCode","summary":"Get recipient consumer disclosure","description":"Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings.\n\nTo set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"langCode","in":"path","description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure":{"get":{"operationId":"envelopes_ConsumerDisclosure_GetConsumerDisclosureEnvelopeIdRecipientId","summary":"Get default recipient consumer disclosure","description":"Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify.\n\nThis is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\n\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"langCode","in":"query","description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consumerDisclosure"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields":{"post":{"operationId":"envelopes_CustomFields_PostCustomFields","summary":"Creates envelope custom fields for an envelope.","description":"Updates the envelope custom fields for draft and in-process envelopes.\n\n### Related topics\n\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customFields`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_CustomFields_DeleteCustomFields","summary":"Delete envelope custom fields","description":"Deletes envelope custom fields for draft and in-process envelopes.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customFields`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_CustomFields_GetCustomFields","summary":"Gets the custom field information for the specified envelope.","description":"Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the Docusign member console. The envelope custom fields are not seen by the envelope recipients.\n\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.\n\n### Related topics\n\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFieldsEnvelope"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_CustomFields_PutCustomFields","summary":"Updates envelope custom fields in an envelope.","description":"Updates the envelope custom fields in draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name.\n\n**Note:** this method will return 200 OK even if some of the updates failed, make sure to check the `errorDetails` object every time you use this endpoint.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customFields`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields":{"post":{"operationId":"envelopes_DocumentFields_PostDocumentFields","summary":"Creates custom document fields in an existing envelope document.","description":"Creates custom document fields in an existing envelope document.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentFieldsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_DocumentFields_DeleteDocumentFields","summary":"Delete envelope document fields","description":"Deletes custom document fields from an existing envelope document.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentFieldsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_DocumentFields_GetDocumentFields","summary":"Gets the custom document fields from an  existing envelope document.","description":"Retrieves the custom document field information from an existing envelope document.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_DocumentFields_PutDocumentFields","summary":"Updates existing custom document fields in an existing envelope document.","description":"Updates existing custom document fields in an existing envelope document.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentFieldsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions":{"get":{"operationId":"uncategorized_ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions","summary":"Get envelope document HTML definitions","description":"Retrieves the HTML definition used to generate a dynamically sized responsive document.\n\nIf the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body.\n\n**Note:** The `documentId` query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body.\n\n### Related topics\n\n- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The GUID of the document.\n\nExample: c671747c-xxxx-xxxx-xxxx-4a4a48e23744","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginals"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents":{"delete":{"operationId":"envelopes_Documents_DeleteDocuments","summary":"Deletes documents from a draft envelope.","description":"Deletes one or more documents from an existing envelope that has not yet been completed.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n```json\n{\n  \"documents\": [\n    {\n      \"documentId\": \"1\"\n    }\n  ]\n}\n```\n\nThe envelope status must be one of:\n\n- `created`\n- `sent`\n- `delivered`","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDefinition"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Documents_GetDocuments","summary":"Gets a list of documents in an envelope.","description":"Retrieves a list of documents associated with the specified envelope.\n\n### Related topics\n\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"documents_by_userid","in":"query","description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.","required":false,"schema":{"type":"string"}},{"name":"include_agreement_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_docgen_formfields","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"include_is_edited","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"When **true,** the response includes metadata that indicates which properties the sender can edit.","required":false,"schema":{"type":"string"}},{"name":"include_tabs","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"recipient_id","in":"query","description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work.","required":false,"schema":{"type":"string"}},{"name":"shared_user_id","in":"query","description":"The ID of a shared user that you want to impersonate in order to\nretrieve their view of the list of documents. This parameter is\nused in the context of a shared inbox (i.e., when you share\nenvelopes from one user to another through the Docusign Admin console).","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Documents_PutDocuments","summary":"Adds one or more documents to an existing envelope.","description":"Adds one or more documents to an existing envelope.\nThe tabs of the original document will be applied to the new document.\n\n**Important**: The `updateList` endpoint supports batch updates to envelope documents. A successful HTTP status does not guarantee that all documents were processed correctly. You must check the response for each `envelopeDocument`. If a document failed to update or add, its corresponding object will include an `errorDetails` indicating the reason for failure.\n\n**Note:** When adding or modifying documents for an in-process envelope,\nDocusign recommends\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nprior to making any changes.\n\nIf the file name of a document contains Unicode characters, you need to include a `Content-Disposition` header. Example:\n\n**Header:** `Content-Disposition`\n\n**Value:** `file; filename=\\\"name\\\";fileExtension=ext;documentId=1`\n\n**Note:** This method works on documents only.\nTo add recipient or document tabs,\nuse methods from the [EnvelopeRecipientTabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) resource.\n\n<Warning>\nIf HTML document files contain `<img>` elements with the `src` attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this:\n`<img src=\"data:image/gif;base64,R0lGODlh...IQAAOw==\" alt=\"Base64 encoded image\" width=\"150\" height=\"150\"/>`\n</Warning>\n\n### Related topics\n\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}":{"get":{"operationId":"envelopes_Documents_GetDocument","summary":"Retrieves a single document or all documents from an envelope.","description":"Retrieves a single document or all documents from an envelope.\n\nTo retrieve a single document, provide the ID of the document in the `documentId` path parameter.\nAlternatively, by setting the `documentId` parameter to special keyword values,\nyou can retrieve all the documents (as a combined PDF, portfolio PDF, or ZIP archive)\nor just the certificate of completion. See the `documentId` description for how to retrieve each format.\n\nThe response body of this method\nis a file. If you request multiple documents,\nthe result is a ZIP archive\nthat contains all of the documents.\n\nIn all other cases, the response is a PDF\nfile or PDF portfolio.\n\nYou can get the file name and document ID from the response's `Content-Disposition` header:\n\n```text\nContent-Disposition: file; filename=\"NDA.pdf\"; documentid=\"1\n```\n\nBy default, the response is the PDF file\nas a byte stream.\nFor example a request/response in `curl` looks like this:\n\n```bash\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n       --header 'Authorization: Bearer eyJ...bqg'\n\nHTTP/1.1 200 OK\nContent-Length: 167539\nContent-Type: application/pdf\n. . .\nContent-Disposition: file; filename=\"Lorem_Ipsum.pdf\"; documentid=\"1\"\nDate: Tue, 23 Aug 2022 01:13:15 GMT\n%PDF-1.4\n%˚¸˝˛\n6 0 obj\n<</Length 14>>stream\n. . .\n```\n\nBy using the `Content-Transfer-Encoding`\nheader in the request, you can obtain the PDF file\nencoded in base64. The same `curl` request with\nthe base64 header would look like this:\n\n```bash\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\n       --header 'Authorization: Bearer eyJ...bqg' \\\n       --header 'Content-Transfer-Encoding: base64'\n\nHTTP/1.1 200 OK\nContent-Length: 223384\nContent-Type: application/pdf\n. . .\nContent-Disposition: file; filename=\"Lorem_Ipsum.pdf\"; documentid=\"1\"\nContent-Transfer-Encoding: base64\nDate: Tue, 23 Aug 2022 01:12:30 GMT\nJVBERi0xLjQKJfv8/f4KNiAwIG9iago8PC9MZW. . .==\n```\n\n(In an actual `curl` request you would use the `--output` switch to\nsave the byte stream into a file.)\n\n### Related topics\n\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The ID of the document to retrieve. Alternatively, you can use one of the following special keywords:\n\n- `combined`: Retrieves all of the documents as a single PDF file.\nWhen the query parameter `certificate` is **true,** the certificate of completion is included in the PDF file.\nWhen the query parameter `certificate` is **false,** the certificate of completion is not included in the PDF file.\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the certificate of completion.\n- `certificate`: Retrieves only the certificate of completion as a PDF file.\n- `portfolio`: Retrieves the envelope documents as a [PDF portfolio](https://helpx.adobe.com/acrobat/using/overview-pdf-portfolios.html).","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"certificate","in":"query","description":"Used only when the `documentId` parameter is the special keyword `combined`.\n\nWhen **true,** the certificate of completion is included in the combined PDF file.\nWhen **false,** (the default) the certificate of completion is not included in the combined PDF file.","required":false,"schema":{"type":"string"}},{"name":"documents_by_userid","in":"query","description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.","required":false,"schema":{"type":"string"}},{"name":"encoding","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"encrypt","in":"query","description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the Docusign Security Appliance Installation Guide that your organization received from Docusign.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).","required":false,"schema":{"type":"string"}},{"name":"recipient_id","in":"query","description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work.","required":false,"schema":{"type":"string"}},{"name":"shared_user_id","in":"query","description":"The ID of a shared user that you want to impersonate in order to\nretrieve their view of the list of documents. This parameter is\nused in the context of a shared inbox (i.e., when you share\nenvelopes from one user to another through the Docusign Admin console).","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","description":"When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the **Highlight Data Changes** feature enabled.","required":false,"schema":{"type":"string"}},{"name":"watermark","in":"query","description":"When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Documents_PutDocument","summary":"Adds or replaces a document in an existing envelope.","description":"Adds or replaces a document in an existing draft or in-process envelope.\nAn in-process envelope is one that has been sent but not yet completed or voided.\n\n**Note:** When adding or modifying documents for an in-process envelope,\nDocusign recommends\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nprior to making any changes.\n\nTo add a new document, set the `documentId` path parameter to a new document ID.\n\nTo replace a document, set the `documentId` path parameter to the document ID of the existing document.\nThe tabs of the original document will be applied to the new document.\nFor example, a request in cURL looks like this:\n\n```bash\n$ curl --location --request PUT 'https://demo.docusign.net/restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1' \\\n    --header 'Authorization: Bearer eyJ...bqg' \\\n    --header 'Content-Disposition: filename=\"newDocument\"' \\\n    --header 'Content-Type: application/pdf' \\\n    --data-binary '@/location/of/document.pdf'\n```\n\n<Warning>\nIf HTML document files contain `<img>` elements with the `src` attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this:\n`<img src=\"data:image/gif;base64,R0lGODlh...IQAAOw==\" alt=\"Base64 encoded image\" width=\"150\" height=\"150\"/>`\n</Warning>\n\n### Related topics\n\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)\n- [How-to guides for working with envelopes](/docs/esign-rest-api/how-to/#working-with-documents)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDocument"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"Updated document content.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/archivedocuments/{documentId}":{"get":{"operationId":"uncategorized_GenAndSend_GetArchiveDocument","summary":"Return generated html document from archive.","description":"Return generated html document from archive.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The ID of the document being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs":{"post":{"operationId":"uncategorized_Tabs_PostDocumentTabs","summary":"Adds tabs to a document in an envelope.","description":"Adds tabs to the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\n<Note>\nThis method operates only on\n[`smartSection`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_smartsectiontabs)\nand\n[`polyLineOverlay`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_polylineoverlaytabs)\ntabs.\n</Note>","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_Tabs_DeleteDocumentTabs","summary":"Deletes tabs from a document in an envelope.","description":"Deletes tabs from the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Tabs_GetDocumentTabs","summary":"Returns the tabs on a document.","description":"Returns the tabs on the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"When **true,** the response includes metadata indicating which properties are editable.","required":false,"schema":{"type":"string"}},{"name":"page_numbers","in":"query","description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\n\nExample: `page_numbers=2,6`\n\nNote: You can only enter individual page numbers, and not a page range.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_Tabs_PutDocumentTabs","summary":"Updates the tabs for document.","description":"Updates tabs in the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n\n<Note>\nThis method operates only on\n[`smartSection`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_smartsectiontabs)\nand\n[`polyLineOverlay`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_polylineoverlaytabs)\ntabs.\n</Note>","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs":{"get":{"operationId":"envelopes_Tabs_GetPageTabs","summary":"Returns tabs on the specified page.","description":"Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\nenvelope specified by `envelopeId`.\n","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility":{"get":{"operationId":"envelopes_Recipients_GetRecipientDocumentVisibility","summary":"Returns document visibility for a recipient","description":"This method returns information about document visibility for a recipient.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Recipients_PutRecipientDocumentVisibility","summary":"Updates document visibility for a recipient","description":"This method updates document visibility for a recipient.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentVisibilityList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility":{"put":{"operationId":"envelopes_Recipients_PutRecipientsDocumentVisibility","summary":"Updates document visibility for recipients","description":"This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentVisibilityList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings":{"post":{"operationId":"envelopes_EmailSettings_PostEmailSettings","summary":"Adds email setting overrides to an envelope.","description":"Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.\n\nThe [BCC Email address](https://support.docusign.com/s/document-item?language=en_US&bundleId=pik1583277475390&topicId=xjm1583277371373.html) feature is designed to provide a copy of all email communications for external archiving purposes.\nTo send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.\n\n**Note:** Docusign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `emailSettings`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_EmailSettings_DeleteEmailSettings","summary":"Deletes the email setting overrides for an envelope.","description":"Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_EmailSettings_GetEmailSettings","summary":"Gets the email setting overrides for an envelope.","description":"Retrieves the email override settings for the specified envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_EmailSettings_PutEmailSettings","summary":"Updates the email setting overrides for an envelope.","description":"Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `emailSettings`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data":{"get":{"operationId":"envelopes_FormData_GetFormData","summary":"Returns envelope tab data for an existing envelope.","description":"This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.\n\n**Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account.\n\n### Related topics\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeFormData"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions":{"get":{"operationId":"uncategorized_ResponsiveHtml_GetEnvelopeHtmlDefinitions","summary":"Get envelope HTML definitions","description":"Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginals"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock":{"post":{"operationId":"envelopes_Lock_PostEnvelopeLock","summary":"Locks an envelope.","description":"This method locks the specified envelope and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the envelope.\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates an envelope)\nwhile the envelope is locked.\n\nIf you do not provide the `lockToken` when accessing\na locked envelope, you will get the following\nerror:\n\n```json\n{\n   \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n   \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n\n```json\n{\n  \"LockToken\": \"token-from-response\",\n  \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n\n```xml\n<DocuSignEdit>\n  <LockToken>token-from-response</LockToken>\n  <LockDurationInSeconds>600</LockDurationInSeconds>\n</DocuSignEdit>\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```text\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n    or\nX-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>\n```\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `lockRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_Lock_DeleteEnvelopeLock","summary":"Deletes an envelope lock.","description":"Deletes the lock from the specified envelope.\nThe user deleting the lock must be the same user\nwho locked the envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\nThis method takes an optional query parameter\nthat lets you specify whether\nchanges made while the envelope was locked\nare kept or discarded.\n\n| Query Parameter | Description |\n| --- | --- |\n| `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Lock_GetEnvelopeLock","summary":"Gets envelope lock information.","description":"Retrieves general information about an envelope lock.\n\nThe user requesting the information must be the same user\nwho locked the envelope.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked envelope.\nThe `X-DocuSign-Edit` header is included in the response. If the envelope referenced in the request is not locked, this method returns a 404 error including the error code EDIT_LOCK_ENVELOPE_NOT_LOCKED.\n\nSee [EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Lock_PutEnvelopeLock","summary":"Updates an envelope lock.","description":"Updates the lock information for a locked envelope.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\n\nUse this method to change the duration\nof the lock (`lockDurationInSeconds`)\nor the `lockedByApp` string.\n\nThe request body is a full `lockRequest` object,\nbut you only need to specify the\nproperties that you are updating. For example:\n\n```json\n{\n  \"lockDurationInSeconds\": \"3600\",\n  \"lockedByApp\": \"My Application\"\n}\n```","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `lockRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/connect/envelopes/publish/historical":{"post":{"operationId":"uncategorized_HistoricalEnvelopePublish_PostHistoricalEnvelopePublishTransaction","summary":"Republish historical envelopes","description":"This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the `urlToPublishTo` request body parameter.\n\n<Note>\nYou can publish up to a maximum of 9999 envelopes per hour.\n</Note>\n\nThis endpoint does not call an existing Connect configuration or create a new Connect listener to monitor new activity. It simply uses an ad hoc configuration to submit existing envelopes. You must include all the configuration data in the request body.\n\nThe envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported.\n\nYour request should match the following format:\n\n```json\n{\n    \"envelopes\": [\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\", \"8373a938-xxxx-xxxx-xxxx-e992a2abae01\"],\n    \"config\": {\n        \"configurationType\":\"custom\",\n        \"name\": \"Test\",\n        \"urlToPublishTo\":\"YOUR-WEBHOOK-URL\",\n        \"allowEnvelopePublish\": \"true\",\n        \"enableLog\": \"true\",\n        \"requiresAcknowledgement\": \"true\",\n        \"IncludeHMAC\": \"true\",\n        \"SignMessageWithX509Cert\": \"true\",\n        \"deliveryMode\": \"SIM\",\n        \"eventData\": {\n            \"version\": \"restv2.1\",\n            \"format\": \"json\",\n            \"includedata\": [\"tabs\",\"payment_tabs\",\"custom_fields\",\"powerform\",\"recipients\",\"folders\",\"extensions\",\"attachments\", \"prefill_tabs\", \"documents\"]\n        }\n    }\n}\n```\n\nIf the request succeeds, it returns a 201 (Created) HTTP response code and the response body property `processingStatus` will be set to `processing`. You can then view the status of each historical republish request in the [Bulk Actions Log](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=nvf1648497452396.html).","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopePublishTransaction"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `connectHistoricalEnvelopeRepublish`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectHistoricalEnvelopeRepublish"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients":{"post":{"operationId":"envelopes_Recipients_PostRecipients","summary":"Adds one or more recipients to an envelope.","description":"Adds one or more recipients to an envelope.\n\nFor an in-process envelope,\none that has been sent and has not been completed or voided,\nan email is sent to a new recipient\nwhen they are reached in the routing order.\nIf the new recipient's routing order\nis before or the same as the envelope's\nnext recipient,\nan email is only sent if the optional\n`resend_envelope` query string is set to **true.**\n\n**Note:** This endpoint creates or updates recipients in an envelope. It does not create or manage recipient tabs. Tabs included in the request body are ignored; to create, update, or remove recipient tabs after recipients are created, use the [**EnvelopeRecipientTabs** Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\n```json\n{\n  \"signers\": [\n    {\n      \"email\": \"astanton@example.com\",\n      \"name\": \"Anne Stanton\",\n      \"recipientId\": \"1\",\n      \"tabs\": {           // These tabs will NOT be added\n        \"signHereTabs\": [ // with this method. See note above.\n          {\n            \"anchorString\": \"below\",\n            \"tooltip\": \"please sign here\"\n          },\n          . . .\n        ]\n      }\n    }\n  ]\n}\n```\n\n### Related topics\n\n- See the [Tabs](/docs/esign-rest-api/esign101/concepts/tabs/) concept guide for details on tab types and how to use them with the eSignature API.\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n- [How to request a signature by email](/docs/esign-rest-api/how-to/request-signature-email-remote/)\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"resend_envelope","in":"query","description":"When **true,**\nforces the envelope to be resent\nif it would not be resent otherwise.\n\nOrdinarily, if the recipient's routing order\nis before or the same as the envelope's next recipient,\nthe envelope is not resent.\n\nSetting this query parameter\nto **false** has no effect and is the same as omitting\nit altogether.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_Recipients_DeleteRecipients","summary":"Deletes recipients from an envelope.","description":"Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the `recipientId` as the key for deleting recipients.\n\nIf the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Recipients_GetRecipients","summary":"Gets the status of recipients for an envelope.","description":"Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.\n\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.\n\n### Related topics\n\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\n- [How to retrieve ID Evidence events](/docs/idevidence-api/how-to/retrieve-idevidence-events/)\n- [How to retrieve ID Evidence media](/docs/idevidence-api/how-to/retrieve-idevidence-media/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"include_anchor_tab_locations","in":"query","description":"When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response.","required":false,"schema":{"type":"string"}},{"name":"include_extended","in":"query","description":"When **true,** the extended properties are included in the response.","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).","required":false,"schema":{"type":"string"}},{"name":"include_tabs","in":"query","description":"When **true,** the tab information associated with the recipient is included in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Recipients_PutRecipients","summary":"Update or correct envelope recipients","description":"Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.\n\nIf you send information for a recipient that does not already\nexist in a draft envelope, the recipient is added to the envelope\n(similar to the [EnvelopeRecipients: Create](/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/) method).\n\nYou can also use this method to resend an envelope to a recipient\nby using the `resend_envelope` option.\n\n**Updating Sent Envelopes**\n\nAfter an envelope has been sent, you can edit only the following properties:\n\n- `accessCode`\n- `agentCanEditName`\n- `agentCanEditEmail`\n- `customFields`\n- `deliveryMethod`\n- `documentVisibility`\n- `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)\n- `emailNotification`\n- `idCheckConfigurationName`\n- `identityVerification`\n- `name`\n- `note`\n- `phoneAuthentication`\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\n- `requireIdLookup`\n- `routingOrder`\n- `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)\n- `smsAuthentication`\n- `suppressEmails`\n- `userName`\n\nIf the recipient has signed,\nbut the envelope is still active,\nthe method will return success,\nbut the `recipientUpdateResults` property\nin the response will include an error\nthat the recipient could not be updated:\n\n```json\n{\n  \"recipientUpdateResults\": [\n    {\n      \"recipientId\": \"999\",\n      \"errorDetails\": {\n        \"errorCode\": \"RECIPIENT_UPDATE_FAILED\",\n        \"message\": \"The recipient could not be updated.  Recipient not in state that allows correction.\"\n      }\n    }\n  ]\n}\n```\n\nIf the envelope is completed,\nand you try to change a recipient's address,\nthe method will fail with this error:\n\n```json\n{\n  \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n  \"message\": \"Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct.\"\n}\n```\n\n**Note:** This method works on recipients only.\nTo add recipient tabs,\nuse methods from the [EnvelopeRecipientTabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) resource.\nFor example, this request body will add a recipient (`astanton@example.com`)\nbut **NOT** the Sign Here recipient tab.\n\n```json\n{\n  \"signers\": [\n    {\n      \"email\": \"astanton@example.com\",\n      \"name\": \"Anne Stanton\",\n      \"recipientId\": \"1\",\n// THIS WILL NOT WORK\n      \"tabs\": {\n        \"signHereTabs\": [\n          {\n            \"anchorString\": \"below\",\n            \"tooltip\": \"please sign here3\"\n          },\n          . . .\n        ]\n      }\n    }\n  ]\n}\n```","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"combine_same_order_recipients","in":"query","description":"When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=fxo1578456612662.html), and is based on Recipient Role and Routing Order.","required":false,"schema":{"type":"string"}},{"name":"offline_signing","in":"query","description":"Indicates if offline signing is enabled for the recipient when a network connection is unavailable.","required":false,"schema":{"type":"string"}},{"name":"resend_envelope","in":"query","description":"When **true,**\nforces the envelope to be resent\nif it would not be resent otherwise.\n\nOrdinarily, if the recipient's routing order\nis before or the same as the envelope's next recipient,\nthe envelope is not resent.\n\nSetting this query parameter\nto **false** has no effect and is the same as omitting\nit altogether.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipientsUpdateSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview":{"post":{"operationId":"uncategorized_Views_PostEnvelopeRecipientPreview","summary":"Creates an envelope recipient preview.","description":"Returns a URL to preview the recipients' view of a draft envelope or template. You can embed this view in your application to enable the sender to preview the recipients' experience.\n\nYou must specify a `returnUrl` value in the request body.\n\nFor more information, see [Preview and Send](https://support.docusign.com/s/document-item?bundleId=ulp1643236876813&topicId=oeg1578456408976.html).","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipientPreviewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipientPreviewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review":{"post":{"operationId":"uncategorized_Views_PostRecipientManualReviewView","summary":"Create the link to the page for manually reviewing IDs.","description":"This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient. ","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"A value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field in the [AppsI and Keys](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=pmp1583277397015.html) page.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","description":"A GUID value that Docusign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account.\n\nThe specified recipient must belong to a workflow that allows the [manual review](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=eya1583277454804.html) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](/docs/esign-rest-api/reference/envelopes/envelopes/get/) method:\n\n```text\n\"recipientAuthenticationStatus\": {\n       \"identityVerificationResult\": {\n             \"status\": \"Failed\",\n             \"eventTimestamp\": \"2020-09-04T16:59:42.8045667Z\",\n             \"vendorFailureStatusCode\": \"MANUAL_REVIEW_STARTED\"\n        }\n  }\n```","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token":{"post":{"operationId":"uncategorized_Recipients_PostRecipientProofFileResourceToken","summary":"Create identity proof token","description":"Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).\n\n### Related topics\n\n- [How to retrieve ID Evidence events](/docs/idevidence-api/how-to/retrieve-idevidence-events/)\n- [How to retrieve ID Evidence media](/docs/idevidence-api/how-to/retrieve-idevidence-media/)","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The account ID.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","description":"The `recipientIdGuid`.","required":true,"schema":{"type":"string"}},{"name":"token_scopes","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/idEvidenceResourceToken"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}":{"delete":{"operationId":"envelopes_Recipients_DeleteRecipient","summary":"Deletes a recipient from an envelope.","description":"Deletes a recipient from a `draft` or `sent` envelope.\n\nIf the envelope is \"In Process\" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs":{"post":{"operationId":"envelopes_Recipients_PostRecipientTabs","summary":"Adds tabs for a recipient.","description":"Adds one or more tabs for a recipient.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"envelopes_Recipients_DeleteRecipientTabs","summary":"Deletes the tabs associated with a recipient. **Note:** It is an error to delete a tab that has the `templateLocked` property set to true. This property corresponds to the **Restrict changes** option in the web app.","description":"Deletes one or more tabs associated with a recipient in a draft envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Recipients_GetRecipientTabs","summary":"List envelope recipient tabs","description":"Retrieves information about the tabs associated\nwith a recipient. You can make a single API call\nto get all the tab values and information from a\ngiven, completed envelope in addition to draft\nones. Tab values can be retrieved by using the\n[EnvelopeRecipients:list method](/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/)\nwith query parameter `include_tabs` set to **true.**","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"include_anchor_tab_locations","in":"query","description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"When **true,** the response includes metadata indicating which properties are editable.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Recipients_PutRecipientTabs","summary":"Updates the tabs for a recipient.\n\n","description":"Updates one or more tabs for a recipient in a draft envelope.\nA draft envelope is one that is not yet complete.\n\n**Note:** it is an error to update a tab if the recipient associated with this tab is not in `created` status. If the envelope has already been sent, you must use the Correct Flow and lock the envelope before you can update any of its tabs.\n\n**Note:** this method will return 200 OK even if some of the updates failed. Make sure to check the `errorDetails` object every time you use this endpoint.\n`templateLocked` property set to `true`.\nThis property corresponds to the **Restrict changes** option in the web app.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `tabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes":{"post":{"operationId":"envelopes_postenvelopes","summary":"Creates an envelope.","description":"Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the Docusign platform.\n\nWith this method you can:\n\n- Create and send an envelope\nwith [documents](/docs/esign-rest-api/esign101/concepts/documents/), [recipients](/docs/esign-rest-api/esign101/concepts/recipients/), and [tabs](/docs/esign-rest-api/esign101/concepts/tabs/).\n- [Create and send an envelope from a template](/docs/esign-rest-api/esign101/concepts/templates/).\n- [Create and send an envelope from a combination of documents and templates](/docs/esign-rest-api/esign101/concepts/templates/composite/).\n- Create a draft envelope.\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition) object) are required:\n\n| Parameter | Description |\n| --- | --- |\n| `status` | Set to `sent` to send the envelope to recipients. Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents` | The [documents](/docs/esign-rest-api/esign101/concepts/documents/) to be signed. |\n| `recipients` | The email addresses of the envelope [recipients](/docs/esign-rest-api/esign101/concepts/recipients/). |\n\nWhen you create an envelope by using a\n[composite template](/docs/esign-rest-api/esign101/concepts/templates/composite/),\nyou should specify the envelope custom fields in the inline template.\nAny custom fields that you specify at the root level are ignored.\n\nIf the envelope has a workflow definition\nand the `workflowStatus` is `paused`,\nthe envelope will not be sent immediately,\neven if the envelope's `status` is `sent`.\n\n### Related topics\n\n[Envelope](/docs/esign-rest-api/esign101/concepts/envelopes/) and [template](/docs/esign-rest-api/esign101/concepts/templates/)\nobjects along with [documents](/docs/esign-rest-api/esign101/concepts/documents/),\n[recipients](/docs/esign-rest-api/esign101/concepts/recipients/), and [tabs](/docs/esign-rest-api/esign101/concepts/tabs/)\nare the five object models at the core of the eSignature API.\nThe [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)\ndescribes how the five object models work together.\n\nThe following how-to articles contain\npractical examples that show you how to\nto\nconfigure this method's\n[`envelopeDefinition`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition) request body\nto perform common tasks.\n\nRequesting a signature\n\n- [How to request a signature by email](/docs/esign-rest-api/how-to/request-signature-email-remote/)\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)\n- [How to request a signature by email using a template](/docs/esign-rest-api/how-to/request-signature-template-remote/)\n- [How to request a signature using a composite template](/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)\n- [How to send a request for payment](/docs/esign-rest-api/how-to/request-a-payment/)\n- [How to send an envelope to an In Person Signer](/docs/esign-rest-api/how-to/send-envelope-to-in-person-signer/)\n- [How to request a signature by email using CORS](/docs/esign-rest-api/how-to/request-signature-email-browser-cors/)\n- [How to request a signature through your CORS-enabled browser app](/docs/esign-rest-api/how-to/request-signature-in-cors-app-embedded/)\n- [How to request a signature through your app (embedded signing) with a CFR Part 11 account](/docs/esign-rest-api/how-to/request-signature-in-app-embedded-cfrpart11/)\n\nWorking with envelopes and templates\n\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\n\nWorking with advanced recipient routing\n\n- [How to pause a signature workflow](/docs/esign-rest-api/how-to/pause-workflow/)\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)\n- [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/)\n- [How to schedule an envelope](/docs/esign-rest-api/how-to/schedule-an-envelope/)\n- [How to send an envelope with delayed routing](/docs/esign-rest-api/how-to/send-envelope-with-delayed-routing/)\n\nWorking with documents\n\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\n- [How to attach documents via binary transfer](/docs/esign-rest-api/how-to/send-binary/)\n- [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/)\n- [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)\n- [How to set document visibility for envelope recipients](/docs/esign-rest-api/how-to/set-document-visibility/)\n- [How to request a signature by email with document generation](/docs/esign-rest-api/how-to/request-signature-email-document-generation/)\n\nWorking with tabs\n\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)\n- [How to set envelope tab values](/docs/esign-rest-api/how-to/set-envelope-tab-values/)\n- [How to set tab values in a template](/docs/esign-rest-api/how-to/set-template-tab-values/)\n\nWorking with brands\n\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\n- [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)\n- [How to apply a brand and template to an envelope](/docs/esign-rest-api/how-to/apply-brand-and-template-to-envelope/)\n\nWorking with permissions\n\n- [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)\n- [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\n- [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)\n\nImplementing multi-factor recipient (signer) authentication\n\n- [How to require ID verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)\n- [How to require knowledge-based authentication (KBA) for a recipient](/docs/esign-rest-api/how-to/knowledge-based-authentication/)\n- [How to require phone authentication for a recipient](/docs/esign-rest-api/how-to/phone-auth/)\n- [How to require access code authentication for a recipient](/docs/esign-rest-api/how-to/require-access-code-recipient/)\n\nAPI service limits\n\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"cdse_mode","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"change_routing_order","in":"query","description":"When true, users can define the routing order of recipients while sending documents for signature.","required":false,"schema":{"type":"string"}},{"name":"completed_documents_only","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"merge_roles_on_draft","in":"query","description":"When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)\n\n**Note:** Docusign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.","required":false,"schema":{"type":"string"}},{"name":"tab_label_exact_matches","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDefinition"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_getenvelopes","summary":"List envelope status changes","description":"This method lets you [search for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/) in your accounts. A large set of filters let you narrow the scope of your search by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters:\n\n- `from_date`\n- `envelope_ids`\n- `transaction_ids`\n\n### Restrictions\n\n**Number of envelopes**\n\nThe number of envelopes returned is limited to 1,000 per call. To retrieve the next or previous set of envelopes, use the `nextUri` and `previousUri` parameters returned in the original call's response.\n\n**Date range**\n\nIf no `from_date` query parameter is specified, envelopes from more than two years ago will not be returned. To fetch older envelopes, set the specific date range using the `from_date` and `to_date` parameters.\n\n**Zero-size response check**\n\nTo avoid unnecessary database queries, the Docusign signature platform first checks requests to ensure that the filter set supplied does not result in a zero-size response before querying the database.\n\n**Cross-site envelopes in production**\n\nWhen using this endpoint in production, you cannot retrieve documents across different sites (NA2, EU1, CA, etc.). You can only obtain documents sent from the same site (URL).\nIf your account has envelopes on multiple production sites and you want to download their documents, you must make separate API calls to each site (URL) to retrieve the documents from all envelopes.\n\n### Envelope statuses\n\nThis table shows the valid current envelope statuses (`status` parameter) for the different status qualifiers (`from_to_status` parameter) in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the Valid Current Statuses column, then an empty list is returned.\n\nClient applications should check that the statuses (`status` parameter) they are requesting make sense for a given `from_to_status` parameter value.\n\n| Status Qualifier (`from_to_status`) | Effective Status Qualifier | Valid Current Statuses |\n| --- | --- | --- |\n| any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted |\n| sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted |\n| delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted |\n| signed | StatusChanged | any, signed, completed, declined, voided, deleted |\n| completed | Completed | any, completed, declined, voided, deleted |\n| declined | StatusChanged | any, declined, voided, deleted |\n| timedout always return zero results | StatusChanged | any, voided, deleted |\n| voided | Voided | any, voided, deleted |\n| deleted | StatusChanged | any, deleted |\n\n### Extraneous results\n\nIn some cases, a request for a specific envelope status will\ninclude envelopes with additional statuses. For example, in\na request with a `from_date` of 2017-01-01, a `to_date` of\n2017-01-07 and the status qualifier (`from_to_status`) set\nto `delivered`, the response set might contain envelopes\nthat were created during that time period, but not delivered\nduring the time period. As a workaround, check the envelope\nstatus values in the result set as needed.\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"ac_status","in":"query","description":"Specifies the authoritative copy status for the envelopes. Valid values:\n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`","required":false,"schema":{"type":"string"}},{"name":"block","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"cdse_mode","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"continuation_token","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nThe maximum value is 1000. To get the next or previous set of envelopes, use `nextUri` or `previousUri` from the response.","required":false,"schema":{"type":"string"}},{"name":"custom_field","in":"query","description":"Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`\n\nExample: If you have an envelope custom field named \"Region\" and you want to search for all envelopes where the value is \"West\" you would use set this parameter to `Region=West`.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Limit results to envelopes\nsent by the account user\nwith this email address.\n\n`user_name` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.","required":false,"schema":{"type":"string"}},{"name":"envelope_ids","in":"query","description":"Comma separated list of `envelopeId` values.","required":false,"schema":{"type":"string"}},{"name":"exclude","in":"query","description":"Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`).\n\nValid values:\n\n- `recipients`\n- `powerforms`\n- `folders`","required":false,"schema":{"type":"string"}},{"name":"folder_ids","in":"query","description":"Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder GUIDs or the following values:\n\n- `awaiting_my_signature`\n- `completed`\n- `draft`\n- `drafts`\n- `expiring_soon`\n- `inbox`\n- `out_for_signature`\n- `recyclebin`\n- `sentitems`\n- `waiting_for_others`","required":false,"schema":{"type":"string"}},{"name":"folder_types","in":"query","description":"Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values:\n\n- `normal`\n- `inbox`\n- `sentitems`\n- `draft`\n- `templates`","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are set.\n\nAlthough you can use any date format supported by the .NET system library's [`DateTime.Parse()`](https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads) function, Docusign recommends using [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format dates with an explicit time zone offset. If you do not provide a time zone offset, the method uses the server's time zone.\n\nFor example, the following dates and times refer to the same instant:\n\n- `2017-05-02T01:44Z`\n- `2017-05-01T21:44-04:00`\n- `2017-05-01T18:44-07:00`\n\nIf this property is not included, envelopes from the last two years will be returned.","required":false,"schema":{"type":"string"}},{"name":"from_to_status","in":"query","description":"This is the status type checked for in the `from_date`/`to_date` period. For example, if `Created` is specified, then envelopes created during the period are found. If `Changed` is specified, then envelopes that changed status during the period are returned. The default value is `Changed`.\n\nValid values:\n\n- `Changed`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Processing`","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Specifies additional information to return about the envelopes.\nUse a comma-separated list, such as `folders, recipients` to specify information.\nValid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope. See the Restrictions section above for more information.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: Information about the email settings associated with the envelope.\n- `folders`: The folders where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.","required":false,"schema":{"type":"string"}},{"name":"include_purge_information","in":"query","description":"When **true,** information about envelopes that have been deleted is included in the response.","required":false,"schema":{"type":"string"}},{"name":"intersecting_folder_ids","in":"query","description":"A comma-separated list of folders from which you want to get envelopes. Valid values:\n\n- `normal`\n- `inbox`\n- `sentitems`\n- `draft`\n- `templates`","required":false,"schema":{"type":"string"}},{"name":"last_queried_date","in":"query","description":"Returns envelopes that were modified prior to the specified date and time.\n\nExample: `2020-05-09T21:56:12.2500000Z`","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Returns envelopes in either ascending (`asc`) or descending (`desc`) order.","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"Sorts results according to a specific property. Valid values:\n\n- `last_modified`\n- `action_required`\n- `created`\n- `completed`\n- `envelope_name`\n- `expire`\n- `sent`\n- `signer_list`\n- `status`\n- `subject`\n- `user_name`\n- `status_changed`\n- `last_modified`","required":false,"schema":{"type":"string"}},{"name":"powerformids","in":"query","description":"A comma-separated list of `PowerFormId` values.","required":false,"schema":{"type":"string"}},{"name":"query_budget","in":"query","description":"The time in seconds that the query should run before returning data.","required":false,"schema":{"type":"string"}},{"name":"requester_date_format","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_mode","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Free text search criteria that you can use to filter the list of envelopes that is returned.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"A comma-separated list of current envelope statuses to be included in the response. Valid values:\n\n- `completed`\n- `created`\n- `declined`\n- `deleted`\n- `delivered`\n- `processing`\n- `sent`\n- `signed`\n- `timedout`\n- `voided`\n\nThe `any` value is equivalent to any status.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Specifies the date and time\nto stop looking for status changes.\nThe default is the current date and time.\n\nAlthough you can use any date format\nsupported by the .NET system library's\n[`DateTime.Parse()`](https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads) function,\nDocusign recommends\nusing [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format dates\nwith an explicit time zone offset\nIf you do not provide\na time zone offset,\nthe method uses the server's time zone.\n\nFor example, the following dates and times refer to the same instant:\n\n- `2017-05-02T01:44Z`\n- `2017-05-01T21:44-04:00`\n- `2017-05-01T18:44-07:00`","required":false,"schema":{"type":"string"}},{"name":"transaction_ids","in":"query","description":"A comma-separated list of envelope transaction IDs.\n\nGetting envelope status by transaction IDs is useful for offline signing situations to determine if an envelope was created or not. It can be used for the cases where a network connection was lost before the envelope status could be returned.\n\n**Note:** Transaction IDs are only valid in the Docusign system for seven days.","required":false,"schema":{"type":"string"}},{"name":"user_filter","in":"query","description":"Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid values are:\n\n- `sender`\n- `recipient`\n- `recipient_only`","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.","required":false,"schema":{"type":"string"}},{"name":"user_name","in":"query","description":"Limit results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}":{"delete":{"operationId":"envelopes_Pages_DeletePage","summary":"Deletes a page from a document in an envelope.","description":"Deletes a page from a document in an envelope based on the page number.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelopes_Pages_DeletePage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}":{"get":{"operationId":"envelopes_getenvelope","summary":"Gets the status of a single envelope.","description":"Retrieves the overall status for the specified envelope.\nTo get the status of a list of envelopes, use\n[Envelope: listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/).\n\n### Related topics\n\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"advanced_update","in":"query","description":"When true, envelope information can be added or modified.","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\n\n- `custom_fields`: The custom fields associated with the envelope.\n- `documents`: The documents associated with the envelope.\n- `document_fields`: The custom fields of the documents associated with the envelope.\n- `attachments`: The attachments associated with the envelope.\n- `extensions`: The email settings associated with the envelope.\n- `folders`: The folder where the envelope exists.\n- `recipients`: The recipients associated with the envelope.\n- `powerform`: The PowerForms associated with the envelope.\n- `prefill_tabs`: The pre-filled tabs associated with the envelope.\n- `tabs`: The tabs associated with the envelope.\n- `payment_tabs`: The payment tabs associated with the envelope.\n- `workflow`: The workflow definition associated with the envelope.","required":false,"schema":{"type":"string"}},{"name":"include_anchor_tab_locations","in":"query","description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelope"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_putenvelope","summary":"Send, void, or modify a draft envelope. Purge documents from a completed envelope.","description":"This method enables you to make changes to an envelope.\nYou can use it to:\n\n- [Send a draft envelope](#sending-a-draft-envelope)\n- [Void an in-process envelope](#voiding-an-in-process-envelope)\n- [Modify a draft envelope](#modifying-envelope-email-information)\n- [Purge documents and envelope metadata from the Docusign platform](#purging-documents-from-docusign)\n\nAlthough the request body for this method\nis a complete envelope definition,\nyou only need to provide\nthe properties that\nyou're updating.\n\n## Sending a draft envelope\n\nTo send a draft envelope, include the following code in the request body:\n\n```json\n{\n  \"status\": \"sent\"\n}\n```\n\nYou can attach a workflow before sending the envelope:\n\n```json\n{\n  \"status\": \"sent\",\n  \"workflow\": {\n    \"workflowSteps\": [\n      {\n        \"action\": \"pause_before\",\n        \"description\": \"pause_before routing order 2\",\n        \"itemId\": 2,\n        \"triggerOnItem\": \"routing_order\"\n      }\n    ]\n  }\n}\n```\n\n## Working with workflows\n\nTo unpause a workflow, the request body should include this:\n\n```json\n{\n  \"workflow\": {\n    \"workflowStatus\": \"in_progress\"\n  }\n}\n```\n\n## Voiding an in-process envelope\n\nTo void an in-process envelope, include the following code in the request body:\n\n```json\n{\n  \"status\": \"voided\",\n  \"voidedReason\": \"The reason for voiding the envelope\"\n}\n```\n\n## Modifying envelope email information\n\nTo change the email subject and message of a draft envelope,\ninclude the following code in the request body:\n\n```json\n{\n  \"emailSubject\": \"new email subject\",\n  \"emailBlurb\": \"new email message\"\n}\n```\n\n## Purging documents from Docusign\n\nTo place only the documents\nin the purge queue,\nleaving any\ncorresponding attachments\nand tabs in the Docusign platform,\nset the `purgeState` property\nto `documents_queued`.\n\n```json\n{\n  \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n  \"purgeState\": \"documents_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue,\nset the `purgeState` property\nto `documents_and_metadata_queued`.\n\n```json\n{\n  \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n  \"purgeState\": \"documents_and_metadata_queued\"\n}\n```\n\nTo place documents,\nattachments,\nand tabs\nin the purge queue\nand to redact personal information,\nset the `purgeState` property\nto `documents_and_metadata_and_redact_queued`.\n\n```json\n{\n  \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n  \"purgeState\": \"documents_and_metadata_and_redact_queued\"\n}\n```\n\nYou can purge documents only from completed envelopes that are not marked as the authoritative copy. The user requesting the purge must have permission to purge documents and must be a user in your account or be acting on behalf of your account.\n\nWhen the purge request is initiated either by a Sent Envelopes or Received Envelopes Document Retention Policy, the items to be purged are placed in the purge queue for deletion prior to actual purging. By default, the sender and any recipients in your account who participated in an envelope affected by Document Purge will receive an email notification when the envelope enters the purge queue. Under normal purge queue processing conditions, this notification is sent 14 days before the documents are permanently deleted. The notification contains a link to the documents, which allows recipients to download the document before it is purged. A second email notification is additionally sent generally 7 days later prior to expiration of the purge queue period as another reminder of the upcoming purge. At the end of the purge queue period, the documents are deleted from the system. Recipients without Docusign accounts and recipients who are not in your account do not receive email notifications.\n\nIf your account has a Document Retention policy, envelope documents are automatically placed in the purge queue, and notification emails are sent at the end of the retention period. Setting a Document Retention policy is the same as setting a schedule for purging documents.\n\n## Removing documents from the purge queue\n\nTo remove documents from the purge queue, include the following code in the request body:\n\n```json\n{\n  \"envelopeId\": \"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\",\n  \"purgeState\": \"documents_dequeued\"\n}\n```\n\n### Related topics\n\n- [Void an envelope](https://www.docusign.com/blog/dsdev-common-api-tasks-void-an-envelope) ([Common API Tasks](https://www.docusign.com/blog/tags/common-api-tasks))\n- [Purging documents (eSignature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"advanced_update","in":"query","description":"When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.","required":false,"schema":{"type":"string"}},{"name":"recycle_on_void","in":"query","required":false,"schema":{"type":"string"}},{"name":"resend_envelope","in":"query","description":"When **true,**\nsends the specified envelope again.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeUpdateSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelope`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelope"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification":{"get":{"operationId":"envelopes_Notification_GetEnvelopesEnvelopeIdNotification","summary":"Gets envelope notification information.","description":"Retrieves the envelope notification, reminders and expirations, information for an existing envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Notification_PutEnvelopesEnvelopeIdNotification","summary":"Sets envelope notifications for an existing envelope.","description":"This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.\n\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeNotificationRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeNotificationRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image":{"get":{"operationId":"envelopes_Pages_GetPageImage","summary":"Gets a page image from an envelope for display.","description":"Returns an image of a page in a document for display.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}},{"name":"dpi","in":"query","description":"Sets the dots per inch (DPI) for the returned image.","required":false,"schema":{"type":"string"}},{"name":"max_height","in":"query","description":"Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting.","required":false,"schema":{"type":"string"}},{"name":"max_width","in":"query","description":"Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting.","required":false,"schema":{"type":"string"}},{"name":"prefer_svg","in":"query","description":"When set to **true**, requests the page image in SVG format instead of PNG, even when vectorized page rendering is not enabled for the account. SVG is returned only when SVG rendering is supported by the current document processing engine; otherwise a PNG image is returned. When **false** or omitted, the default format is used. The format of the returned image is indicated by the `Content-Type` response header (single page) or the `mimeType` property (multiple pages).","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","description":"When **true,** changes display in the user interface.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Pages_PutPageImage","summary":"Rotates page image from an envelope for display.","description":"Rotates page image from an envelope for display. The page image can be rotated to the left or right.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelopes_Pages_PutPageImage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `pageRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pageRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages":{"get":{"operationId":"envelopes_Pages_GetPageImages","summary":"Returns document page image(s) based on input.","description":"Returns images of the pages in a document for display based on the parameters that you specify.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"dpi","in":"query","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","required":false,"schema":{"type":"string"}},{"name":"max_height","in":"query","description":"Sets the maximum height of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"max_width","in":"query","description":"Sets the maximum width of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"nocache","in":"query","description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value.","required":false,"schema":{"type":"string"}},{"name":"prefer_svg","in":"query","description":"When set to **true**, requests the page image in SVG format instead of PNG, even when vectorized page rendering is not enabled for the account. SVG is returned only when SVG rendering is supported by the current document processing engine; otherwise a PNG image is returned. When **false** or omitted, the default format is used. The format of the returned image is indicated by the `Content-Type` response header (single page) or the `mimeType` property (multiple pages).","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","description":"When **true,** changes display in the user interface.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pageImages"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image":{"get":{"operationId":"envelopes_Recipients_GetRecipientInitialsImage","summary":"Gets the initials image for a user.","description":"Retrieves the initials image for the specified recipient.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"include_chrome","in":"query","description":"Obsolete. The chrome is included in the image if it's present in the envelope.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Recipients_PutRecipientInitialsImage","summary":"Sets the initials image for an accountless signer.","description":"Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelopes_Recipients_PutRecipientInitialsImage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature":{"get":{"operationId":"envelopes_Recipients_GetRecipientSignature","summary":"Get recipient signature","description":"Retrieves signature information for a signer or sign-in-person recipient.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image":{"get":{"operationId":"envelopes_Recipients_GetRecipientSignatureImage","summary":"Get recipient signature image","description":"Retrieves the specified recipient signature image.\n\n**Note:** If the Docusign account has the `SignInEachLocation` feature ([Require Recipients to Draw Each Signature﻿ feature](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=jyu1578456488969.html)) enabled, this endpoint cannot be used.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"include_chrome","in":"query","description":"Obsolete. The chrome is included in the image if it's present in the envelope.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Recipients_PutRecipientSignatureImage","summary":"Sets the signature image for an accountless signer.","description":"Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\n\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelopes_Recipients_PutRecipientSignatureImage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events":{"get":{"operationId":"envelopes_AuditEvents_GetAuditEvents","summary":"Gets the envelope audit events for an envelope.","description":"Gets the envelope audit events for the specified envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Locale setting for the response, e.g., 'en-US'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeAuditEventResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/status":{"put":{"operationId":"envelopes_putstatus","summary":"Gets envelope statuses for a set of envelopes.","description":"Retrieves envelope statuses for a set of envelopes. `Envelopes: listStatus` has both a `GET` and a `PUT` implementation:\n\n- `PUT /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information.\n- `GET /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a list of envelope IDs in a query string.\n\n<Note>\nTo search for envelopes using a broad range of filters, use\n[Envelopes: listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/)\ninstead of this method.\n</Note>\n\nYou must specify exactly one of the following query parameters:\n\n| Parameter | Description |\n| --- | --- |\n| `from_date` | a valid UTC DateTime: `2016-01-01` |\n| `envelope_ids` | <ul><li>For the `GET` implementation of this method, include the envelope IDs in a comma-separated list.</li><li>For the `PUT` version of this method, you should use the `request_body` value for this parameter and include the list of envelope IDs in the request body.</li></ul> |\n| `transaction_ids` | A comma-separated list of transaction IDs or the special value `request_body` |\n\nWhen you use the special value `request_body`, the request body looks like this:\n\n```json\n{\n  \"envelopeIds\": [\n    \"44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15\",\n    \"8e26040d-xxxx-xxxx-xxxx-1e29b924d237\",\n    \"c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95\"\n  ]\n}\n```\n\n<Warning>\nOmitting the request body altogether causes the endpoint to return an error.\nThe request body must be at least `{}`.\n</Warning>\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"ac_status","in":"query","description":"Specifies the Authoritative Copy Status for the envelopes. Valid values:\n\n- `Unknown`\n- `Original`\n- `Transferred`\n- `AuthoritativeCopy`\n- `AuthoritativeCopyExportPending`\n- `AuthoritativeCopyExported`\n- `DepositPending`\n- `Deposited`\n- `DepositedEO`\n- `DepositFailed`","required":false,"schema":{"type":"string"}},{"name":"block","in":"query","description":"When **true,** removes any results that match one of the provided `transaction_ids`.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"The email address of the sender.","required":false,"schema":{"type":"string"}},{"name":"envelope_ids","in":"query","description":"The envelope IDs to include in the results.\n\nThe value of this property can be:\n\n- For the `GET` implementation of this method, use a comma-separated list of envelope IDs.\n- For the `PUT` implementation of this method, use the `request_body` value, and include the envelope IDs in the request body.","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided.\n\n**Note:** This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified.","required":false,"schema":{"type":"string"}},{"name":"from_to_status","in":"query","description":"The envelope status that you are checking for. Possible values are:\n\n- `Changed` (default)\n- `Completed`\n- `Created`\n- `Declined`\n- `Deleted`\n- `Delivered`\n- `Processing`\n- `Sent`\n- `Signed`\n- `TimedOut`\n- `Voided`\n\nFor example, if you specify `Changed`, this method\nreturns a list of envelopes that changed status\nduring the `from_date` to `to_date` time period.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"A comma-separated list of envelope status to search for. Possible values are:\n\n- `completed`\n- `created`\n- `declined`\n- `deleted`\n- `delivered`\n- `processing`\n- `sent`\n- `signed`\n- `template`\n- `voided`","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Optional date/time setting\nthat specifies the last date/time\nor envelope status changes in the result set.\n\nThe default value is the time that you call the method.","required":false,"schema":{"type":"string"}},{"name":"transaction_ids","in":"query","description":"The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.\n\nThe value of this property can be:\n\n- A list of comma-separated transaction IDs\n- The special value `request_body`. In this case, this method uses the transaction IDs in the request body.","required":false,"schema":{"type":"string"}},{"name":"user_name","in":"query","description":"Limits results to envelopes\nsent by the account user\nwith this user name.\n\n`email` must be given as well,\nand both `email` and `user_name`\nmust refer to an existing account user.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeIdsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeIdsRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares":{"post":{"operationId":"uncategorized_EnvelopesShares_PostEnvelopesShares","summary":"Shares an envelope with other users in your account. Each shares object in the request array represents one user with whom the envelope will be shared.","description":"Shares an envelope with other users in your account. Each shares object in the request array represents one user with whom the envelope will be shared.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID GUID of the account to which the caller and the users to whom the envelope will be shared all belong.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope ID GUID of the envelope being shared.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharesResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopesSharesRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharesRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_EnvelopesShares_DeleteEnvelopesShares","summary":"Deletes all sharing requests for the specified envelope.","description":"Deletes all sharing requests for the specified envelope.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID GUID of the account to which the caller and the users to whom the envelope will be shared all belong.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope ID GUID of the envelope being shared.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopesShares_DeleteEnvelopesShares_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopesSharesRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharesRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopesShares_GetEnvelopesShares","summary":"Get shares for envelope","description":"Returns the set of envelope share data for all sharing requests for the envelope with the provided ID.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelopeId Guid of the envelope being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharesResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopesShares_PutEnvelopesShares","summary":"Update envelopes shares","description":"The format for specifying updates to shares requests in the request body is similar to the following:\n\n&#123;\n\"shares\": [\n&#123;\n\"agentUser\": &#123;\n\"userId\": \"9258f571-xxxx-xxxx-xxxx-5d01275bd0d5\",\n\"accountId\": \"c12db425-xxxx-xxxx-xxxx-cfb414e15847\",\n&#125;,\n\"permission\": \"View\"\n&#125;,\n&#123;\n\"agentUser\": &#123;\n\"userId\": \"2d445e51-xxxx-xxxx-xxxx-88e8bd8e3be3\",\n\"accountId\": \"c12db425-xxxx-xxxx-xxxx-cfb414e15847\",\n&#125;,\n\"permission\": \"Edit\"\n&#125;,\n&#123;\n\"agentUser\": &#123;\n\"userId\": \"7f8e9d10-xxxx-xxxx-xxxx-6f7a8b9c0d1e\",\n\"accountId\": \"c12db425-xxxx-xxxx-xxxx-cfb414e15847\",\n&#125;,\n\"permission\": \"Manage\"\n&#125;\n]\n&#125;","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelopeId Guid of the envelope being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharesResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopesSharesRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharesRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}":{"delete":{"operationId":"uncategorized_EnvelopesShares_DeleteEnvelopesShare","summary":"Unshare envelope from users","description":"Unshares the envelope from the specified users.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The ID GUID of the envelope being unshared.","required":true,"schema":{"type":"string"}},{"name":"shareId","in":"path","description":"The ID of the envelope share request to be revoked and deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopesShares_DeleteEnvelopesShare_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopesShares_GetEnvelopesShare","summary":"Get envelope share by shareId","description":"Returns the set of envelope share data for the specific sharing request with the provided ID.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelopeId Guid of the envelope being accessed.","required":true,"schema":{"type":"string"}},{"name":"shareId","in":"path","description":"The ID of the envelope share request.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesShareResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopesShares_PutEnvelopesShare","summary":"Update envelope share","description":"Updates the specified envelope sharing request with the provided values.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelopeId Guid of the envelope being accessed.","required":true,"schema":{"type":"string"}},{"name":"shareId","in":"path","description":"The ID of the envelope share request to be updated.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesShareResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopesSharePermissionRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesSharePermissionRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/shared":{"get":{"operationId":"uncategorized_SharedEnvelopesList_GetSharedEnvelopes","summary":"Get filtered list of shared envelopes","description":"Returns the set of envelope share data for all sharing requests for the account that meet the provided filter criteria.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of shared envelopes to return. Defaults to 50. The maximum value is 100.","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The date after which envelope sharing requests may be returned by the query, in ISO 8601 format.","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Specifies that additional data should be included. Possible values are:\n\n- recipients\n- delegations\n- workflow\ncustom_fields","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Specify whether the results will be ordered in ascending or descending order. Possible values are:\n\n- asc\n- desc (default)","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"Must be lastModifiedDateTime.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Includes results whose subjects contain the provided text string.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position in the search results to begin displaying entries.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Enables you to filter by envelope lifecycle statuses. Possible values are:\n\n- draft\n- completed\n- declined\n- voided","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The date before which envelope sharing requests may be returned by the query, in ISO 8601 format.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates":{"post":{"operationId":"envelopes_Templates_PostEnvelopeTemplates","summary":"Adds templates to an envelope.","description":"Adds templates to the specified envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"preserve_template_recipient","in":"query","description":"If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text.\n\nWhen **true,** the recipients _will be preserved_ after the template is applied.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentTemplateList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentTemplateList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentTemplateList"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Templates_GetEnvelopeTemplates","summary":"Gets templates used in an envelope.","description":"This returns a list of the server-side templates, their name and ID, used in an envelope.\n","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Filters the results by template type. Valid values:\n\n- `applied`: Returns the templates applied to an envelope.\n- `matching`: Returns the [matching templates](https://support.docusign.com/s/document-item?language=en_US&bundleId=jux1643235969954&topicId=far1578456612069.html&_LANG=enus) for an envelope.\n\n**Note**: The matching templates that are returned do not include templates shared with me only via shared folders. If the template has been shared to the user individually, or if it has been shared to a member group to which the user belongs, then it will show up in matching\n\nThe default value is `applied`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates":{"post":{"operationId":"envelopes_Templates_PostDocumentTemplates","summary":"Adds templates to a document in an  envelope.","description":"Adds templates to a document in the specified envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"preserve_template_recipient","in":"query","description":"If omitted or set to false (the default),\nenvelope recipients _will be removed_\nif the template being applied\nincludes only tabs positioned via anchor text for the recipient,\nand none of the documents include the anchor text.\n\nWhen **true,** the recipients _will be preserved_ after the template is applied.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentTemplateList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentTemplateList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentTemplateList"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"envelopes_Templates_GetDocumentTemplates","summary":"Gets the templates associated with a document in an existing envelope.","description":"Retrieves the templates associated with a document in the specified envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list that limits the results.\nValid values are:\n\n- `applied`\n- `matched`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}":{"delete":{"operationId":"envelopes_Templates_DeleteDocumentTemplates","summary":"Deletes a template from a document in an existing envelope.","description":"Deletes the specified template from a document in an existing envelope.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelopes_Templates_DeleteDocumentTemplates_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/transfer_rules":{"post":{"operationId":"uncategorized_EnvelopeTransferRules_PostEnvelopeTransferRules","summary":"Creates an envelope transfer rule.","description":"This method creates an envelope transfer rule.\n\nWhen you create an envelope transfer rule, you specify the following properties: \n\n- `eventType`\n- `fromGroups`\n- `toUser`\n- `toFolder`\n- `carbonCopyOriginalOwner`\n- `enabled`\n\n**Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeTransferRuleRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopeTransferRules_GetEnvelopeTransferRules","summary":"Gets envelope transfer rules.","description":"This method retrieves a list of envelope transfer rules associated with an account.\n\n**Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopeTransferRules_PutEnvelopeTransferRules","summary":"Changes the status of multiple envelope transfer rules.","description":"This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled.\n\n**Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeTransferRuleInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRuleInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}":{"delete":{"operationId":"uncategorized_EnvelopeTransferRules_DeleteEnvelopeTransferRules","summary":"Deletes an envelope transfer rule.","description":"This method deletes an envelope transfer rule.\n\n**Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeTransferRuleId","in":"path","description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopeTransferRules_DeleteEnvelopeTransferRules_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopeTransferRules_PutEnvelopeTransferRule","summary":"Changes the status of an envelope transfer rule.","description":"This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.\n\nYou must include the `envelopeTransferRuleId` both as a query parameter, and in the request body.\n\n**Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeTransferRuleId","in":"path","description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRule"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeTransferRule`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTransferRule"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/views/console":{"post":{"operationId":"envelopes_Views_PostAccountConsoleView","summary":"Returns a URL to the Docusign eSignature web application.","description":"Returns a URL that enables you to embed the Docusign UI in your applications. To view a specific envelope, set the `envelopeId` property in the request body.\n\n## Information security notice\n\nThis method provides full access to the sending account.\n\n### Related topics\n\n- [How to embed the Docusign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `consoleViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/consoleViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct":{"post":{"operationId":"envelopes_Views_PostEnvelopeCorrectView","summary":"Returns a URL to the envelope correction UI. Use after an envelope has been sent.","description":"Returns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe.\n\n**API request update**\n\nThe request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information.\n\n**Best practices**\n\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\n\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\n\n## Customizing the user experience\n\nBy default, the view includes two pages: the **Prepare** and **Tagger** pages. The settings object is used to control the user experience. For example, to limit the user to the **Tagger** page, and not allow the user to change the recipient information:\n\n- `\"startingScreen\": \"Tagger\"`\n- `\"showBackButton\": \"false\"`\n- `\"showEditRecipients\": \"false\"`\n\nUse the [Embedded Views Test Too](https://docusign.github.io/app-examples/embedded-views-v2/) to try the different UX controls. Some UI settings attributes are not yet implemented.\n\n### The envelope must be in the correct state for the Embedded View\n\nTo use the Correct View, the envelope **must** be in the `sent` or `delivered` state. Otherwise, a 400 error will be returned with an error message in the response body:\n\n```json\n{\n    \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n    \"message\": \"Invalid envelope status. Correct view cannot be created for an envelope in a Created state.\"\n}\n```\n\n### Modifying the envelope after redirection\n\nIf you set `\"sendButtonAction\": \"redirect\"` or `\"backButtonAction\": \"redirect\"`, and your app will modify the envelope before or after the view completes, you must lock the envelope before the API call and provide the lock as the lockToken attribute in the API request object.\n\nDelete the lock token after the browser has been redirected to your application.\n\n### Closing the view's iframe\n\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\n\n- (One time) create a standalone return page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\n- In your application, use `window.addEventListener(\"message\", function_name)` to register a listener for incoming messages.\n- To show the view, use this API method, then set the iframe to load the URL from the API response.\n- In your application, receive the completion message, validate it, and then close the iframe.\n\n### Information security\n\nThis view only has write access to the specific envelope referenced in the API call. It also has read access to templates and other secondary information that a user can access to modify the envelope. The read access corresponds to the access rights of the user associated with the access token used for the API call.\n\n>\n\n**Recommendations:**\n\n- Use the access token of a service user who can access the templates appropriate for your use case.\n- Do not use the access token of a user with administrator privileges.\n\n## Migrating to the current version of the request object\n\nThis section only applies to existing applications that use the older version of the request object.\n\nMigrating from the old API request object to the new version will take under a day of developer time.\n\n**Step 1.** Does your application set the `returnUrl` attribute?\n\nYes: continue with step 2.\n\nNo: In this case, your users first update the envelope, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\n\n- Set the `returnUrl` to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests.\n- When the new endpoint is called, use the [EnvelopeViews:createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) API call to obtain and then display the Docusign eSignature home page to your application's user.\n\n**Step 2.** Does your application modify the default UI of the view?\n\nNo: continue with step 3.\n\nYes: With the new API request object, UI controls for the view are now set when you make the API call via the `settings` attribute.\n\n- Note the UI settings your application is currently modifying by adding and updating query parameters on the URL _returned_ by the API method.\n\n- Using the reference documentation below, create a settings object that accomplishes your UI goals. You can use the [Embedded Views Test tool](https://docusign.github.io/app-examples/embedded-views-v2/) to check your UI settings. Note that the `settings` object includes multiple objects and subobjects for various UI settings.\n\n- **Delete the code** in your application that modifies and adds query parameters to the URL returned by the API. With the new API format, your application will not make any changes to the returned URL. Exception: If you set the view's locale specifically, that is still accomplished by appending the `locale` query parameter.\n\n**Step 3.** Is the envelope always in the right state before you call the Embedded View?\n\nIf your software may try to create the Embedded View when the envelope is not in the right state (see above), then you must add additional checks and logic to prevent this.\n\n**Step 4.** Check that these API attributes are set:\n\n- `\"viewAccess\" = \"envelope\"`\n- The `returnUrl` is set\n\n**Step 5.** All done! Test your application.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeViewRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_Views_DeleteEnvelopeCorrectView","summary":"Revokes the correction view URL to the Envelope UI","description":"This API method is obsolete. Your application should not call it. It acts as a null operation.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_Views_DeleteEnvelopeCorrectView_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `correctViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correctViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit":{"post":{"operationId":"envelopes_Views_PostEnvelopeEditView","summary":"Returns a URL to the edit view UI. Use before an envelope has been sent.","description":"This API method has been replaced by the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method. The two API methods work exactly the same,\n\n**Migration required**\n\nTo solve an application security issue, you must migrate to the new API request format. See the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method for more information. Backwards compatibility will be provided for a limited time.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient":{"post":{"operationId":"envelopes_Views_PostEnvelopeRecipientView","summary":"Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also be used for other recipient types.","description":"Returns a URL that enables you to\n[embed the recipient view](/docs/esign-rest-api/esign101/concepts/embedding/)\nof the\nDocusign UI in your applications. If the recipient is a signer,\nthen the view will provide the signing ceremony.\n\nThis method is only used with envelopes in the `sent` status.\n\n<Note>\nDue to screen space issues, Docusign recommends using [Focused View](/docs/esign-rest-api/how-to/request-signature-focused-view/) if you plan to include the Docusign signing elements inside an `<iframe>` object.\nFor iOS devices, Docusign recommends using a WebView.\n</Note>\n\n### The returned URL\n\nThe URL returned in this method's response is intended to be used\nimmediately to redirect the signer to the recipient view.\nYou can open the recipient view\nin the current browser or in a new tab.\nAfter the signer is redirected to the\nrecipient view, they must interact with the Docusign system\nperiodically or their session will time out.\n\n<Warning>\nThe returned URL can be used only once and\nexpires after 5 minutes.\nDo not store or email the returned URL.\n</Warning>\n\nIf you want to invite someone to an embedded signing session via\nemail, the email invitation's URL must be to your application.\nWhen invoked, your app should request a `recipientView` URL from\nDocusign and then redirect the signer to that URL.\n\n### How to specify the default language\n\nYou can append the `locale`\nquery parameter\nto the URL returned by this method\nto specify a language.\n\nThe language for the recipient view\nfollows this order or precedence:\n\n- The language specified by the sender for the recipient.\n- The `locale` parameter appended to the URL.\n- The account language if the signer has a Docusign account.\n- The language used in a previous signing if the signer is return signer.\n- The browser language.\n\nFor example, to set the default language\nto Canadian French, you would add this query parameter\nto the returned URL:\n\n```text\n...&locale=fr_CA\n```\n\n## Authentication\n\nYour application is responsible for authenticating the identity\nof the recipient or signer when you use this method. Use the\nfollowing parameters to record how the recipient\nwas authenticated.\n\n- `assertionId`\n- `authenticationInstant`\n- `authenticationMethod`\n- `clientUserId`\n- `securityDomain`\n\nAt a minimum, `authenticationMethod` and `clientUserId` are\nrequired. The information that you provide is included in the\nenvelope's certificate of completion.\n\n## Sending to a remote signer\n\nYou can request a signing session for a remote recipient\nwho has a Docusign account.\n\nAuthenticate the request using the recipient's\ncredentials, and do not specify a `clientUserId`.\nThis differs from the typical behavior where the\nrequest is authenticated using the sender's credentials,\nand the recipient has a `clientUserId` defined.\n\n## Redirecting back to returnUrl\n\nAfter the signer completes or ends the signing ceremony, Docusign\nredirects the user's browser back to your app via the\n`returnUrl` that you supplied in the request.\n\nThe signer may be redirected through various Docusign\nsubdomains, depending on the region of the account sending the\nenvelope. Please consult [Allowlists for Docusign eSignature service](https://www.docusign.com/trust/security/esignature#allowlists-for-docusign-esignature-service)\nin **Security for Docusign eSignature**\nwhen setting up your allowlists\n\n### The event status parameter\n\nDocusign appends an `event` query parameter to the `returnUrl` with the\noutcome of the signing ceremony. Your app can use this event\nparameter to determine the next step for the envelope.\nDo not fetch the envelope status by using\n[Envelopes: get](/docs/esign-rest-api/reference/envelopes/envelopes/get/)\nor a similar method because doing so\nwill probably hit [request and polling limits](/docs/esign-rest-api/esign101/rules-and-limits/).\n\n| event query parameter | Meaning |\n| --- | --- |\n| signing_complete | The recipient has signed the document. |\n| access_code_failed | The recipient failed to provide the correct access code needed for recipient authentication. |\n| cancel | The recipient decided to finish later. |\n| decline | The recipient declined to sign the document. |\n| exception | An exception has occurred on the server during the signing session. |\n| fax_pending | Recipient has a fax pending. |\n| id_check_failed | The recipient failed to complete identity verification correctly. |\n| session_timeout | The recipient did not sign the document in time. The timeout is set to 20 minutes. |\n| ttl_expired | The token was not used within the timeout period or the token has already been accessed. |\n| viewing_complete | The recipient did not need to sign but has completed the viewing ceremony. |\n\n<Note>\nBecause a user can cancel redirection, close their\nbrowser after signing, or spoof the landing URL,\nyou should not rely on the `returnUrl`\nalone as the single source of truth for envelope\nstatus for your integration.\n</Note>\n\n### Maintaining State\n\nAfter the recipient completes the recipient view (or signing\nceremony), they are redirected to your application. Your\napplication can recover state information about the transaction\nby storing information in a cookie, or by including query\nparameters in the `returnUrl` field. For example.\n`https://myapp.example.com/docusign_return?myState=12345` When the\nuser is redirected to your app, the `event` query parameter will\nbe appended. In this example, prevent spoofing by not using a\nguessable value as the state value.\n\n### Related topics\n\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)\n- [How to request a signature using a composite template](/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/)\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\n- [How to set envelope tab values](/docs/esign-rest-api/how-to/set-envelope-tab-values/)\n- [How to set tab values in a template](/docs/esign-rest-api/how-to/set-template-tab-values/)\n- [How to request a signature using focused view](/docs/esign-rest-api/how-to/request-signature-focused-view/)","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The ID of the draft envelope or template to preview.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipientViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipientViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender":{"post":{"operationId":"envelopes_Views_PostEnvelopeSenderView","summary":"Returns a URL to the sender view UI. Used before an envelope has been sent.","description":"Returns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe.\n\n**API request update**\n\nThe request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information.\n\n**Best practices**\n\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\n\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\n\n## Customizing the user experience\n\nBy default, the view includes two pages: the **Prepare** and **Tagger** pages. The settings object is used to control the user experience. For example, to limit the user to the **Tagger** page, and not allow the user to change the recipient information:\n\n- `\"startingScreen\": \"Tagger\"`\n- `\"showBackButton\": \"false\"`\n- `\"showEditRecipients\": \"false\"`\n\n### The envelope must be in the correct state for the Embedded View\n\nTo use the Sender View, the envelope **must** be in the `created` state. Otherwise, a 400 error will be returned with an error message in the response body:\n\n```json\n{\n    \"errorCode\": \"ENVELOPE_INVALID_STATUS\",\n    \"message\": \"Invalid envelope status. Sender view cannot be created for an envelope that is not in a draft state.\"\n}\n```\n\n### Closing the view's iframe\n\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\n\n- (One time) create a standalone “return” page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\n- In your application, use `window.addEventListener(\"message\", function_name)` to register a listener for incoming messages.\n- To show the view, use this API method, then set the iframe to load the URL from the API response.\n- In your application, receive the completion message, validate it, and then close the iframe.\n\n### Information security\n\nThis view only has write access to the specific envelope referenced in the API call. It also has read access to templates and other secondary information that a user can access to modify the envelope. The read access corresponds to the access rights of the user associated with the access token used for the API call.\n\n>\n\n**Recommendations:**\n\n- Use the access token of a service user who can access the templates appropriate for your use case.\n- Do not use the access token of a user with administrator privileges.\n\n## Migrating to the current version of the request object\n\nThis section only applies to existing applications that use the older version of the request object.\n\nMigrating from the old API request object to the new version will take under a day of developer time.\n\n**Step 1.** Does your application set the `returnUrl` attribute?\n\nYes: continue with step 2.\n\nNo: In this case, your users first update the envelope, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\n\n- Set the `returnUrl` to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests.\n- When the new endpoint is called, use the [EnvelopeViews:createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) API call to obtain and then display the Docusign eSignature home page to your application's user.\n\n**Step 2.** Does your application modify the default UI of the view?\n\nNo: continue with step 3.\n\nYes: With the new API request object, UI controls for the view are now set when you make the API call via the `settings` attribute.\n\n- Note the UI settings your application is currently modifying by adding and updating query parameters on the URL _returned_ by the API method.\n\n- Using the reference documentation below, create a settings object that accomplishes your UI goals. Note that the `settings` object includes multiple objects and subobjects for various UI settings.\n\n- **Delete the code** in your application that modifies and adds query parameters to the URL returned by the API. With the new API format, your application will not make any changes to the returned URL. Exception: If you set the view's locale specifically, that is still accomplished by appending the `locale` query parameter.\n\n**Step 3.** Is the envelope always in the right state before you call the Embedded View?\n\nIf your software may try to create the Embedded View when the envelope is not in the right state (see above), then you must add additional checks and logic to prevent this.\n\n**Step 4.** Check that these API attributes are set:\n\n- `\"viewAccess\" = \"envelope\"`\n- The `returnUrl` is set\n\n**Step 5.** All done! Test your application.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared":{"post":{"operationId":"uncategorized_Views_PostEnvelopeRecipientSharedView","summary":"Returns a URL to the shared recipient view UI for an envelope.","description":"Returns a URL that enables you to embed the Docusign UI recipient view of a [shared envelope](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=uzg1583277438725.html) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.\n\nDue to screen space issues,\ndo not use an `<iframe>` for embedded operations on mobile devices.\nFor iOS devices, Docusign recommends using a WebView.\n\n### Related topics\n\n- [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/)\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\n- [How to embed the Docusign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipientViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipientViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps":{"post":{"operationId":"uncategorized_EnvelopeWorkflowStep_PostEnvelopeWorkflowStepDefinition","summary":"Adds a new step to an envelope's workflow.","description":"Adds a new step to an envelope's workflow.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workflowStep`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps":{"post":{"operationId":"uncategorized_TemplateWorkflowStep_PostTemplateWorkflowStepDefinition","summary":"Adds a new step to a template's workflow.","description":"Adds a new step to a template's workflow.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workflowStep`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting":{"delete":{"operationId":"uncategorized_EnvelopeWorkflowDelayedRouting_DeleteEnvelopeDelayedRoutingDefinition","summary":"Delete envelope delayed routing rules","description":"Delete the delayed routing object for an envelope's workflow step. You cannot call this endpoint once the delay is in progress. As a workaround, you can update the delay or send time to one minute in the future using the [updateEnvelopeDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopedelayedroutingdefinition) endpoint.\n\n**Note:** After deleting the delayed routing object, the workflow step still contains the `pause_before` action. Once the workflow step is reached, you will need to [unpause the envelope](/docs/esign-rest-api/how-to/unpause-workflow/). If you want to delete the step entirely, use [deleteEnvelopeWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowstepdefinition/) instead.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopeWorkflowDelayedRouting_DeleteEnvelopeDelayedRoutingDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopeWorkflowDelayedRouting_GetEnvelopeDelayedRoutingDefinition","summary":"Get envelope delayed routing rules","description":"Given an envelope and a workflow step, returns the delayed routing rules for that workflow step.\n\n**Note:** If the workflow step does not have a delayed routing object, this method returns a 404.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delayedRouting"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopeWorkflowDelayedRouting_PutEnvelopeDelayedRoutingDefinition","summary":"Update envelope delayed routing rules","description":"Updates the delayed routing rules for an envelope's workflow step definition.\n\nYou can use this endpoint to add delayed routing to a draft envelope or a sent envelope (as long as the previous workflow step has not yet been completed). You can also update the delayed routing rule for an envelope, as long as the delay is not yet complete. If you update the delayed routing rule while the delay is already in progress, the countdown will reset.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delayedRouting"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `delayedRouting`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delayedRouting"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending":{"delete":{"operationId":"uncategorized_EnvelopeWorkflowScheduledSending_DeleteEnvelopeScheduledSendingDefinition","summary":"Delete envelope scheduled sending rules","description":"Deletes the scheduled sending rules for an envelope's workflow. You cannot call this endpoint once the scheduled sending countdown has begun.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopeWorkflowScheduledSending_DeleteEnvelopeScheduledSendingDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopeWorkflowScheduledSending_GetEnvelopeScheduledSendingDefinition","summary":"Get envelope scheduled sending rules","description":"Given a template and a workflow step, returns the scheduled sending rules for that workflow step.\n\n**Note:** If the workflow step does not have a scheduled sending object, this method returns a 404.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduledSending"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopeWorkflowScheduledSending_PutEnvelopeScheduledSendingDefinition","summary":"Update envelope scheduled sending rules","description":"Updates the scheduled sending rules for an envelope's workflow. The envelope must have an existing workflow object.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduledSending"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `scheduledSending`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduledSending"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow":{"delete":{"operationId":"uncategorized_EnvelopeWorkflowDefinitionV2_DeleteEnvelopeWorkflowDefinition","summary":"Delete the workflow definition for an envelope.","description":"Deletes the specified envelope's workflow definition if it has one.\n\n**Note:** If the envelope was scheduled to be sent, this endpoint will cancel the scheduled send and the envelope status will be reset to\n`created`. To resend the envelope, call the update the status to `sent` with the [Envelopes::Update](/docs/esign-rest-api/reference/envelopes/envelopes/update/) method.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopeWorkflowDefinitionV2_DeleteEnvelopeWorkflowDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopeWorkflowDefinitionV2_GetEnvelopeWorkflowDefinition","summary":"Returns the workflow definition for an envelope.","description":"Returns the workflow definition for the envelope specified by `envelopeId`. If the envelope does not have a workflow object, this method returns a 404.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopeWorkflowDefinitionV2_PutEnvelopeWorkflowDefinition","summary":"Updates the workflow definition for an envelope.","description":"Updates the specified envelope's workflow.\n\nYou can use this endpoint to add scheduled sending to a draft envelope. You can also update the scheduled sending for a sent envelope if the scheduled sending countdown is in progress. In that case, the envelope will be reset to a draft state.\n\nYou can also add delayed routing to a draft envelope or a sent envelope that has not started workflow processing.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workflow`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}":{"delete":{"operationId":"uncategorized_EnvelopeWorkflowStep_DeleteEnvelopeWorkflowStepDefinition","summary":"Delete envelope workflow step","description":"Deletes the workflow step specified by `workflowStepId` from an envelope specified by `envelopeId`.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_EnvelopeWorkflowStep_DeleteEnvelopeWorkflowStepDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_EnvelopeWorkflowStep_GetEnvelopeWorkflowStepDefinition","summary":"Returns a specified workflow step for a specified template.","description":"Returns a workflow step specified by `workflowStepId` for an envelope specified by `envelopeId`.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_EnvelopeWorkflowStep_PutEnvelopeWorkflowStepDefinition","summary":"Updates the specified workflow step for an envelope.","description":"Updates the workflow step specified by `workflowStepId` for an envelope.\n\nYou can use this endpoint to add or update delayed routing for a draft envelope. You can add or update delayed routing for a sent envelope as long as the previous workflow step has not been completed.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workflowStep`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting":{"delete":{"operationId":"uncategorized_TemplateWorkflowDelayedRouting_DeleteTemplateDelayedRoutingDefinition","summary":"Delete template delayed routing rules","description":"Deletes the delayed routing rules for the specified template workflow step.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_TemplateWorkflowDelayedRouting_DeleteTemplateDelayedRoutingDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_TemplateWorkflowDelayedRouting_GetTemplateDelayedRoutingDefinition","summary":"Get template delayed routing rules","description":"Given a template and a workflow step, returns the delayed routing rules for that workflow step.\n\n**Note:** If the workflow step does not have a delayed routing object, this method returns a 404.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delayedRouting"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_TemplateWorkflowDelayedRouting_PutTemplateDelayedRoutingDefinition","summary":"Update template delayed routing rules","description":"Updates the scheduled sending rules for a template's workflow.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delayedRouting"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `delayedRouting`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/delayedRouting"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending":{"delete":{"operationId":"uncategorized_TemplateWorkflowScheduledSending_DeleteTemplateScheduledSendingDefinition","summary":"Delete template scheduled sending rules","description":"Deletes the scheduled sending rules for the template's workflow.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_TemplateWorkflowScheduledSending_DeleteTemplateScheduledSendingDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_TemplateWorkflowScheduledSending_GetTemplateScheduledSendingDefinition","summary":"Get template scheduled sending rules","description":"Given a template specified by `templateId`, returns the scheduled sending rules for that template's workflow object.\n\n**Note:** If the template's workflow does not have a scheduled sending object, this method returns a 404.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduledSending"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_TemplateWorkflowScheduledSending_PutTemplateScheduledSendingDefinition","summary":"Update template scheduled sending rules","description":"Updates the scheduled sending rules for a template's workflow definition.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduledSending"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `scheduledSending`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduledSending"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/workflow":{"delete":{"operationId":"uncategorized_TemplateWorkflowDefinition_DeleteTemplateWorkflowDefinition","summary":"Delete the workflow definition for a template.","description":"Deletes the specified template's workflow definition if it has one.\n\n**Note:** If the specified template does not have a workflow definition, this endpoint returns a 200 response.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_TemplateWorkflowDefinition_DeleteTemplateWorkflowDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_TemplateWorkflowDefinition_GetTemplateWorkflowDefinition","summary":"Returns the workflow definition for a template.","description":"Returns the workflow definition for the template specified by `templateId`. If the template does not have a workflow object, this method returns a 404.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_TemplateWorkflowDefinition_PutTemplateWorkflowDefinition","summary":"Updates the workflow definition for a template.","description":"Updates the specified template's workflow definition.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workflow`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflow"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}":{"delete":{"operationId":"uncategorized_TemplateWorkflowStep_DeleteTemplateWorkflowStepDefinition","summary":"Delete template workflow step","description":"Deletes a workflow step from an template's workflow definition.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_TemplateWorkflowStep_DeleteTemplateWorkflowStepDefinition_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_TemplateWorkflowStep_GetTemplateWorkflowStepDefinition","summary":"Returns a specified workflow step for a specified envelope.","description":"Returns a workflow step specified by `workflowStepId` for a template specified by `templateId`.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_TemplateWorkflowStep_PutTemplateWorkflowStepDefinition","summary":"Updates a specified workflow step for a template.","description":"Updates a specified workflow step for a template.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"workflowStepId","in":"path","description":"The ID of the workflow step.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workflowStep`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workflowStep"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/current_user/notary/journals":{"get":{"operationId":"notary_NotaryJournals_GetNotaryJournals","summary":"Gets notary jurisdictions for a user. (Legacy)","description":"Gets notary jurisdictions for a user. (Legacy)","tags":["notary"],"parameters":[{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Use this parameter to search for specific text.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJournalList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview":{"post":{"operationId":"uncategorized_ResponsiveHtml_PostResponsiveHtmlPreview","summary":"Create envelope responsive HTML preview","description":"Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents in an\nenvelope. This method enables you to preview the\nPDF document conversions to responsive HTML across\ndevice types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitions"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentHtmlDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob":{"get":{"operationId":"uncategorized_TabsBlob_GetTabsBlob","summary":"Reserved for Docusign.","description":"This endpoint has been deprecated.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_TabsBlob_GetTabsBlob_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_TabsBlob_PutTabsBlob","summary":"Reserved for Docusign.","description":"This endpoint has been deprecated.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"envelopeId","in":"path","description":"The envelope's GUID.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_TabsBlob_PutTabsBlob_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/folders":{"get":{"operationId":"folders_getfolders","summary":"Returns a list of the account's folders.","description":"Returns a list of the account's folders.\n\nUse the `include` query parameter to specify the kinds of folders to return.\n\nBy default, only the first level of subfolders is shown.\nSet the `sub_folder_depth` query parameter to `-1` to return the entire folder hierarchy.\n\n<div className=\"ds-lp-acc\">\n\n<details>\n<summary>Default: top-level folders only</summary>\n\n`GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders'`\n\n```json\n{\n  \"resultSetSize\": \"5\",\n  \"startPosition\": \"0\",\n  \"endPosition\": \"4\",\n  \"totalSetSize\": \"5\",\n  \"folders\": [\n    {\n      \"name\": \"Draft\",\n      \"type\": \"draft\",\n      \"itemCount\": \"1\",\n      \"subFolderCount\": \"0\",\n      \"hasSubFolders\": \"false\"\n    },\n    {\n      \"name\": \"Inbox\",\n      \"type\": \"inbox\",\n      \"itemCount\": \"0\",\n      \"subFolderCount\": \"1\",\n      \"hasSubFolders\": \"true\",\n      \"folders\": [\n        {\n          \"name\": \"Project Fair\",\n          \"type\": \"normal\",\n          \"hasSubFolders\": \"false\",\n          \"parentFolderId\": \"3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\",\n          \"parentFolderUri\": \"/folders/3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\"\n        }\n      ]\n    },\n    {\n      \"name\": \"Deleted Items\",\n      \"type\": \"recyclebin\",\n      \"itemCount\": \"0\",\n      \"subFolderCount\": \"0\",\n      \"hasSubFolders\": \"false\"\n    },\n    {\n      \"name\": \"Sent Items\",\n      \"type\": \"sentitems\",\n      \"itemCount\": \"3\",\n      \"subFolderCount\": \"0\",\n      \"hasSubFolders\": \"false\"\n    }\n  ]\n}\n```\n\n</details>\n\n<details>\n<summary><span>With <code>sub_folder_depth=-1</code>: the entire folder hierarchy</span></summary>\n\n`GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders?sub_folder_depth=-1'`\n\nOne envelope has been moved from the `Inbox` folder to the\n`Project Fair/Phase 1` folder, and the endpoint is invoked\nwith `sub_folder_depth=-1`.\n\n```json\n{\n  \"resultSetSize\": \"5\",\n  \"startPosition\": \"0\",\n  \"endPosition\": \"4\",\n  \"totalSetSize\": \"4\",\n  \"folders\": [\n    {\n      \"name\": \"Draft\",\n      \"type\": \"draft\",\n      \"itemCount\": \"1\",\n      \"hasSubFolders\": \"false\"\n    },\n    {\n      \"name\": \"Inbox\",\n      \"type\": \"inbox\",\n      \"itemCount\": \"0\",\n      \"hasSubFolders\": \"true\",\n      \"folders\": [\n        {\n          \"name\": \"Project Fair\",\n          \"type\": \"normal\",\n          \"itemCount\": \"0\",\n          \"hasSubFolders\": \"true\",\n          \"parentFolderId\": \"3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\",\n          \"parentFolderUri\": \"/folders/3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\",\n          \"folders\": [\n            {\n              \"name\": \"NDAs\",\n              \"type\": \"normal\",\n              \"itemCount\": \"0\",\n              \"hasSubFolders\": \"false\",\n              \"parentFolderId\": \"12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\",\n              \"parentFolderUri\": \"/folders/12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\"\n            },\n            {\n              \"name\": \"Phase 1\",\n              \"type\": \"normal\",\n              \"itemCount\": \"1\",\n              \"hasSubFolders\": \"false\",\n              \"parentFolderId\": \"12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\",\n              \"parentFolderUri\": \"/folders/12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\"\n            }\n          ]\n        }\n      ]\n    },\n    {\n      \"name\": \"Deleted Items\",\n      \"type\": \"recyclebin\",\n      \"itemCount\": \"0\",\n      \"hasSubFolders\": \"false\"\n    },\n    {\n      \"name\": \"Sent Items\",\n      \"type\": \"sentitems\",\n      \"itemCount\": \"1\",\n      \"hasSubFolders\": \"false\"\n    }\n  ]\n}\n```\n\n</details>\n\n</div>\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [Sharing templates](/docs/esign-rest-api/esign101/concepts/templates/sharing/)","tags":["folders"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list of folder types to include in the response.\nValid values are:\n\n- `envelope_folders`: Returns a list of envelope folders. (Default)\n- `template_folders`: Returns a list of template folders.\n- `shared_template_folders`: Returns a list of shared template folders.","required":false,"schema":{"type":"string"}},{"name":"include_items","in":"query","description":"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"sub_folder_depth","in":"query","description":"If missing or any value other than `-1`, the returned list contains only the top-level folders.\nA value of `-1` returns the complete folder hierarchy.","required":false,"schema":{"type":"string"}},{"name":"template","in":"query","description":"This parameter is deprecated as of version 2.1. Use `include` instead.","required":false,"schema":{"type":"string"}},{"name":"user_filter","in":"query","description":"Narrows down the resulting folder list by the following values:\n\n- `all`: Returns all templates owned or shared with the user. (default)\n- `owned_by_me`: Returns only templates the user owns.\n- `shared_with_me`: Returns only templates that are shared with the user.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/foldersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/folders/{folderId}":{"get":{"operationId":"folders_getfolderitems","summary":"Gets information about items in a specified folder.","description":"Gets information about items in the specified folder.\n\nTo include a list of the items in the folder, set the `include_items` query parameter to **true.**\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [Sharing templates](/docs/esign-rest-api/esign101/concepts/templates/sharing/)","tags":["folders"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"include_items","in":"query","description":"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.","required":false,"schema":{"type":"string"}},{"name":"owner_email","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"owner_name","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/folderItemsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"folders_putfolderbyid","summary":"Move envelopes to folder","description":"Moves a set of envelopes from their current folder to another folder.\n\nThe `folderId` path parameter is the destination folder.\nThe request body has an array of envelope IDs and the\nID of the source folder.\n\n<Warning>\nDo not use the `folders` property in the request body.\n</Warning>\n\nIf `folderId` is the special value **`recyclebin`**\nthe envelopes are moved to the Deleted folder.\nMoving an in-process envelope\n(envelope status of `sent` or `delivered`)\nto the **`recyclebin`**\nvoids the envelope.\n\n### Related topics\n\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\n- [Sharing templates](/docs/esign-rest-api/esign101/concepts/templates/sharing/)","tags":["folders"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/foldersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `foldersRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/foldersRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/search_folders/{searchFolderId}":{"get":{"operationId":"folders_SearchFolders_GetSearchFolderContents","summary":"Deprecated. Use Envelopes: listStatusChanges.","description":"<Warning>\n**This method is deprecated in API v2.1**\n\nUse [Envelopes: listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) instead.\n</Warning>\n\nRetrieves a list of items that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the\nsame as the user ID for any returned recipient,\nthen the `userId` property is added to the returned\ninformation for those recipients.","tags":["folders"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"searchFolderId","in":"path","description":"Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.","required":true,"schema":{"type":"string"}},{"name":"all","in":"query","description":"Specifies that all envelopes that match the criteria are returned.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.","required":false,"schema":{"type":"string"}},{"name":"include_recipients","in":"query","description":"When **true,** the recipient information is returned in the response.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Specifies the end of the date range to return.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/folderItemResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/current_user/notary":{"post":{"operationId":"uncategorized_Notary_PostNotary","summary":"Registers the current user as a notary. (Legacy)","description":"Registers the current user as a notary. (Legacy)","tags":["uncategorized"],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `notary`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notary"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_Notary_GetNotary","summary":"Gets settings for a notary user. (Legacy)","description":"Gets settings for a notary user. (Legacy)\nThe current user must be a notary.","tags":["uncategorized"],"parameters":[{"name":"include_jurisdictions","in":"query","description":"When **true,** the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_Notary_PutNotary","summary":"Updates notary information for the current user. (Legacy)","description":"Updates notary information for the current user. (Legacy)","tags":["uncategorized"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `notary`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notary"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/current_user/notary/jurisdictions":{"post":{"operationId":"uncategorized_NotaryJurisdictions_PostNotaryJurisdictions","summary":"Creates a jurisdiction object. (Legacy)","description":"Creates a jurisdiction object. (Legacy)","tags":["uncategorized"],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJurisdiction"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `notaryJurisdiction`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJurisdiction"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_NotaryJurisdictions_GetNotaryJurisdictions","summary":"Returns a list of jurisdictions that the notary is registered in. (Legacy)","description":"Returns a list of jurisdictions that the notary is registered in. (Legacy)\nThe current user must be a notary.","tags":["uncategorized"],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJurisdictionList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/current_user/notary/jurisdictions/{jurisdictionId}":{"delete":{"operationId":"uncategorized_NotaryJurisdictions_DeleteNotaryJurisdiction","summary":"Deletes the specified jurisdiction. (Legacy)","description":"Deletes the specified jurisdiction. (Legacy)","tags":["uncategorized"],"parameters":[{"name":"jurisdictionId","in":"path","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`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uncategorized_NotaryJurisdictions_DeleteNotaryJurisdiction_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"uncategorized_NotaryJurisdictions_GetNotaryJurisdiction","summary":"Gets a jurisdiction object for the current user. The user must be a notary. (Legacy)","description":"Gets a jurisdiction object for the current user. (Legacy). The following restrictions apply:\n\n- The current user must be a notary.\n- The `jurisdictionId` must be a jurisdiction that the notary is registered for.","tags":["uncategorized"],"parameters":[{"name":"jurisdictionId","in":"path","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`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJurisdiction"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_NotaryJurisdictions_PutNotaryJurisdiction","summary":"Updates the jurisdiction information about a notary. (Legacy)","description":"Updates the jurisdiction information about a notary. (Legacy)\n\nThe following restrictions apply:\n\n- The current user must be a notary.\n- The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for.\n- The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`.\n\nThe request body must have a full `jurisdiction` object for the jurisdiction property.\nThe best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change.\n\nFor example, assume `getNotaryJurisdiction` returns this:\n\n```json\n{\n    \"jurisdiction\": {\n        \"jurisdictionId\": \"15\",\n        \"name\": \"Iowa\",\n        \"county\": \"\",\n        \"enabled\": \"true\",\n        \"countyInSeal\": \"false\",\n        \"commissionIdInSeal\": \"true\",\n        \"stateNameInSeal\": \"true\",\n        \"notaryPublicInSeal\": \"true\",\n        \"allowSystemCreatedSeal\": \"true\",\n        \"allowUserUploadedSeal\": \"false\"\n    },\n    \"commissionId\": \"123456\",\n    \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\",\n    \"registeredName\": \"Bob Notary\",\n    \"county\": \"Adams\",\n    \"sealType\": \"system_created\"\n}\n```\n\nIf you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be:\n\n```json\n{\n    \"jurisdiction\": {\n        \"jurisdictionId\": \"15\",\n        \"name\": \"Iowa\",\n        \"county\": \"\",\n        \"enabled\": \"true\",\n        \"countyInSeal\": \"false\",\n        \"commissionIdInSeal\": \"true\",\n        \"stateNameInSeal\": \"true\",\n        \"notaryPublicInSeal\": \"true\",\n        \"allowSystemCreatedSeal\": \"true\",\n        \"allowUserUploadedSeal\": \"false\"\n    },\n    \"commissionId\": \"123456\",\n    \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\",\n    \"registeredName\": \"Robert Notary\",\n    \"county\": \"Adams\",\n    \"sealType\": \"system_created\"\n}\n```","tags":["uncategorized"],"parameters":[{"name":"jurisdictionId","in":"path","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`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJurisdiction"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `notaryJurisdiction`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notaryJurisdiction"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/payment_gateway_accounts":{"get":{"operationId":"accounts_PaymentGatewayAccounts_GetAllPaymentGatewayAccounts","summary":"List payment gateway accounts","description":"This method returns a list of payment gateway accounts and basic information about them.","tags":["accounts"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentGatewayAccountsInfo"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data":{"get":{"operationId":"powerForms_getpowerformformdata","summary":"Returns the data that users entered in a PowerForm.","description":"This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.\n\nYou specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:\n\n- `application/json`: JSON format\n- `application/xml`: XML format\n- `text/csv`: Comma-separated value (CSV) format\n\nYou can further specify the type of CSV format in the `data_layout` query parameter.\n\n**Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"powerFormId","in":"path","description":"The ID of the PowerForm.","required":true,"schema":{"type":"string"}},{"name":"data_layout","in":"query","description":"The layout in which to return the PowerForm data.\n\nFor each of the following layouts, set the `Accept` header to the corresponding value.\n\nValid values are:\n\n- `Native` (Set `Accept` header to `application/json`)\n- `Csv_Classic` (Set `Accept` header to `application/csv`)\n- `Csv_One_Envelope_Per_Line` (Set `Accept` header to `text/csv`)\n- `Xml_Classic` (Set `Accept` header to `application/xml`)","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The start date for a date range in UTC DateTime format.\n\n**Note:** If this property is null, no date filtering is applied.","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The end date of a date range in UTC DateTime format. The default value is `UtcNow`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerFormsFormDataResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/powerforms":{"post":{"operationId":"powerForms_postpowerform","summary":"Creates a new PowerForm.","description":"This method creates a new PowerForm.\n\nYou create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body.\n\n PowerForms that you create from a template are referred to as *web PowerForms*.\n\n**Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API.\n\n**Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.\n\n\n### Signing modes\n\nYou can use one of the following signing modes for a PowerForm:\n\n**`email`**\n\nThis mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.\n\nAlternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`.  When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.\n\nExample: `activateonly=1`\n\n**`direct`**\n\nThis mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process.\n\nBecause the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check).\n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\n\n### Redirect URLs\n\nYou can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).\n\n### More information\n\nFor more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).\n\n","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerForm"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `powerForm`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerForm"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"powerForms_deletepowerformslist","summary":"Deletes one or more PowerForms","description":"This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerFormsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `powerFormsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerFormsRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"powerForms_getpowerformslist","summary":"Returns a list of PowerForms.","description":"This method returns a list of PowerForms that are available to the user.\n\n**Note:** The response returns up to 50 PowerForms per request. To retrieve additional PowerForms, use the `nextUri` property in the response to construct the next API call for the following batch of up to 50 PowerForms.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The start date for a date range.\n\n**Note:** If no value is provided, no date filtering is applied.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"The order in which to sort the results.\n\nValid values are:\n\n- `asc`: Ascending order.\n- `desc`: Descending order.","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"The file attribute to use to sort the results.\n\nValid values are:\n\n- `sender`\n- `auth`\n- `used`\n- `remaining`\n- `lastused`\n- `status`\n- `type`\n- `templatename`\n- `created`","required":false,"schema":{"type":"string"}},{"name":"search_fields","in":"query","description":"A comma-separated list of additional properties to include in a search.\n\n- `sender`: Include sender name and email in the search.\n- `recipients`: Include recipient names and emails in the search.\n- `envelope`: Include envelope information in the search.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Use this parameter to search for specific text.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The end date for a date range.\n\n**Note:** If no value is provided, this property defaults to the current date.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerFormsResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/powerforms/{powerFormId}":{"delete":{"operationId":"powerForms_deletepowerform","summary":"Deletes a PowerForm.","description":"This method deletes a PowerForm.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"powerFormId","in":"path","description":"The ID of the PowerForm.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PowerForms_deletepowerform_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"powerForms_getpowerform","summary":"Returns a single PowerForm.","description":"This method returns detailed information about a specific PowerForm.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"powerFormId","in":"path","description":"The ID of the PowerForm.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerForm"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"powerForms_putpowerform","summary":"Updates an existing PowerForm.","description":"This method updates an existing PowerForm.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"powerFormId","in":"path","description":"The ID of the PowerForm.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerForm"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `powerForm`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerForm"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/powerforms/senders":{"get":{"operationId":"powerForms_getpowerformssenders","summary":"Gets PowerForm senders.","description":"This method returns a list of users who have sent PowerForms.","tags":["powerForms"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/powerFormSendersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signing_groups":{"post":{"operationId":"signingGroups_postsigninggroups","summary":"Creates a signing group. ","description":"Creates one or more signing groups. \n\nMultiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. \n\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\n \nSigning groups can be used by any account user.","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `signingGroupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"signingGroups_deletesigninggroups","summary":"Deletes one or more signing groups.","description":"Deletes one or more signing groups in the specified account.","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `signingGroupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"signingGroups_getsigninggroups","summary":"Gets a list of the Signing Groups in an account.","description":"Retrieves a list of all signing groups in the specified account.","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"group_type","in":"query","description":"Filters by the type of signing group. Valid values:\n\n- `sharedSigningGroup`\n- `privateSigningGroup`\n- `systemSigningGroup`","required":false,"schema":{"type":"string"}},{"name":"include_users","in":"query","description":"When **true,** the response includes the signing group members.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"signingGroups_putsigninggroups","summary":"Updates signing group names.","description":"Updates the name of one or more existing signing groups. ","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `signingGroupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}":{"get":{"operationId":"signingGroups_getsigninggroup","summary":"Gets information about a signing group. ","description":"Retrieves information, including group member information, for the specified signing group. ","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signingGroupId","in":"path","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroup"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"signingGroups_putsigninggroup","summary":"Updates a signing group. ","description":"Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. ","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signingGroupId","in":"path","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroup"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `signingGroup`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroup"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users":{"delete":{"operationId":"signingGroups_deletesigninggroupusers","summary":"Deletes  one or more members from a signing group.","description":"Deletes  one or more members from the specified signing group. ","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signingGroupId","in":"path","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n\n**Note:** When you send an envelope to a signing group,\nanyone in the group can open it and sign it with their own signature.\nFor this reason, Docusign recommends that\nyou do not include non-signer recipients\n(such as carbon copy recipients)\nin the same signing group as signer recipients.\nHowever, you could create a second signing group\nfor the non-signer recipients and change t\nhe default action of Needs to Sign to a different value,\nsuch as Receives a Copy.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupUsers"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `signingGroupUsers`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupUsers"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"signingGroups_getsigninggroupusers","summary":"Gets a list of members in a Signing Group.","description":"Retrieves the list of members in the specified Signing Group.","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signingGroupId","in":"path","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n\n**Note:** When you send an envelope to a signing group,\nanyone in the group can open it and sign it with their own signature.\nFor this reason, Docusign recommends that\nyou do not include non-signer recipients\n(such as carbon copy recipients)\nin the same signing group as signer recipients.\nHowever, you could create a second signing group\nfor the non-signer recipients and change t\nhe default action of Needs to Sign to a different value,\nsuch as Receives a Copy.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupUsers"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"signingGroups_putsigninggroupusers","summary":"Adds members to a signing group. ","description":"Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. ","tags":["signingGroups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signingGroupId","in":"path","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n\n**Note:** When you send an envelope to a signing group,\nanyone in the group can open it and sign it with their own signature.\nFor this reason, Docusign recommends that\nyou do not include non-signer recipients\n(such as carbon copy recipients)\nin the same signing group as signer recipients.\nHowever, you could create a second signing group\nfor the non-signer recipients and change t\nhe default action of Needs to Sign to a different value,\nsuch as Receives a Copy.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupUsers"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `signingGroupUsers`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signingGroupUsers"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields":{"post":{"operationId":"templates_CustomFields_PostTemplateCustomFields","summary":"Creates custom document fields in an existing template document.","description":"Creates custom document fields in an existing template document.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateCustomFields`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateCustomFields"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"templates_CustomFields_DeleteTemplateCustomFields","summary":"Deletes envelope custom fields in a template.","description":"Deletes envelope custom fields in a template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateCustomFields`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateCustomFields"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_CustomFields_GetTemplateCustomFields","summary":"Gets the custom document fields from a template.","description":"Retrieves the custom document field information from an existing template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_CustomFields_PutTemplateCustomFields","summary":"Updates envelope custom fields in a template.","description":"Updates the custom fields in a template.\n\nEach custom field used in a template must have a unique name.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customFields"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateCustomFields`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateCustomFields"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields":{"post":{"operationId":"templates_DocumentFields_PostTemplateDocumentFields","summary":"Creates custom document fields in an existing template document.","description":"Creates custom document fields in an existing template document.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentFieldsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"templates_DocumentFields_DeleteTemplateDocumentFields","summary":"Delete template document fields","description":"Deletes custom document fields from an existing template document.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentFieldsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_DocumentFields_GetTemplateDocumentFields","summary":"Gets the custom document fields for a an existing template document.","description":"This method retrieves the custom document fields for an existing template document.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_DocumentFields_PutTemplateDocumentFields","summary":"Updates existing custom document fields in an existing template document.","description":"Updates existing custom document fields in an existing template document.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentFieldsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentFieldsInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions":{"get":{"operationId":"uncategorized_ResponsiveHtml_GetTemplateDocumentHtmlDefinitions","summary":"Get template document HTML definitions","description":"Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginals"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview":{"post":{"operationId":"uncategorized_ResponsiveHtml_PostTemplateDocumentResponsiveHtmlPreview","summary":"Create template document responsive HTML preview","description":"Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML version of a specific template document. This\nmethod enables you to preview a PDF document\nconversion to responsive HTML across device types\nprior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the signing document.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitions"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentHtmlDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents":{"delete":{"operationId":"templates_Documents_DeleteTemplateDocuments","summary":"Deletes documents from a template.","description":"This method deletes one or more documents from an existing template.\n\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\nFor example, this request body specifies that you want to delete the document whose `documentId` is \"1\".\n\n```json\n{\n  \"documents\": [\n    {\n      \"documentId\": \"1\"\n    }\n  ]\n}\n```","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDefinition"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_Documents_GetTemplateDocuments","summary":"Gets a list of documents associated with a template.","description":"Retrieves a list of documents associated with the specified template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"include_agreement_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_is_edited","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_tabs","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Documents_PutTemplateDocuments","summary":"Adds documents to a template document.","description":"Adds one or more documents to an existing template document.\n\n### Related topics\n\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentsResult"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}":{"get":{"operationId":"templates_Documents_GetTemplateDocument","summary":"Gets PDF documents from a template.","description":"This method retrieves one or more PDF documents from the template that you specify.\n\nYou can specify the ID of the document to retrieve, or pass in the value `combined` to retrieve all documents in the template as a single PDF file.\n\n### Related topics\n\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"encrypt","in":"query","description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the Docusign Security Appliance Installation Guide that your organization received from Docusign.","required":false,"schema":{"type":"string"}},{"name":"file_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","description":"When **true,** any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Documents_PutTemplateDocument","summary":"Updates a template document.","description":"This methods updates an existing template document.\n\n### Related topics\n\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"is_envelope_definition","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDocument"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs":{"post":{"operationId":"uncategorized_Tabs_PostTemplateDocumentTabs","summary":"Adds tabs to a document in a template.","description":"Adds tabs to the document specified by `documentId` in the\ntemplate specified by `templateId`.\n\nIn the request body, you only need to specify the tabs that your\nare adding. For example, to add a text\n[prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs),\nyour request body might look like this:\n\n```\n{\n  \"prefillTabs\": {\n    \"textTabs\": [\n      {\n        \"value\": \"a prefill text tab\",\n        \"pageNumber\": \"1\",\n        \"documentId\": \"1\",\n        \"xPosition\": 316,\n        \"yPosition\": 97\n      }\n    ]\n  }\n}\n```\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateTabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateTabs"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"uncategorized_Tabs_DeleteTemplateDocumentTabs","summary":"Deletes tabs from a template.","description":"Deletes tabs from the document specified by `documentId` in the\ntemplate specified by `templateId`.\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateTabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateTabs"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_Tabs_GetTemplateDocumentTabs","summary":"Returns tabs on a template.","description":"Returns the tabs on the document specified by `documentId` in the\ntemplate specified by `templateId`.\n\n","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"page_numbers","in":"query","description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.\n\nExample: `page_numbers=2,6`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_Tabs_PutTemplateDocumentTabs","summary":"Updates the tabs for a template","description":"Updates tabs in the document specified by `documentId` in the\ntemplate specified by `templateId`.\n","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateTabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateTabs"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs":{"get":{"operationId":"templates_Tabs_GetTemplatePageTabs","summary":"Returns tabs on the specified page.","description":"Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\ntemplate specified by `templateId`.\n","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility":{"get":{"operationId":"envelopes_Recipients_GetTemplateRecipientDocumentVisibility","summary":"Returns document visibility for a template recipient","description":"This method returns information about document visibility for a template recipient.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentVisibilityList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"envelopes_Recipients_PutTemplateRecipientDocumentVisibility","summary":"Updates document visibility for a template recipient","description":"This method updates the document visibility for a template recipient.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentVisibilityList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateDocumentVisibilityList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentVisibilityList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility":{"put":{"operationId":"envelopes_Recipients_PutTemplateRecipientsDocumentVisibility","summary":"Updates document visibility for template recipients","description":"This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body.\n\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.","tags":["envelopes"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentVisibilityList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateDocumentVisibilityList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDocumentVisibilityList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions":{"get":{"operationId":"uncategorized_ResponsiveHtml_GetTemplateHtmlDefinitions","summary":"Get template HTML definitions","description":"Gets the Original HTML Definition used to generate the Responsive HTML for the template.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginals"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/lock":{"post":{"operationId":"templates_Lock_PostTemplateLock","summary":"Locks a template.","description":"This method locks the specified template and sets the time until\nthe lock expires to prevent other users or recipients from\nchanging the template.\n\nThe response to this request includes a `lockToken` parameter\nthat you must use in the `X-DocuSign-Edit` header for\nevery PUT method (typically a method that updates a template)\nwhile the template is locked.\n\nIf you do not provide the `lockToken` when accessing\na locked template, you will get the following\nerror:\n\n```json\n{\n   \"errorCode\": \"EDIT_LOCK_NOT_LOCK_OWNER\",\n   \"message\": \"The user is not the owner of the lock. The template is locked by another user or in another application\"\n}\n```\n\n### The X-DocuSign-Edit header\n\nThe `X-DocuSign-Edit` header looks like this\nand can be specified in either JSON or XML.\n\n**JSON**\n\n```json\n{\n  \"LockToken\": \"token-from-response\",\n  \"LockDurationInSeconds\": \"600\"\n}\n```\n\n**XML**\n\n```xml\n<DocuSignEdit>\n  <LockToken>token-from-response</LockToken>\n  <LockDurationInSeconds>600</LockDurationInSeconds>\n</DocuSignEdit>\n```\n\nIn the actual HTTP header, you would remove the linebreaks:\n\n```text\nX-DocuSign-Edit: {\"LockToken\": \"token-from-response\", \"LockDurationInSeconds\": \"600\" }\n    or\nX-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>\n```\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `lockRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"templates_Lock_DeleteTemplateLock","summary":"Deletes a template lock.","description":"Deletes the lock from the specified template.\nThe user deleting the lock must be the same user\nwho locked the template.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/).\n\nThis method takes an optional query parameter\nthat lets you specify whether\nchanges made while the template was locked\nare kept or discarded.\n\n| Query Parameter | Description |\n| --- | --- |\n| `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the template was locked are discarded. |\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `lockRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_Lock_GetTemplateLock","summary":"Gets template lock information.","description":"Retrieves general information about a template lock.\n\nThe user requesting the information must be the same user\nwho locked the template.\n\nYou can use this method to recover the lock information,\nincluding the `lockToken`,\nfor a locked template.\nThe `X-DocuSign-Edit` header is included in the response.\n\nSee\n[TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/)\nfor a description of the `X-DocuSign-Edit` header.\n\n### Related topics\n\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Lock_PutTemplateLock","summary":"Updates a template lock.","description":"Updates the lock information for a locked template.\n\nYou must include the `X-DocuSign-Edit` header\nas described in\n[TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/).\n\nUse this method to change the duration\nof the lock (`lockDurationInSeconds`)\nor the `lockedByApp` string.\n\nThe request body is a full `lockRequest` object,\nbut you only need to specify the\nproperties that you are updating. For example:\n\n```json\n{\n  \"lockDurationInSeconds\": \"3600\",\n  \"lockedByApp\": \"My Application\"\n}\n```","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `lockRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lockRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/recipients":{"post":{"operationId":"templates_Recipients_PostTemplateRecipients","summary":"Adds tabs for a recipient.","description":"Adds one or more recipients to a template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"resend_envelope","in":"query","description":"When **true,**\nresends the envelope to the recipients\nthat you specify in the request body.\nUse this parameter to resend the envelope\nto a recipient\nwho deleted the original email notification.\n\n**Note:** Correcting an envelope is a different process.\nDocusign always resends an envelope when you correct it,\nregardless of the value that you enter here.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateRecipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateRecipients"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"templates_Recipients_DeleteTemplateRecipients","summary":"Deletes recipients from a template.","description":"Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateRecipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateRecipients"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_Recipients_GetTemplateRecipients","summary":"Gets recipient information from a template.","description":"Retrieves the information for all recipients in the specified template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"include_anchor_tab_locations","in":"query","description":"When **true** and `include_tabs` is set to **true,** all tabs with anchor tab properties are included in the response.","required":false,"schema":{"type":"string"}},{"name":"include_extended","in":"query","description":"When **true,** the extended properties are included in the response.","required":false,"schema":{"type":"string"}},{"name":"include_tabs","in":"query","description":"When **true,** the tab information associated with the recipient is included in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Recipients_PutTemplateRecipients","summary":"Updates recipients in a template.","description":"Updates recipients in a template. \n\nYou can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"resend_envelope","in":"query","description":"When **true,**\nresends the envelope to the recipients\nthat you specify in the request body.\nUse this parameter to resend the envelope\nto a recipient\nwho deleted the original email notification.\n\n**Note:** Correcting an envelope is a different process.\nDocusign always resends an envelope when you correct it,\nregardless of the value that you enter here.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipientsUpdateSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateRecipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateRecipients"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview":{"post":{"operationId":"uncategorized_Views_PostTemplateRecipientPreview","summary":"Creates a template recipient preview.","description":"This method returns a URL for a template recipient preview  in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.\n\nFor more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `recipientPreviewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipientPreviewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}":{"delete":{"operationId":"templates_Recipients_DeleteTemplateRecipient","summary":"Deletes the specified recipient file from a template.","description":"Deletes the specified recipient file from the specified template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recipients"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateRecipients`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateRecipients"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs":{"post":{"operationId":"templates_Recipients_PostTemplateRecipientTabs","summary":"Adds tabs for a recipient.","description":"Adds one or more tabs for a recipient.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateTabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateTabs"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"templates_Recipients_DeleteTemplateRecipientTabs","summary":"Deletes the tabs associated with a recipient in a template.","description":"Deletes one or more tabs associated with a recipient in a template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateTabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateTabs"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_Recipients_GetTemplateRecipientTabs","summary":"List template recipient tabs","description":"Gets the tabs information for a signer or sign-in-person recipient in a template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"include_anchor_tab_locations","in":"query","description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","description":"When **true,** the response includes metadata indicating which properties are editable.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Recipients_PutTemplateRecipientTabs","summary":"Updates the tabs for a recipient.","description":"Updates one or more tabs for a recipient in a template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"recipientId","in":"path","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`.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tabs"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateTabs`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateTabs"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview":{"post":{"operationId":"uncategorized_ResponsiveHtml_PostTemplateResponsiveHtmlPreview","summary":"Create template responsive HTML preview","description":"Creates a preview of the\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\nHTML versions of all of the documents associated\nwith a template. This method enables you to\npreview the PDF document conversions to responsive\nHTML across device types prior to sending.\n\nThe request body is a `documentHtmlDefinition`\nobject, which holds the responsive signing\nparameters that define how to generate the HTML\nversion of the documents.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinitions"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `documentHtmlDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentHtmlDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates":{"post":{"operationId":"templates_posttemplates","summary":"Creates one or more templates.","description":"Creates one or more template definitions, using a multipart\nrequest for each template.\n\n[Templates](/docs/esign-rest-api/esign101/concepts/templates/)\nhelp streamline the sending process when you frequently\nsend the same or similar documents, or send different documents\nto the same group of people.\n\nWhen you create a template, you define placeholder roles. Rather\nthan specifying a person, you specify a role that regularly\nparticipates in a transaction that uses the template. Then, when\nyou create or send an envelope based on the template, you assign\nactual recipients to the template roles. The recipients\nautomatically inherit all of the workflow that is defined for\nthat role in the template, such as the tabs and routing\ninformation.\n\n## Template Email Subject Merge Fields\n\nPlaceholder roles have associated merge fields that personalize\nthe email notification that Docusign sends. For example, the\ntemplate automatically personalizes the email message by adding\nplaceholders for the recipient's name and email address within\nthe email subject line, based on the recipient's role. When the\nsender adds the name and email information for the recipient and\nsends the envelope, the recipient information is automatically\nmerged into the appropriate fields in the email subject line.\n\nBoth the sender and the recipients will see the information in\nthe email subject line for any emails associated with the\ntemplate. This provides an easy way for senders to organize their\nenvelope emails without having to open an envelope to find out\nwho the recipient is.\n\nUse the following placeholders\nto insert a recipient's name or\nemail address in the subject line\n\nTo insert a recipient's name into the subject line,\nuse the `[[<roleName>_UserName]]` placeholder\nin the `emailSubject` property when you create the\ntemplate:\n\nTo include a recipient's name\nor email address in the subject line,\nuse the following placeholders\nin the `emailSubject` property:\n\n- `[[<roleName>_UserName]]`\n- `[[<roleName>_Email]]`\n\nFor example, if the role name is `Signer 1`,\nyou might set `emailSubject` to one of these strings:\n\n- `\"[[Signer 1_UserName]], Please sign this NDA\"`\n- `\"[[Signer 1_Email]], Please sign this NDA\"`\n\n**Note:** The maximum length of the\nsubject line is 100 characters,\nincluding any merged text.\n\n## Creating multiple templates\n\nTo create multiple templates, you provide a zip file of JSON\nfiles. You can also use the Templates::ListTemplates method with\nthe `is_download` query parameter to download a zip file\ncontaining your existing templates and use that as a guide. The\nAPI supports both .zip and .gzip file formats as input.\n\nYou also need to set the\n`Content-Length`,\n`Content-Type`,\nand\n`Content-Disposition`\nheaders:\n\n```text\nContent-Length: 71068\nContent-Type: application/zip\nContent-Disposition: file; filename=\"DocuSignTemplates_Nov_25_2019_20_40_21.zip\"; fileExtension=.zip\n```\n\n### Related topics\n\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)\n- [eSignature API rules and resource limits](/docs/esign-rest-api/esign101/rules-and-limits/)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"(Required) The external account number (int) or account ID GUID.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeTemplate`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTemplate"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"templates_gettemplates","summary":"Gets the list of templates.","description":"Retrieves the list of templates for the specified account. The request can be limited to a specific folder.\n\n### Related topics\n\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\n**Note:** If the `count` parameter is not used, `listTemplates` has a default limit of 2,000 templates. If the account has more than 2,000 templates, `listTemplates` will return the first 2,000 templates. To retrieve more than 2,000 templates, repeat the API call, specifying `start_position` and `count` to control the number of templates retrieved.","required":false,"schema":{"type":"string"}},{"name":"created_from_date","in":"query","description":"Lists templates created on or after this date.","required":false,"schema":{"type":"string"}},{"name":"created_to_date","in":"query","description":"Lists templates modified before this date.","required":false,"schema":{"type":"string"}},{"name":"folder_ids","in":"query","description":"A comma separated list of folder ID GUIDs.","required":false,"schema":{"type":"string"}},{"name":"folder_types","in":"query","description":"The type of folder to return templates for. Possible values are:\n\n- `templates`: Templates in the **My Templates** folder.\nTemplates in the **Shared Templates** and **All Template** folders (if the request ID from and Admin) are excluded.\n- `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder.\n- `recylebin`: Templates that have been deleted.","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list\nof additional template attributes\nto include in the response.\nValid values are:\n\n- `powerforms`: Includes details about the PowerForms associated with the templates.\n- `documents`: Includes information about template documents.\n- `folders`: Includes information about the folder that holds the template.\n- `favorite_template_status`: Includes the template `favoritedByMe` property. **Note:** You can mark a template as a favorite only in eSignature v2.1.\n- `advanced_templates`: Includes information about advanced templates.\n- `recipients`: Includes information about template recipients.\n- `custom_fields`: Includes information about template custom fields.\n- `notifications`: Includes information about the notification settings for templates.","required":false,"schema":{"type":"string"}},{"name":"is_deleted_template_only","in":"query","description":"When **true,** retrieves templates that have been permanently deleted. The default is **false.**\n\n**Note:** After you delete a template, you can see it in the `Deleted` bin in the UI for 24 hours. After 24 hours, the template is permanently deleted.","required":false,"schema":{"type":"string"}},{"name":"is_download","in":"query","description":"When **true,** downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file.\n\nThe `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.\n\nThe default is **false.**\n\n**Note:** This parameter only works when you specify a list of templates in the `template_ids` parameter.","required":false,"schema":{"type":"string"}},{"name":"link_configuration_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"modified_from_date","in":"query","description":"Lists templates modified on or after this date.","required":false,"schema":{"type":"string"}},{"name":"modified_to_date","in":"query","description":"Lists templates modified before this date.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Specifies the sort order of the search results.\nValid values are:\n\n- `asc`: Ascending (A to Z)\n- `desc`: Descending (Z to A)","required":false,"schema":{"type":"string"}},{"name":"order_by","in":"query","description":"Specifies how the search results are listed.\nValid values are:\n\n- `name`: template name\n- `modified`: date/time template was last modified\n- `used`: date/time the template was last used.","required":false,"schema":{"type":"string"}},{"name":"search_fields","in":"query","description":"A comma-separated list of additional template properties to search.\n\n- `sender`: Include sender name and email in the search.\n- `recipients`: Include recipient names and emails in the search.\n- `envelope`: Not used in template searches.","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"The text to use to search the names of templates.\n\nLimit: 48 characters.","required":false,"schema":{"type":"string"}},{"name":"shared_by_me","in":"query","description":"When **true,** the response only includes templates shared by the user. When **false,** the response only returns template not shared by the user. If not specified, templates are returned whether or not they have been shared by the user.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"template_ids","in":"query","description":"A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true.**","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\n\n**Note:** If this property is null, the value defaults to the current date.","required":false,"schema":{"type":"string"}},{"name":"used_from_date","in":"query","description":"Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.","required":false,"schema":{"type":"string"}},{"name":"used_to_date","in":"query","description":"End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.","required":false,"schema":{"type":"string"}},{"name":"user_filter","in":"query","description":"Filters the templates in the response. Valid values are:\n\n- `owned_by_me`: Results include only templates owned by the user.\n- `shared_with_me`: Results include only templates shared with the user.\n- `all`: Results include all templates owned or shared with the user.","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The ID of the user.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTemplateResults"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"uncategorized_Templates_PutTemplates","summary":"Update template autoMatch setting.","description":"Update template autoMatch setting.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateAutoMatchList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateAutoMatchList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateAutoMatchList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}":{"delete":{"operationId":"templates_Pages_DeleteTemplatePage","summary":"Deletes a page from a document in an template.","description":"Deletes a page from a document in a template based on the page number.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Templates_Pages_DeleteTemplatePage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `pageRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pageRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}":{"delete":{"operationId":"templates_deletetemplatepart","summary":"Remove template sharing for groups","description":"Removes a member group's sharing permissions for a specified template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"templatePart","in":"path","description":"Currently, the only defined part is **groups**.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `groupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_puttemplatepart","summary":"Shares a template with a group","description":"Shares a template with the specified members group.\n\n**Note:** For a newer version of this functionality, see [Accounts: Update Shared Access](/docs/esign-rest-api/reference/accounts/accounts/updatesharedaccess/).","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"templatePart","in":"path","description":"Currently, the only defined part is **groups**.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `groupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}":{"get":{"operationId":"templates_gettemplate","summary":"Gets a specific template associated with a specified account.","description":"Retrieves the definition of the specified template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"A comma-separated list\nof additional template attributes\nto include in the response.\nValid values are:\n\n- `powerforms`: Includes information about PowerForms.\n- `tabs`: Includes information about tabs.\n- `documents`: Includes information about documents.\n- `favorite_template_status`: : Includes the template `favoritedByMe` property in the response. **Note:** You can mark a template as a favorite only in eSignature v2.1.","required":false,"schema":{"type":"string"}},{"name":"link_configuration_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTemplate"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_puttemplate","summary":"Updates an existing template.","description":"Updates an existing template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateUpdateSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `envelopeTemplate`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/envelopeTemplate"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image":{"get":{"operationId":"templates_Pages_GetTemplatePageImage","summary":"Gets a page image from a template for display.","description":"Retrieves a page image for display from the specified template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"dpi","in":"query","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","required":false,"schema":{"type":"string"}},{"name":"max_height","in":"query","description":"Sets the maximum height of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"max_width","in":"query","description":"Sets the maximum width of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"prefer_svg","in":"query","description":"When set to **true**, requests the page image in SVG format instead of PNG, even when vectorized page rendering is not enabled for the account. SVG is returned only when SVG rendering is supported by the current document processing engine; otherwise a PNG image is returned. When **false** or omitted, the default format is used. The format of the returned image is indicated by the `Content-Type` response header (single page) or the `mimeType` property (multiple pages).","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Pages_PutTemplatePageImage","summary":"Rotates page image from a template for display.","description":"Rotates page image from a template for display. The page image can be rotated to the left or right.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"path","description":"The page number being accessed.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Templates_Pages_PutTemplatePageImage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `pageRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pageRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/notification":{"get":{"operationId":"templates_Notification_GetTemplatesTemplateIdNotification","summary":"Gets template notification information.","description":"Retrieves the envelope notification, reminders and expirations, information for an existing template.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"templates_Notification_PutTemplatesTemplateIdNotification","summary":"Updates the notification  structure for an existing template.","description":"Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateNotificationRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateNotificationRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages":{"get":{"operationId":"templates_Pages_GetTemplatePageImages","summary":"Returns document page image(s) based on input.","description":"Returns images of the pages in a template document for display based on the parameters that you specify.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"(Required) The external account number (int) or account ID GUID.","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"(Required) The ID of the document.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"(Required) The ID of the template.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.","required":false,"schema":{"type":"string"}},{"name":"dpi","in":"query","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","required":false,"schema":{"type":"string"}},{"name":"max_height","in":"query","description":"Sets the maximum height of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"max_width","in":"query","description":"Sets the maximum width of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"nocache","in":"query","description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value.","required":false,"schema":{"type":"string"}},{"name":"prefer_svg","in":"query","description":"When set to **true**, requests the page image in SVG format instead of PNG, even when vectorized page rendering is not enabled for the account. SVG is returned only when SVG rendering is supported by the current document processing engine; otherwise a PNG image is returned. When **false** or omitted, the default format is used. The format of the returned image is indicated by the `Content-Type` response header (single page) or the `mimeType` property (multiple pages).","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","description":"When **true,** changes display in the user interface.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pageImages"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/auto_match":{"put":{"operationId":"uncategorized_TemplatesAutoMatch_PutTemplates","summary":"Update template automatic matching setting.","description":"Update template automatic matching setting. When a document is added to an envelope, the automatic template matching feature compares the document to existing templates in the account. If Docusign can match the document to an existing template, that template can be applied automatically. Enabling the automatic template matching setting for a template adds it to the pool of templates that Docusign evaluates when trying to find a match for a document that is being added to an envelope.","tags":["uncategorized"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateAutoMatchList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateAutoMatchList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateAutoMatchList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/templates/{templateId}/views/edit":{"post":{"operationId":"templates_Views_PostTemplateEditView","summary":"Gets a URL for a template edit view.","description":"Returns a URL that enables you to embed the Template Edit view of Docusign eSignature. You can embed the view in an iframe.\n\n**API request update**\n\nThe API request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version: it solves a security issue with the old version. The deprecation schedule was announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information.\n\n**Best practices**\n\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\n\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\n\n### Closing the view's iframe\n\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\n\n- (One time) create a standalone “return” web page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\n- In your application, use `window.addEventListener(\"message\", function_name)` to register a listener for incoming messages.\n- To show the view, use this API method, then set the iframe to load the URL from the API response.\n- In your application, receive the completion message, validate it, and then close the iframe.\n\n### Information security\n\nThis view only has write access to the specific template referenced in the API call. The edit access corresponds to the access rights of the user associated with the access token used for the API call.\n\n**Recommendations:**\n\n- Use the access token of a service user who can access the template.\n- Do not use the access token of a user with administrator privileges.\n\n### Migrating to the current version of the request object\n\nThis section only applies to existing applications that use the older version of the request object.\n\nMigrating from the old API request object to the new version will take under a day of developer time.\n\n**Step 1.** Does your application set the returnUrl attribute?\n\nYes: continue with step 2.\n\nNo: In this case, your users first edit the template, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\n\n- Set the returnUrl to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests.\n- When the endpoint is called, use the EnvelopeViews:createConsole API call to obtain and then display the Docusign eSignature home page to your application's user.\n\n**Step 2.** Check that these API attributes are set:\n\n- `\"viewAccess\" = \"template\"`\n- the `returnUrl` is set.\n\n**Step 3.** All done! Test your application.","tags":["templates"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","description":"The ID of the template.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewUrl"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `templateViewRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateViewRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/groups/{groupId}/brands":{"delete":{"operationId":"groups_Brands_DeleteGroupBrands","summary":"Deletes brand information from a group.","description":"This method deletes one or more brands from a group.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of the group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupBrands"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `brandsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandsRequest"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"groups_Brands_GetGroupBrands","summary":"Gets the brand information for a group.","description":"This method returns information about the brands associated with a group.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of the group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupBrands"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"groups_Brands_PutGroupBrands","summary":"Adds an existing brand to a group.","description":"This method adds one or more existing brands to a group based on the `groupId`.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of the group being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupBrands"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `brandsRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brandsRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/groups":{"post":{"operationId":"groups_postgroups","summary":"Creates one or more groups for the account.","description":"Creates one or more groups for the account.\n\nGroups help you manage users.\nFor example, you can use groups\nto limit user access to templates.\n\n<Warning>\nThis endpoint uses only\nthe `groupName` property in the request body.\nAll other properties are ignored.\n</Warning>\n\nExample request:\n\n```json\n{\n  \"groups\": [\n    { \"groupName\": \"montagues\" },\n    { \"groupName\": \"capulets\" },\n    { \"groupName\": \"nobles\"}\n  ]\n}\n```","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `groupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"groups_deletegroups","summary":"Deletes an existing user group.","description":"Deletes an existing user group.\n\nWhen you delete a group, you include only the `groupId` in the request body.\n\nExample:\n\n```json\n{\n  \"groups\": [\n    {\n      \"groupId\": \"12345\"\n    }\n}\n```","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `groupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"groups_getgroups","summary":"Gets information about groups associated with the account.","description":"Gets information about groups associated with the account.\n\n<Note>\nTo get the users in a group:\n\n1. Use this endpoint to get the group ID.\n2. Use [listGroupUsers](/docs/esign-rest-api/reference/usergroups/groupusers/list/)\nto get the list of users.\n</Note>\n\n### Related topics\n\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`","required":false,"schema":{"type":"string"}},{"name":"group_type","in":"query","description":"The type of group to return. Valid values:\n\n- `AdminGroup`\n- `CustomGroup`\n- `EveryoneGroup`","required":false,"schema":{"type":"string"}},{"name":"include_usercount","in":"query","description":"When **true,** every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true.**","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","description":"Filters the results of a GET request based on the text that you specify.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"groups_putgroups","summary":"Updates the group information for a group.","description":"Updates the group name.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `groupInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/groups/{groupId}/users":{"delete":{"operationId":"groups_deletegroupusers","summary":"Deletes one or more users from a group","description":"Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of the group being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userInfoList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInfoList"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"groups_getgroupusers","summary":"Gets a list of users in a group.","description":"Retrieves a list of users in a group.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of the group being accessed.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`\n\nDefault: `50`","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groupUsersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"groups_putgroupusers","summary":"Adds one or more users to an existing group.","description":"Adds one or more existing Docusign users to an existing group.","tags":["groups"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of the group being accessed.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userInfoList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInfoList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/contacts":{"post":{"operationId":"users_Contacts_PostContacts","summary":"Add contacts to a contacts list.","description":"This method adds multiple contacts into a contacts list.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `contactModRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactModRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"users_Contacts_DeleteContacts","summary":"Deletes multiple contacts from an account.","description":"This method deletes multiple contacts associated with an account. **Note:** A maximum of 3,000 contacts can be deleted with a single call to this endpoint.\n\nUsers can delete their own contacts, and account administrators can delete **Shared contacts** within the same account.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `contactModRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactModRequest"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_Contacts_PutContacts","summary":"Updates one or more contacts.","description":"This method updates one or more contacts associated with an account.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `contactModRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactModRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/contacts/{contactId}":{"delete":{"operationId":"users_Contacts_DeleteContactWithId","summary":"Deletes a contact.","description":"This method deletes a contact associated with an account.\n\nUsers can delete their own contacts, and account administrators can delete **Shared contacts** within the same account.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","description":"The ID of a contact person in the account's address book.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactUpdateResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_Contacts_GetContactById","summary":"Gets one or more contacts.","description":"This method returns one or more contacts\nassociated with a DocuSign account. You can also\nretrieve contacts from connected [cloud storage][CloudStorage] providers by using the\n`cloud_provider` query parameter. By default,\ncontacts are retrieved from the DocuSign account's\ndefault address book.\n\nTo return a specific contact, use the `contactId`\nquery parameter. To return all contacts associated\nwith an account, omit this parameter.\n\n[CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","description":"The ID of a contact person in the account's address book.\n\n**Note:** To return all contacts, omit this parameter. It is not required.","required":true,"schema":{"type":"string"}},{"name":"cloud_provider","in":"query","description":"(Optional) The cloud provider from which to retrieve the contacts. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contactGetResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/custom_settings":{"delete":{"operationId":"users_UserCustomSettings_DeleteCustomSettings","summary":"Deletes custom user settings for a specified user.","description":"Deletes the specified custom user settings for a single user.\n\nIf the custom user settings you want to delete are grouped, you\nmust include the `X-DocuSign-User-Settings-Key` header\nin the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of\ncustomer user settings.\n\nIf the `X-DocuSign-User-Settings-Key` header is not included,\nonly the custom user settings that were added without\na group are deleted.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customSettingsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customSettingsInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_UserCustomSettings_GetCustomSettings","summary":"Retrieves the custom user settings for a specified user.","description":"Retrieves a list of custom user settings for a single user.\n\nCustom settings provide a flexible way to store and retrieve\ncustom user information that can be used in your own system.\n\n**Note:** Custom user settings are not the same as user account\nsettings.\n\nIf the custom user settings you want to retrieve are grouped, you\nmust include the `X-DocuSign-User-Settings-Key` header\nin the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of\ncustomer user settings.\n\nIf the `X-DocuSign-User-Settings-Key` header is not included, only the custom\nuser settings that were added without a group are retrieved.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserCustomSettings_PutCustomSettings","summary":"Adds or updates custom user settings for the specified user.","description":"Adds or updates custom user settings for the specified user.\n\n**Note:** Custom user settings are not the same as user account\nsettings.\n\nCustom settings provide a flexible way to store and retrieve\ncustom user information that you can use in your own system.\n\n**Important:** There is a limit on the size for all the custom\nuser settings for a single user. The limit is 4,000 characters,\nwhich includes the XML and JSON structure for the settings.\n\nYou can group custom user settings when adding them. Grouping\nallows you to retrieve settings that are in a specific group,\ninstead of retrieving all the user custom settings.\n\nTo group custom user settings, include the\n`X-DocuSign-User-Settings-Key` header in the request:\n\n`X-DocuSign-User-Settings-Key:group_name`\n\nWhere the `group_name` is your designated name for the group of\ncustomer user settings.\n\nWhen getting or deleting grouped custom user settings, you must\ninclude the `X-DocuSign-User-Settings-Key` header information.\n\nGrouping custom user settings is not required and if the `X-DocuSign-User-Settings-Key`\nheader information is not included, the custom user settings are\nadded normally and can be retrieved or deleted without including\nthe `X-DocuSign-User-Settings-Key` header.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `customSettingsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customSettingsInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/profile":{"get":{"operationId":"users_UserProfile_GetProfile","summary":"Retrieves the user profile for a specified user.","description":"Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userProfile"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserProfile_PutProfile","summary":"Updates the user profile information for the specified user.","description":"Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.\n\nYou can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_UserProfile_PutProfile_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userProfile`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userProfile"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users":{"post":{"operationId":"users_postusers","summary":"Adds new users to the specified account.","description":"Adds new users to an account.\n\nThe body of this request is an array of `newUsers` objects. For each new user, you must provide at least the `userName` and `email` properties. The maximum number of users you can create in one request is 500 users.\n\nThe `userSettings` property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`.\n\n```bash\nPOST /restapi/v2.1/accounts/{accountId}/users\nContent-Type: application/json\n```\n\n```json\n{\n  \"newUsers\": [\n    {\n      \"userName\": \"Claire Horace\",\n      \"email\": \"claire@example.com\"\n    },\n    {\n      \"userName\": \"Tal Mason\",\n      \"email\": \"talmason@example.com\",\n      \"company\": \"TeleSel\",\n      \"userSettings\": {\n        \"locale\": \"fr\",\n        \"canSendEnvelope\": true\n      }\n    }\n  ]\n}\n```\n\nA successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong.\n\n```json\n{\n  \"newUsers\": [\n    {\n      \"userId\": \"18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade\",\n      \"uri\": \"/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade\",\n      \"email\": \"claire@example.com\",\n      \"userName\": \"Claire Horace\",\n      \"createdDateTime\": \"0001-01-01T08:00:00.0000000Z\",\n      \"errorDetails\": {\n        \"errorCode\": \"USER_ALREADY_EXISTS_IN_ACCOUNT\",\n        \"message\": \"Username and email combination already exists for this account.\"\n      }\n    },\n    {\n      \"userId\": \"be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33\",\n      \"uri\": \"/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33\",\n      \"email\": \"talmason@example.com\",\n      \"userName\": \"Tal Mason\",\n      \"userStatus\": \"ActivationSent\",\n      \"createdDateTime\": \"2020-05-26T23:25:30.7330000Z\"\n    }\n  ]\n}\n```","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/newUsersSummary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `newUsersDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/newUsersDefinition"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"users_deleteusers","summary":"Closes one or more users in the account.","description":"Closes one or more users in the account,\npreventing them from accessing account features.\nUsers are not permanently deleted.\n\nThe request body requires only\nthe IDs of the users to close:\n\n```json\n{\n    \"users\": [\n        { \"userId\": \"6b67a1ee-xxxx-xxxx-xxxx-385763624163\" },\n        { \"userId\": \"b6c74c52-xxxx-xxxx-xxxx-457a81d88926\" },\n        { \"userId\": \"464f7988-xxxx-xxxx-xxxx-781ee556ab7a\" }\n    ]\n}\n```\n\nYou can use [`Users:update`](/docs/esign-rest-api/reference/users/users/update/)\nto re-open a closed user.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"delete","in":"query","description":"A list of groups to remove the user from.\nA comma-separated list of the following:\n\n- `Groups`\n- `PermissionSet`\n- `SigningGroupsEmail`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usersResponse"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userInfoList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInfoList"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_getusers","summary":"Retrieves the list of users for the specified account. You can filter the users list to get specific users.","description":"Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account, with information about the result set. If the `additional_info` query is added to the endpoint and set to **true,** full user information is returned for each user.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"(Required) The external account number (int) or account ID GUID.","required":true,"schema":{"type":"string"}},{"name":"additional_info","in":"query","description":"When **true,** the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is **false.**","required":false,"schema":{"type":"string"}},{"name":"alternate_admins_only","in":"query","description":"When **true,** returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.\n\nValid values: `1` to `100`","required":false,"schema":{"type":"string"}},{"name":"domain_users_only","in":"query","description":"When **true,** return only users in [domains](https://support.docusign.com/s/document-item?rsc_301=&bundleId=rrf1583359212854&topicId=jub1589318086105.html) claimed by your organization. The default value is **false.**","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Filters results based on the email address associated with the user that you want to return.\n\n**Note:** You can use either this parameter or the `email_substring` parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address.","required":false,"schema":{"type":"string"}},{"name":"email_substring","in":"query","description":"Filters results based on a fragment of an email address. For example, you could enter `gmail.com` to return all users who have Gmail addresses.\n\n**Note:** You do not use a wildcard character with this parameter. You can use either this parameter or the `email` parameter, but not both.","required":false,"schema":{"type":"string"}},{"name":"group_id","in":"query","description":"Filters results based on one or more group IDs.","required":false,"schema":{"type":"string"}},{"name":"include_license","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_usersettings_for_csv","in":"query","description":"When **true,** the response includes the `userSettings` object data in CSV format.","required":false,"schema":{"type":"string"}},{"name":"login_status","in":"query","description":"When **true,** the response includes the login status of each user.","required":false,"schema":{"type":"string"}},{"name":"not_group_id","in":"query","description":"Return user records excluding the specified group ID.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filters results by user account status.\nA comma-separated list of any of the following:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","description":"Filters the user records returned by the user name or a sub-string of user name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInformationList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_putusers","summary":"Changes one or more users in the specified account.","description":"This method updates the information about one or more account users.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"allow_all_languages","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInformationList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userInformationList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInformationList"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/profile/image":{"delete":{"operationId":"users_UserProfileImage_DeleteUserProfileImage","summary":"Deletes the user profile image for the specified user.","description":"Deletes the user profile image from the  specified user's profile.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_UserProfileImage_DeleteUserProfileImage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_UserProfileImage_GetUserProfileImage","summary":"Retrieves the user profile image for the specified user.","description":"Retrieves the user profile picture for the specified user.\n\nThe `userId` path parameter must match the authenticated user's user ID,\nand the user must be a member of the specified account.\n\n| Return value | Meaning |\n| --- | --- |\n| `200 OK` | The response contains the profile image in the same format as it was uploaded. |\n| `404 Not found` | The user does not have a profile image. |\n| `400 Bad request` | There was an error in the request. The response has more information. |","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"encoding","in":"query","description":"Reserved for Docusign.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserProfileImage_PutUserProfileImage","summary":"Updates the user profile image for a specified user.","description":"Updates the user profile image by uploading an image to the user profile.\n\nThe supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_UserProfileImage_PutUserProfileImage_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}":{"get":{"operationId":"users_User_GetUser","summary":"Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint.","description":"Retrieves the user information for the specified user. For example:\n\n```json\n{\n  \"userName\": \"Tania Morales\",\n  \"userId\": \"6b67a1ee-xxxx-xxxx-xxxx-385763624163\",\n  \"userType\": \"CompanyUser\",\n  \"isAdmin\": \"False\",\n  \"isNAREnabled\": \"false\",\n  \"userStatus\": \"Active\",\n  \"uri\": \"/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163\",\n  \"email\": \"examplename42@orobia.net\",\n  \"createdDateTime\": \"2019-04-01T22:11:56.4570000Z\",\n  \"userAddedToAccountDateTime\": \"0001-01-01T08:00:00.0000000Z\",\n  \"firstName\": \"Tania\",\n  \"lastName\": \"Morales\",\n  \"jobTitle\": \"\",\n  \"company\": \"Company\",\n  \"permissionProfileId\": \"12345678\",\n  \"permissionProfileName\": \"DocuSign Viewer\",\n  \"userSettings\": {. . .},\n  \"sendActivationOnInvalidLogin\": \"false\",\n  \"enableConnectForUser\": \"false\",\n  \"groupList\": [. . .],\n  \"workAddress\": {. . .},\n  \"homeAddress\": {. . .},\n  \"signatureImageUri\": \"/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/signature_image\",\n  \"initialsImageUri\": \"/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/initials_image\",\n  \"defaultAccountId\": \"f636f297-xxxx-xxxx-xxxx-8e7a14715950\"\n}\n```","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"additional_info","in":"query","description":"Setting this parameter has no effect in this operation.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Setting this parameter has no effect in this operation.","required":false,"schema":{"type":"string"}},{"name":"include_license","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_User_PutUser","summary":"Updates user information for the specified user.","description":"To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.\n\n**Note:** To resend the activation email to a user who is not yet activated, set the value of `sendActivationEmail` to `\"send\"` in when making this API call.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"allow_all_languages","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/settings":{"get":{"operationId":"users_UserSettings_GetUserSettings","summary":"Gets the user account settings for a specified user.","description":"Retrieves a list of the account settings and email\nnotification information for the specified user.\n\nThe response returns the account setting\nname/value information and the email notification\nsettings for the specified user. For more\ninformation, see\n[Users:create](/docs/esign-rest-api/reference/users/users/create/).","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSettingsInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserSettings_PutUserSettings","summary":"Updates the user account settings for a specified user.","description":"Updates the account settings list and email notification types for the specified user.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"allow_all_languages","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_UserSettings_PutUserSettings_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userSettingsInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSettingsInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/signatures":{"post":{"operationId":"users_UserSignatures_PostUserSignatures","summary":"Add user signatures","description":"Adds a user signature image and/or user initials image to the specified user. \n\nThe userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account.\n\nThe rules and processes associated with this are:\n\n* If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.\n* If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.\n\nFor each Image part, the Content-Disposition header has a \"filename\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. \n\nFor example: \n`Content-Disposition: file; filename=\"Ron Test20121127083900\"`\n\nIf no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.\n\nThe Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.\n\nIf successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignaturesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userSignaturesInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignaturesInformation"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_UserSignatures_GetUserSignatures","summary":"Retrieves a list of signature definitions for a user.","description":"This method retrieves the signature definitions for the user that you specify.\n\nThe `userId` parameter specified in the endpoint must match the authenticated user's user ID, and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\n\nFor example, encode \"Bob Smith\" as \"Bob%20Smith\".","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"stamp_type","in":"query","description":"The type of stamps to return. Valid values are:\n\n- `signature`: Returns information about signature images only. This is the default value.\n- `stamp`: Returns information about eHanko and custom stamps only.\n- null","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignaturesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserSignatures_PutUserSignature","summary":"Adds/updates a user signature.","description":"Adds/updates a user signature.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignaturesInformation"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userSignaturesInformation`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignaturesInformation"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}":{"delete":{"operationId":"users_UserSignatures_DeleteUserSignature","summary":"Removes removes signature information for the specified user.","description":"Removes the signature information for the user.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_UserSignatures_DeleteUserSignature_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_UserSignatures_GetUserSignature","summary":"Gets the user signature information for the specified user.","description":"Retrieves the structure of a single signature with a known signature name.\n\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserSignatures_PutUserSignatureById","summary":"Updates the user signature for a specified user.","description":"Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.\n\n**Note:** This will also create a default signature for the user when one does not exist.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"close_existing_signature","in":"query","description":"When **true,** closes the current signature.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `userSignatureDefinition`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignatureDefinition"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}":{"delete":{"operationId":"users_UserSignatures_DeleteUserSignatureImage","summary":"Deletes the user initials image or the  user signature image for the specified user.","description":"Deletes the specified initials image or signature image for the specified user.\n\nThe function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.\n\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"path","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"users_UserSignatures_GetUserSignatureImage","summary":"Retrieves the user initials image or the  user signature image for the specified user.","description":"Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n\n**Note:** Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"path","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"include_chrome","in":"query","description":"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"users_UserSignatures_PutUserSignatureImage","summary":"Updates the user signature image or user initials image for the specified user.","description":"Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.\n\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\n\nThe `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \n\nFor example encode \"Bob Smith\" as \"Bob%20Smith\".\n","tags":["users"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"path","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`","required":true,"schema":{"type":"string"}},{"name":"signatureId","in":"path","description":"The ID of the account stamp.","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"transparent_png","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userSignature"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"Updated image content.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files":{"post":{"operationId":"workspaces_WorkspaceFile_PostWorkspaceFiles","summary":"Creates a workspace file.","description":"This method adds a file to a workspace.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaceItem"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}":{"delete":{"operationId":"workspaces_WorkspaceFolder_DeleteWorkspaceItems","summary":"Deletes files or sub-folders from a workspace.","description":"This method deletes one or more files or sub-folders from a workspace folder or root.\n\nNote: To delete items from a workspace, the `status` of the workspace must be `active`.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspaces_WorkspaceFolder_DeleteWorkspaceItems_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workspaceItemList`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaceItemList"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"workspaces_WorkspaceFolder_GetWorkspaceFolder","summary":"List Workspace Folder Contents","description":"This method returns the contents of a workspace folder, which can include sub-folders and files.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.","required":false,"schema":{"type":"string"}},{"name":"include_files","in":"query","description":"When **true,** the response includes file information (in addition to folder information). The default is **false.**","required":false,"schema":{"type":"string"}},{"name":"include_sub_folders","in":"query","description":"When **true,** the response includes information about the sub-folders of the current folder. The default is **false.**","required":false,"schema":{"type":"string"}},{"name":"include_thumbnails","in":"query","description":"When **true,** the response returns thumbnails. The default is **false.**","required":false,"schema":{"type":"string"}},{"name":"include_user_detail","in":"query","description":"When **true,** the response includes extended details about the user. The default is **false.**","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}},{"name":"workspace_user_id","in":"query","description":"If set, the response only includes results associated with the `userId` that you specify.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaceFolderContents"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}":{"get":{"operationId":"workspaces_WorkspaceFile_GetWorkspaceFile","summary":"Gets a workspace file","description":"This method returns a binary version of a file in a workspace.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","description":"The ID of the file.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}},{"name":"is_download","in":"query","description":"When **true,** the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false.**","required":false,"schema":{"type":"string"}},{"name":"pdf_version","in":"query","description":"When **true** the file is returned in PDF format.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspaces_WorkspaceFile_GetWorkspaceFile_Response_200"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"workspaces_WorkspaceFile_PutWorkspaceFile","summary":"Update workspace file or folder metadata","description":"This method updates the metadata for one or more specific files or folders in a workspace.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","description":"The ID of the file.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaceItem"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages":{"get":{"operationId":"workspaces_WorkspaceFilePages_GetWorkspaceFilePages","summary":"List File Pages","description":"This method returns a workspace file as rasterized pages.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","description":"The ID of the file.","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"path","description":"The ID of the folder.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return.\n\nUse `start_position` to specify the number of results to skip.","required":false,"schema":{"type":"string"}},{"name":"dpi","in":"query","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","required":false,"schema":{"type":"string"}},{"name":"max_height","in":"query","description":"Sets the maximum height of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"max_width","in":"query","description":"Sets the maximum width of the returned images in pixels.","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","description":"The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pageImages"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/workspaces":{"post":{"operationId":"workspaces_Workspace_PostWorkspace","summary":"Create a Workspace","description":"This method creates a new workspace.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workspace`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"workspaces_Workspace_GetWorkspaces","summary":"List Workspaces","description":"Gets information about the Workspaces that have been created.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspaceList"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]}},"/v2.1/accounts/{accountId}/workspaces/{workspaceId}":{"delete":{"operationId":"workspaces_Workspace_DeleteWorkspace","summary":"Delete Workspace","description":"Deletes an existing workspace (logically).","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"get":{"operationId":"workspaces_Workspace_GetWorkspace","summary":"Get Workspace","description":"Retrieves properties about a workspace given a unique workspaceId.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"workspaces_Workspace_PutWorkspace","summary":"Update Workspace","description":"Updates information about a specific workspace.","tags":["workspaces"],"parameters":[{"name":"accountId","in":"path","description":"The external account number (int) or account ID Guid.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"path","description":"The ID of the workspace.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}}},"400":{"description":"Error encountered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorDetails"}}}}},"requestBody":{"description":"This endpoint expects an object: `workspace`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/workspace"}}}},"security":[{"bearerAuth":[]}]}}},"tags":[{"name":"accounts"},{"name":"uncategorized"},{"name":"trustServiceProviders"},{"name":"billing"},{"name":"cloudStorage"},{"name":"connect"},{"name":"customTabs"},{"name":"diagnostics"},{"name":"envelopes"},{"name":"notary"},{"name":"folders"},{"name":"powerForms"},{"name":"signingGroups"},{"name":"templates"},{"name":"groups"},{"name":"users"},{"name":"workspaces"}],"servers":[{"url":"https://demo.docusign.net/restapi","description":"Demo"},{"url":"https://www.docusign.net/restapi","description":"Production"}],"components":{"schemas":{"errorDetails":{"type":"object","properties":{"errorCode":{"type":"string","description":"The code associated with the error condition."},"message":{"type":"string","description":"A brief message describing the error condition."}},"description":"This object describes errors that occur. It is only valid for responses, and ignored in requests.","title":"errorDetails"},"nameValue":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"name":{"type":"string","description":"The name of the item."},"originalValue":{"type":"string","description":"The initial value of the item."},"value":{"type":"string","description":"The current value of the item."}},"description":"A name-value pair that describes an item and provides a value for the item.","title":"nameValue"},"brandEmailContent":{"type":"object","properties":{"content":{"type":"string","description":"Deprecated."},"emailContentType":{"type":"string","description":"Deprecated."},"emailToLink":{"type":"string","description":"Deprecated."},"linkText":{"type":"string","description":"Deprecated."}},"description":"Deprecated.","title":"brandEmailContent"},"brandLink":{"type":"object","properties":{"linkText":{"type":"string","description":"The text used for the link."},"linkType":{"type":"string","description":"The type of link. Valid values include:\n\n- `aboutDocusign`\n- `closeButton`"},"showLink":{"type":"string","description":"When **true,** the link displays to the recipient."},"urlOrMailTo":{"type":"string","description":"The URL or mailto address of the link."}},"description":"Information about a link that a brand uses.","title":"brandLink"},"brandLogoIds":{"type":"object","properties":{"emailLogoId":{"type":"string"},"primaryLogoId":{"type":"string"},"secondaryLogoId":{"type":"string"}},"title":"brandLogoIds"},"brandLogos":{"type":"object","properties":{"email":{"type":"string","description":"The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)."},"primary":{"type":"string","description":"The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)."},"secondary":{"type":"string","description":"The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)."}},"description":"The URIs for retrieving the logos that are associated with the brand.\n\nThese are read-only properties that provide a URI to logos in use.\nTo update a logo use\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/).\n","title":"brandLogos"},"brandResourceUrls":{"type":"object","properties":{"email":{"type":"string","description":"The URI for the email resource file that the brand uses."},"sending":{"type":"string","description":"The URI for the sending resource file that the brand uses."},"signing":{"type":"string","description":"The URI for the signing resource file that the brand uses."},"signingCaptive":{"type":"string","description":"The URI for the captive (embedded) signing resource file that the brand uses."}},"description":"Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.","title":"brandResourceUrls"},"brand":{"type":"object","properties":{"brandCompany":{"type":"string","description":"The name of the company associated with the brand."},"brandId":{"type":"string","description":"The ID used to identify a specific brand in API calls."},"brandLanguages":{"type":"array","items":{"type":"string"},"description":"An array of two-letter codes for the languages that you want to use with the brand. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)"},"brandName":{"type":"string","description":"The name of the brand."},"colors":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"An array of name-value pairs specifying the colors that the brand uses for the following elements:\n\n- Button background\n- Button text\n- Header background\n- Header text"},"defaultBrandLanguage":{"type":"string","description":"The two-letter code for the language that you want to use as the brand default. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)"},"emailContent":{"type":"array","items":{"$ref":"#/components/schemas/brandEmailContent"},"description":"Deprecated."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"isOrganizationBrand":{"type":"string"},"isOverridingCompanyName":{"type":"boolean","description":"When **true,** the `brandCompany` property is overriding the name of the company in the account settings."},"isSendingDefault":{"type":"boolean","description":"When **true,** the sending brand is the default brand for sending new envelopes."},"isSigningDefault":{"type":"boolean","description":"When **true,** the siging brand is the default brand for the signing experience."},"landingPages":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"An array of name/value pairs specifying the pages to which the user is redirected after the following events occur:\n\n- Signing Completed\n- Viewed Exit\n- Finish Later\n- Decline\n- Session Timeout\n- Authentication Failure\n\nIf you do not specify landing pages, the Docusign default pages are used."},"links":{"type":"array","items":{"$ref":"#/components/schemas/brandLink"},"description":"An array of `brandLink` objects that contain information about the links that the brand uses."},"logoIds":{"$ref":"#/components/schemas/brandLogoIds"},"logos":{"$ref":"#/components/schemas/brandLogos"},"organizationBrandLogo":{"type":"string"},"resources":{"$ref":"#/components/schemas/brandResourceUrls"}},"description":"Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.","title":"brand"},"brandsResponse":{"type":"object","properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/brand"},"description":"The list of brands."},"recipientBrandIdDefault":{"type":"string","description":"The brand seen by envelope recipients when a brand is not explicitly set."},"senderBrandIdDefault":{"type":"string","description":"The brand seen by envelope senders when a brand is not explicitly set."}},"title":"brandsResponse"},"Accounts_Brand_DeleteBrand_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_Brand_DeleteBrand_Response_200"},"brandRequest":{"type":"object","properties":{"brandId":{"type":"string","description":"The ID of the brand used in API calls"}},"description":"This request object contains information about a specific brand.","title":"brandRequest"},"brandsRequest":{"type":"object","properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/brandRequest"},"description":"A list of brands."}},"description":"Details about one or more brands.","title":"brandsRequest"},"Accounts_BrandLogo_DeleteBrandLogo_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_BrandLogo_DeleteBrandLogo_Response_200"},"Accounts_BrandExport_GetBrandExportFile_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_BrandExport_GetBrandExportFile_Response_200"},"Accounts_BrandResources_GetBrandResources_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_BrandResources_GetBrandResources_Response_200"},"userInfo":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID associated with the envelope."},"accountName":{"type":"string","description":"The name on the account."},"activationAccessCode":{"type":"string","description":"Access code provided to the user to activate the account."},"email":{"type":"string","description":"The user's email address."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"ipAddress":{"type":"string"},"loginStatus":{"type":"string","description":"When **true,** indicates that the user is logged in. This is a read-only property."},"membershipId":{"type":"string","description":"The user's membership ID."},"sendActivationEmail":{"type":"string","description":"This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/)."},"uri":{"type":"string","description":"A URI containing the user ID."},"userId":{"type":"string","description":"The ID of the user to access."},"userName":{"type":"string","description":"The name of the user."},"userStatus":{"type":"string","description":"Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`"},"userType":{"type":"string","description":"The type of user, for example `CompanyUser`."}},"title":"userInfo"},"brandResources":{"type":"object","properties":{"createdByUserInfo":{"$ref":"#/components/schemas/userInfo"},"createdDate":{"type":"string","description":"The date and time that the brand resource was created."},"dataNotSavedNotInMaster":{"type":"array","items":{"type":"string"},"description":"Deprecated."},"modifiedByUserInfo":{"$ref":"#/components/schemas/userInfo"},"modifiedDate":{"type":"string","description":"The date on which this user record was last modified."},"modifiedTemplates":{"type":"array","items":{"type":"string"},"description":"This property is returned in the response to the [AccountBrands::listResources](/docs/esign-rest-api/reference/accounts/accountbrands/listresources/) request. It contains a list of any email templates that have been modified to differ from the master resource files."},"resourcesContentType":{"type":"string","description":"The type of brand resource file. A brand uses a different resource file to control each of the following experiences:\n\n- Sending (`sending`)\n- Signing (`signing`)\n- Email messages (`email`)\n- Captive (embedded) signing (`signing_captive`)\n\nYou can modify the default email messages and formats in these files and upload them to your brand to customize the user experience."},"resourcesContentUri":{"type":"string","description":"The URI for the brand resource file."}},"description":"Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.","title":"brandResources"},"brandResourcesList":{"type":"object","properties":{"resourcesContentTypes":{"type":"array","items":{"$ref":"#/components/schemas/brandResources"},"description":"A list of resources that the brand uses."}},"title":"brandResourcesList"},"Accounts_BrandLogo_PutBrandLogo_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_BrandLogo_PutBrandLogo_Response_200"},"settingsMetadata":{"type":"object","properties":{"is21CFRPart11":{"type":"string","description":"When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."},"options":{"type":"array","items":{"type":"string"},"description":"An array of option strings supported by this setting."},"rights":{"type":"string","description":"Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"},"uiHint":{"type":"string","description":"Reserved for Docusign."},"uiOrder":{"type":"string","description":"Reserved for Docusign."},"uiType":{"type":"string","description":"Reserved for Docusign."}},"description":"Metadata that indicates whether a property is editable and describes setting-specific options.","title":"settingsMetadata"},"consumerDisclosure":{"type":"object","properties":{"accountEsignId":{"type":"string","description":"The GUID of the account associated with the consumer disclosure."},"allowCDWithdraw":{"type":"string","description":"When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.** **Note:** Only Admin users can change this setting."},"allowCDWithdrawMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"changeEmail":{"type":"string","description":"If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters."},"changeEmailOther":{"type":"string","description":"Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not require any other information from you to change your email address.`"},"companyName":{"type":"string","description":"Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**"},"companyPhone":{"type":"string","description":"The phone number of the company associated with the consumer disclosure, as a free-formatted string."},"copyCostPerPage":{"type":"string","description":"The cost per page if the customer requests paper copies.\n\nExample:\n\n`0.0000`"},"copyFeeCollectionMethod":{"type":"string","description":"Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We will bill you for any fees at that time, if any.`"},"copyRequestEmail":{"type":"string","description":"The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters."},"custom":{"type":"string","description":"When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"},"enableEsign":{"type":"string","description":"When **true** (default), indicates that eSign is enabled."},"esignAgreement":{"type":"string","description":"The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting."},"esignText":{"type":"string","description":"The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting."},"languageCode":{"type":"string","description":"The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`)\n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."},"mustAgreeToEsign":{"type":"string","description":"When **true,** the recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions."},"pdfId":{"type":"string","description":"**Deprecated.**\n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored."},"useBrand":{"type":"string","description":"When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.\n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD."},"useConsumerDisclosureWithinAccount":{"type":"string","description":"When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."},"useConsumerDisclosureWithinAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"withdrawAddressLine1":{"type":"string","description":"Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "},"withdrawAddressLine2":{"type":"string","description":"Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "},"withdrawByEmail":{"type":"string","description":"When **true** (default), indicates that the customer can withdraw consent by email."},"withdrawByMail":{"type":"string","description":"When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"},"withdrawByPhone":{"type":"string","description":"When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"},"withdrawCity":{"type":"string","description":"Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. "},"withdrawConsequences":{"type":"string","description":"Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."},"withdrawEmail":{"type":"string","description":"Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "},"withdrawOther":{"type":"string","description":"Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`"},"withdrawPhone":{"type":"string","description":"Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters."},"withdrawPostalCode":{"type":"string","description":"Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. "},"withdrawState":{"type":"string","description":"Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"}},"description":"Details about consumer disclosures.","title":"consumerDisclosure"},"customField":{"type":"object","properties":{"customFieldType":{"type":"string","description":"The type of custom field. Valid values are:\n\n- `text` (default)\n- `list`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"fieldId":{"type":"string","description":"The ID of the custom field."},"listItems":{"type":"array","items":{"type":"string"},"description":"For a list custom field, this is an array of strings that represent the items in a list.\n\nMaximum Length: 2,000 characters."},"name":{"type":"string","description":"The name of the custom field."},"required":{"type":"string","description":"When **true,** the signer must complete the custom field."},"show":{"type":"string","description":"When **true,** the custom field displays at the top of the Certificate of Completion."},"value":{"type":"string","description":"Specifies the value of the custom field.\n\nMaximum Length: 2,000 characters."}},"description":"This object provides details about a custom field.","title":"customField"},"listCustomField":{"type":"object","properties":{"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`."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"fieldId":{"type":"string","description":"The ID of the custom field."},"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."},"name":{"type":"string","description":"The name 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."},"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."}},"description":"This object represents a list custom field from which envelope creators and senders can select custom data.","title":"listCustomField"},"textCustomField":{"type":"object","properties":{"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`."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"fieldId":{"type":"string","description":"The ID of the custom field."},"name":{"type":"string","description":"The name of the custom field."},"required":{"type":"string","description":"When **true,** senders are required to enter or select information for the field before they can send the envelope."},"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. The user who creates or sends the envelope provides this value. Maximum length: 100 characters."}},"description":"This object represents a free text custom field where envelope creators and senders can enter custom data.","title":"textCustomField"},"customFields":{"type":"object","properties":{"listCustomFields":{"type":"array","items":{"$ref":"#/components/schemas/listCustomField"},"description":"An array of list custom fields."},"textCustomFields":{"type":"array","items":{"$ref":"#/components/schemas/textCustomField"},"description":"An array of text custom fields."}},"description":"Contains information about custom fields.","title":"customFields"},"Accounts_AccountCustomFields_DeleteAccountCustomFields_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_AccountCustomFields_DeleteAccountCustomFields_Response_200"},"accountPasswordExpirePasswordDays":{"type":"object","properties":{"maximumDays":{"type":"string"},"minimumDays":{"type":"string"}},"title":"accountPasswordExpirePasswordDays"},"accountPasswordLockoutDurationMinutes":{"type":"object","properties":{"maximumMinutes":{"type":"string"},"minimumMinutes":{"type":"string"}},"title":"accountPasswordLockoutDurationMinutes"},"accountPasswordLockoutDurationType":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"},"description":"An array of option strings supported by this setting."}},"title":"accountPasswordLockoutDurationType"},"accountPasswordMinimumPasswordAgeDays":{"type":"object","properties":{"maximumAge":{"type":"string"},"minimumAge":{"type":"string"}},"title":"accountPasswordMinimumPasswordAgeDays"},"accountMinimumPasswordLength":{"type":"object","properties":{"maximumLength":{"type":"string","description":"The maximum number of entry characters supported by the custom tab."},"minimumLength":{"type":"string","description":"Minimum length of the access code string."}},"title":"accountMinimumPasswordLength"},"accountPasswordStrengthTypeOption":{"type":"object","properties":{"minimumLength":{"type":"string","description":"Minimum length of the access code string."},"name":{"type":"string"},"passwordIncludeDigit":{"type":"string","description":"When **true,** passwords must include a digit. The default value is `false`."},"passwordIncludeDigitOrSpecialCharacter":{"type":"string","description":"When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."},"passwordIncludeLowerCase":{"type":"string","description":"When **true,** passwords must include a lowercase letter. The default value is `false`."},"passwordIncludeSpecialCharacter":{"type":"string","description":"When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."},"passwordIncludeUpperCase":{"type":"string","description":"When **true,** passwords must include an uppercase letter. The default value is `false`."}},"title":"accountPasswordStrengthTypeOption"},"accountPasswordStrengthType":{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/accountPasswordStrengthTypeOption"},"description":"An array of option strings supported by this setting."}},"title":"accountPasswordStrengthType"},"accountPasswordQuestionsRequired":{"type":"object","properties":{"maximumQuestions":{"type":"string","description":"The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`."},"minimumQuestions":{"type":"string","description":"The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`."}},"description":"Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.","title":"accountPasswordQuestionsRequired"},"accountPasswordRules":{"type":"object","properties":{"expirePassword":{"type":"string","description":"When **true,** passwords expire. The default value is `false`."},"expirePasswordDays":{"type":"string","description":"The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**"},"expirePasswordDaysMetadata":{"$ref":"#/components/schemas/accountPasswordExpirePasswordDays"},"lockoutDurationMinutes":{"type":"string","description":"The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`."},"lockoutDurationMinutesMetadata":{"$ref":"#/components/schemas/accountPasswordLockoutDurationMinutes"},"lockoutDurationType":{"type":"string","description":"The interval associated with the user lockout after a failed login attempt.\n\nPossible values are:\n\n- `minutes` (default)\n- `hours`\n- `days`"},"lockoutDurationTypeMetadata":{"$ref":"#/components/schemas/accountPasswordLockoutDurationType"},"minimumPasswordAgeDays":{"type":"string","description":"The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`."},"minimumPasswordAgeDaysMetadata":{"$ref":"#/components/schemas/accountPasswordMinimumPasswordAgeDays"},"minimumPasswordLength":{"type":"string","description":"The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`."},"minimumPasswordLengthMetadata":{"$ref":"#/components/schemas/accountMinimumPasswordLength"},"passwordIncludeDigit":{"type":"string","description":"When **true,** passwords must include a digit. The default value is `false`."},"passwordIncludeDigitOrSpecialCharacter":{"type":"string","description":"When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."},"passwordIncludeLowerCase":{"type":"string","description":"When **true,** passwords must include a lowercase letter. The default value is `false`."},"passwordIncludeSpecialCharacter":{"type":"string","description":"When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."},"passwordIncludeUpperCase":{"type":"string","description":"When **true,** passwords must include an uppercase letter. The default value is `false`."},"passwordStrengthType":{"type":"string","description":"The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n- `minimumPasswordLength`\n- `minimumPasswordAgeDays`\n- `passwordIncludeDigit`\n- `passwordIncludeDigitOrSpecialCharacter`\n- `passwordIncludeLowerCase`\n- `passwordIncludeSpecialCharacter`\n- `passwordIncludeUpperCase`\n- `questionsRequired`"},"passwordStrengthTypeMetadata":{"$ref":"#/components/schemas/accountPasswordStrengthType"},"questionsRequired":{"type":"string","description":"The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`."},"questionsRequiredMetadata":{"$ref":"#/components/schemas/accountPasswordQuestionsRequired"}},"title":"accountPasswordRules"},"userPasswordRules":{"type":"object","properties":{"passwordRules":{"$ref":"#/components/schemas/accountPasswordRules"},"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."}},"description":"Contains details about the password rules for a user.","title":"userPasswordRules"},"accountManagementGranular":{"type":"object","properties":{"allowManageAccountSecuritySettings":{"type":"string"},"allowManageAccountSecuritySettingsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageAccountSettings":{"type":"string"},"allowManageAccountSettingsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageAdmins":{"type":"string"},"allowManageAdminsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageConnect":{"type":"string"},"allowManageConnectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageDocumentRetention":{"type":"string"},"allowManageDocumentRetentionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageEnvelopeTransfer":{"type":"string"},"allowManageEnvelopeTransferMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageGroupsButNotUsers":{"type":"string"},"allowManageGroupsButNotUsersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageJointAgreements":{"type":"string"},"allowManageJointAgreementsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageReporting":{"type":"string"},"allowManageReportingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageSharing":{"type":"string"},"allowManageSharingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageSigningGroups":{"type":"string"},"allowManageSigningGroupsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageStamps":{"type":"string"},"allowManageStampsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManageUsers":{"type":"string"},"allowManageUsersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowViewAllAdminData":{"type":"string"},"allowViewAllAdminDataMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowViewUsers":{"type":"string"}},"title":"accountManagementGranular"},"accountRoleSettings":{"type":"object","properties":{"accountAgreementsAccessType":{"type":"string"},"accountAgreementsAccessTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"accountManagementGranular":{"$ref":"#/components/schemas/accountManagementGranular"},"allowAccountManagement":{"type":"string","description":"When **true,** users have full administrative access to the account."},"allowAccountManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowApiAccess":{"type":"string","description":"When **true,** users can manage documents by using the API."},"allowApiAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowApiAccessToAccount":{"type":"string","description":"When **true,** users can access the account by using the eSignature API."},"allowApiAccessToAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowApiSendingOnBehalfOfOthers":{"type":"string","description":"When **true,** users can send envelopes on behalf of others."},"allowApiSendingOnBehalfOfOthersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowApiSequentialSigning":{"type":"string","description":"When **true,** users may specify sequential signing recipients when they send documents by using the API."},"allowApiSequentialSigningMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAutoTagging":{"type":"string","description":"When **true,** auto-tagging is enabled for the account."},"allowAutoTaggingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowBulkSending":{"type":"string","description":"When **true,** bulk sending is enabled for users."},"allowBulkSendingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDocuSignDesktopClient":{"type":"string","description":"When **true,** the Docusign Desktop Client is enabled for users."},"allowDocuSignDesktopClientMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedAddressBookAccess":{"type":"string","description":"Specifies the level of access that users have to the account's address book. Valid values are:\n\n- `personal`\n- `useShared`\n- `usePersonalAndShared`\n- `personalAndShared`"},"allowedAddressBookAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedClickwrapsAccess":{"type":"string"},"allowedClickwrapsAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedDocumentTemplateLibraryAccess":{"type":"string"},"allowedDocumentTemplateLibraryAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedOrchestrationAccess":{"type":"string"},"allowedOrchestrationAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedTemplateAccess":{"type":"string","description":"Specifies the level of access that users have to account templates. Valid values are:\n\n- `none`\n- `use`\n- `create`\n- `share`"},"allowedTemplateAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedToBeEnvelopeTransferRecipient":{"type":"string","description":"When **true,** users can be recipients of envelopes transferred to them by administrators of other accounts."},"allowedToBeEnvelopeTransferRecipientMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopeSending":{"type":"string","description":"When **true,** users can send envelopes."},"allowEnvelopeSendingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowESealRecipients":{"type":"string","description":"When **true,** users can add electronic seal ([eSeal](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)) recipients."},"allowESealRecipientsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPowerFormsAdminToAccessAllPowerFormEnvelopes":{"type":"string","description":"When **true,** PowerForm Administrators can access all of the PowerForm envelopes associated with the account."},"allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSendersToSetRecipientEmailLanguage":{"type":"string","description":"When **true,** senders can set the language of the email that is sent to recipients."},"allowSendersToSetRecipientEmailLanguageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSignerAttachments":{"type":"string","description":"When **true,** users can add requests for attachments from signers."},"allowSignerAttachmentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSupplementalDocuments":{"type":"string","description":"When **true,** senders can include supplemental documents."},"allowSupplementalDocumentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowTaggingInSendAndCorrect":{"type":"string","description":"When **true,** the tagger palette is visible during the sending and correct flows and users can add tabs to documents."},"allowTaggingInSendAndCorrectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowTransactions":{"type":"string"},"allowTransactionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowVaulting":{"type":"string","description":"Reserved for Docusign."},"allowVaultingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowWetSigningOverride":{"type":"string","description":"When **true,** users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis."},"allowWetSigningOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canBulkUploadAgreements":{"type":"string"},"canBulkUploadAgreementsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canCreateTransaction":{"type":"string"},"canCreateTransactionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canCreateWorkspaces":{"type":"string","description":"Reserved for Docusign."},"canCreateWorkspacesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canDeleteDocumentsInTransaction":{"type":"string"},"canDeleteDocumentsInTransactionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canDeleteTransaction":{"type":"string"},"canDeleteTransactionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageAgreementDeskRequest":{"type":"string"},"canManageAgreementDeskRequestMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageAgreementDeskRequestSetting":{"type":"string"},"canManageAgreementDeskRequestSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSendEnvelopesViaSMS":{"type":"string"},"canSendEnvelopesViaSMSMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableDocumentUpload":{"type":"string","description":"When **true,** users cannot upload documents."},"disableDocumentUploadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableOtherActions":{"type":"string","description":"When **true,** users can access the **Other Actions** menu."},"disableOtherActionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableApiRequestLogging":{"type":"string","description":"When **true,** API request logging is enabled.\n\n**Note:** Logging limits apply."},"enableApiRequestLoggingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableKeyTermsSuggestionsByDocumentType":{"type":"string"},"enableKeyTermsSuggestionsByDocumentTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableRecipientViewingNotifications":{"type":"string","description":"When **true,** senders are notified when recipients view the documents that they send."},"enableRecipientViewingNotificationsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSequentialSigningInterface":{"type":"string","description":"When **true,** the sequential signing user interface is enabled."},"enableSequentialSigningInterfaceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableTransactionPointIntegration":{"type":"string","description":"Reserved for Docusign."},"enableTransactionPointIntegrationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"playbookAccess":{"type":"string"},"playbookAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"powerFormRole":{"type":"string","description":"The PowerForms rights associated with the account permission profile. Valid values are:\n\n- `none`\n- `user`\n- `admin`"},"powerFormRoleMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"receiveCompletedSelfSignedDocumentsAsEmailLinks":{"type":"string","description":"When **true,** senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments."},"receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signingUiVersionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustAccept":{"type":"string","description":"When **true,** senders can require recipients to accept supplemental documents."},"supplementalDocumentsMustAcceptMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustRead":{"type":"string","description":"When **true,** senders can require recipients to read supplemental documents."},"supplementalDocumentsMustReadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustView":{"type":"string","description":"When **true,** users can require recipients to view supplemental documents."},"supplementalDocumentsMustViewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useNewDocuSignExperienceInterface":{"type":"string","description":"Reserved for Docusign."},"useNewDocuSignExperienceInterfaceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useNewSendingInterface":{"type":"string","description":"Reserved for Docusign."},"useNewSendingInterfaceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"vaultingMode":{"type":"string","description":"Reserved for Docusign."},"vaultingModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"webForms":{"type":"string"},"webFormsMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"description":"This object defines account permissions for users who are associated with the account permission profile. ","title":"accountRoleSettings"},"connectUserObject":{"type":"object","properties":{"configurationtype":{"type":"string","description":"The type of custom Connect configuration being accessed."},"connectId":{"type":"string","description":"The ID of the custom Connect configuration being accessed."},"enabled":{"type":"string","description":"Boolean value that indicates whether the custom Connect configuration is enabled or not."},"hasAccess":{"type":"string"},"senderSearchableItems":{"type":"array","items":{"type":"string"}}},"title":"connectUserObject"},"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.","title":"forgottenPasswordInformation"},"group":{"type":"object","properties":{"accessType":{"type":"string"},"dsGroupId":{"type":"string","description":"Reserved for Docusign."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"groupId":{"type":"string","description":"The Docusign group ID for the group.\nThis is a read-only property."},"groupName":{"type":"string","description":"The name of the group."},"groupType":{"type":"string","description":"The group type."},"isManagedByScim":{"type":"boolean"},"lastModifiedOn":{"type":"string"},"permissionProfileId":{"type":"string","description":"This field is deprecated."},"userGroupType":{"type":"string"},"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](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/)"},"usersCount":{"type":"string","description":"The total number of users in the group."}},"description":"This object contains information about a group.","title":"group"},"addressInformation":{"type":"object","properties":{"address1":{"type":"string","description":"The first line of the user's address.\nMaximum length: 100 characters."},"address2":{"type":"string","description":"The second line of the user's address.\nMaximum length: 100 characters."},"city":{"type":"string","description":"The user's city. Maximum length: 40 characters."},"country":{"type":"string","description":"The user's country. Maximum length: 50 characters."},"fax":{"type":"string","description":"A Fax number associated with the address if one is available."},"phone":{"type":"string","description":"A phone number associated with the address."},"postalCode":{"type":"string","description":"The user's postal code. Maximum length: 20 characters."},"stateOrProvince":{"type":"string","description":"The user's state or province. Maximum length: 40 characters."},"zipPlus4":{"type":"string"}},"description":"Contains address information.","title":"addressInformation"},"userAccountManagementGranularInformation":{"type":"object","properties":{"canManageAccountSecuritySettings":{"type":"string","description":"**True** if the user can manage account security settings."},"canManageAccountSecuritySettingsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageAccountSettings":{"type":"string","description":"**True** if the user can manage account settings."},"canManageAccountSettingsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageAdmins":{"type":"string","description":"**True** if the user can manage administrators."},"canManageAdminsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageConnect":{"type":"string"},"canManageConnectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageDocumentRetention":{"type":"string"},"canManageDocumentRetentionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageEnvelopeTransfer":{"type":"string"},"canManageEnvelopeTransferMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageGroupsButNotUsers":{"type":"string"},"canManageGroupsButNotUsersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageJointAgreements":{"type":"string"},"canManageJointAgreementsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageReporting":{"type":"string","description":"**True** if the user can manage reporting."},"canManageReportingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageSharing":{"type":"string","description":"**True** if the user can manage sharing."},"canManageSharingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageSigningGroups":{"type":"string","description":"**True** if the user can manage signing groups."},"canManageSigningGroupsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageStamps":{"type":"string"},"canManageStampsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageUsers":{"type":"string","description":"**True** if the user can manage users."},"canManageUsersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canViewAllAdminData":{"type":"string"},"canViewAllAdminDataMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canViewUsers":{"type":"string"}},"description":"Describes which account management capabilities a user has.","title":"userAccountManagementGranularInformation"},"localePolicy":{"type":"object","properties":{"addressFormat":{"type":"string","description":"Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`"},"addressFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowRegion":{"type":"string"},"calendarType":{"type":"string","description":"Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`"},"calendarTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"cultureName":{"type":"string","description":"The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code."},"cultureNameMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"currencyCode":{"type":"string","description":"The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code."},"currencyCodeMetadata":{"$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`\n`0`\n- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`\n`($1,234,567.89)`\n- `Minus_CSym_1_Comma_234_Comma_567_Period_89`\n`-$1,234,567.89`\n- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`\n`-$ 1.234.567,89`\n- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`\n`$ -1.234.567,89`\n- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`\n`-1.234.567,89 $`\n- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`\n`(1 234 567,89 $)`\n- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`\n`-1 234 567,89 $`\n- `CSym_Minus_1_Quote_234_Quote_567_Period_89`\n`$-1'234'567.89`\n- `Minus_CSym_1_Period_234_Period_567_Comma_89`\n`-$1.234.567,89`\n- `Minus_CSym_1_Comma_234_Comma_567`\n`-$1,234,567`\n- `Minus_CSym_12_Comma_34_Comma_567_Period_89`\n`-$12,34,567.89`\n- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`\n`($ 1234,567.89)`\n- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`\n`$ -12,34,567.89`\n- `CSym_Minus_12_Comma_34_Comma_567_Period_89`\n`$-1,234,567.89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`\n`$ -1 234 567,89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`\n`$ -1 234 567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`\n`-$ 1 234 567,89`\n- `Minus_1_Space_234_Space_567_Comma_89_CSym`\n`-1 234 567,89$`\n- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`\n`-1 234 567.89 $`\n- `OPar_CSym_1_Period_234_Period_567_CPar`\n`(1.234.567)`\n- `OPar_CSym_1_Comma_234_Comma_567_CPar`\n`($1,234,567)`\n- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`\n`-1,234,567.89 $`\n- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`\n`-$ 1,234,567.89`\n- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`\n`($ 1.234.567,89)`\n- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`\n`($ 1'234'567.89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`\n`($ 1 234 567,89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`\n`($ 1 234 567.89)`\n- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`\n`($12,34,567.89)`\n- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`\n`($ 12,34,567.89)`\n- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`\n`(1,234,567.89 $)`\n- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`\n`(1.234.567,89 $)`\n- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`\n`(1 234 567,89$)`\n- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`\n`(1 234 567.89 $)`\n- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`\n`($ 1,234,567.89)`\n- `Minus_CSym_1_Period_234_Period_567`\n`-$ 1.234.567`\n- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`\n`-$ 1'234'567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`\n`-$ 1 234 567.89`\n- `CSym_Minus_1_Comma_234_Comma_567`\n`$-1,234,567`\n- `CSym_Minus_1_Period_234_Period_567`\n`$-1.234.567`\n- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`\n`$ -1'234'567.89`\n- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`\n`$ -1,234,567.89`\n- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`\n`-$ 12,34,567.89`\n- `Minus_1_Period_234_Period_567_Space_CSym`\n`-123.456.789 $`\n- `CSym_Minus_1_Space_234_Space_567_Comma_89`\n`$-123 456 789,00`\n- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`\n`-123'456'789.00 $`\n- `CSym_1_Comma_234_Comma_567_Period_89_Minus`\n`$123,456,789.00-`\n- `CSym_Minus_1_Period_234_Period_567_Comma_89`\n`$-123.456.789,00`\n- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`\n`($123.456.789,00)`\n- `Minus_CSym_1234_Comma_567_Period_89`\n`-$123456,789.00`\n- `Minus_CSym_1_Space_234_Space_567_Comma_89`\n`-$123 456 789,00`"},"currencyNegativeFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"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- `Default`\n\nUses the current locale.\n- `CSym_1_Comma_234_Comma_567_Period_89`\n`$1,234,567.89`\n- `CSym_Space_1_Period_234_Period_567_Comma_89`\n`$ 1.234.567,89`\n- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`\n`1.234.567,89 $`\n- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`\n`1 234 567,89 $`\n- `CSym_Space_1_Quote_234_Quote_567_Period_89`\n`$ 1'234'567.89`\n- `CSym_1_Comma_234_Comma_567`\n`$1,234,567`\n- `CSym_Space_12_Comma_34_Comma_567_Period_89`\n`$ 12,34,567.89`\n- `CSym_12_Comma_34_Comma_567_Period_89`\n`$12,34,567.89`\n- `CSym_Space_1234_Comma_567_Period_89`\n`$ 1234,567.89`\n- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`\n`1 234 567.89 $`\n- `CSym_Space_1_Space_234_Space_567_Comma_89`\n`$ 1 234 567,89`\n- `CSym_Space_1_Space_234_Space_567_Period_89`\n`$ 1 234 567.89`\n- `Leading_1_Space_234_Space_567_Comma_89_CSym`\n`1 234 567,89$`\n- `CSym_1_Period_234_Period_567`\n`$1.234.567`\n- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`\n`1,234,567. $` (New Armenian)\n- `CSym_Space_1_Comma_234_Comma_567_Period_89`\n`$ 1,234,567.89` (Persian)\n- `CSym_1_Period_234_Period_567_Comma_89`\n`$123.456.789,00` (es-CO)\n- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`\n`123'456'789.00 $` (fr-ch)\n- `CSym_1234_Comma_567_Period_89`\n`$123456,789.00` (es-PR)\n- `Leading_1_Period_234_Period_567_Space_CSym`\n`123.456.789 $`\n- `CSym_1_Space_234_Space_567_Comma_89`\n`$123 456 789,00` (en-ZA, es-CR)"},"currencyPositiveFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"customDateFormat":{"type":"string"},"customSignDateFormat":{"type":"string"},"customSignTimeFormat":{"type":"string"},"customTimeFormat":{"type":"string"},"dateFormat":{"type":"string","description":"Specifies the date format. Valid values:\n\n- `default`\nused the UI's\n- `longformat`\nuse the UI's long format\n- `dd_mm_yy`\ndd-MM-yy\n- `dd_mmm_yy`\ndd-MMM-yy\n- `dd_mm_yyyy`\ndd-MM-yyyy\n- `dd_mmm_yyyy`\ndd-MMM-yyyy\n- `ddmmmmyyyy`\ndd MMMM yyyy\n- `ddmmyyyy`\ndd/MM/yyyy\n- `ddmmyyyy_de`\ndd.MM.yyyy\n- `dmyyyy`\nd/M/yyyy\n- `d_m_yyyy`\nd-M-yyyy\n- `mmmd_yyyy`\nMMM d, yyyy\n- `mmm_dd_yyyy`\nMMM-dd-yyyy\n- `mmmmd_yyyy`\nMMMM d, yyyy\n- `mm_dd_yyyy`\nMM-dd-yyyy\n- `mdyyyy`\nM/d/yyyy\n- `yyyy_mmm_dd`\nyyyy-MMM-dd\n- `yyyy_mm_dd`\nyyyy-MM-dd\n- `yyyymmdd`\nyyyy/MM/dd\n- `yyyymd`\nyyyy/M/d\n- `custom`\nCustomer set own value\n- `mmddyyyy`\nMM/dd/yyyy\n- `mmddyy`\nMM/dd/yy\n- `yyyy_mmmm_d`\nyyyy MMMM d"},"dateFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"effectiveAddressFormat":{"type":"string"},"effectiveCalendarType":{"type":"string"},"effectiveCurrencyCode":{"type":"string"},"effectiveCurrencyNegativeFormat":{"type":"string"},"effectiveCurrencyPositiveFormat":{"type":"string"},"effectiveCustomDateFormat":{"type":"string"},"effectiveCustomTimeFormat":{"type":"string"},"effectiveDateFormat":{"type":"string"},"effectiveInitialFormat":{"type":"string"},"effectiveNameFormat":{"type":"string"},"effectiveTimeFormat":{"type":"string"},"effectiveTimeZone":{"type":"string"},"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- `first1last1`\n\"WG\"\n- `last2`\n\"GA\"\n- `first2`\n\"WI\"\n- `last2_cjk`\nfirst two characters from last name in CJK characters."},"initialFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"nameFormat":{"type":"string","description":"Describes how names are displayed. Valid values:\n\n- `first_middle_last`\nWilliam Henry Gates\n- `full`\nMr William Henry Gates III\n- `last_first`\nGates William\n- `lastfirst`\nGatesWilliam\n- `last_first_cjk`\nGates William only with CJK characters\n- `lastfirst_cjk`\nGatesWilliam only with CJK characters"},"nameFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"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."},"signDateFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"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`"},"signTimeFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timeFormat":{"type":"string","description":"Specifies the time format. Valid values:\n\n- `none`\nNone\n- `hh_mm`\nhh:mm\n- `hhmm`\nHH:mm\n- `hhmmss`\nHH:mm:ss\n- `hhmmsstt`\nHH:mm:ss tt\n- `hhmmtt`\nHH:mm tt\n- `hmm`\nh:mm\n- `hmmss`\nh:mm:ss\n- `hmmsstt`\nh:mm:ss tt\n- `hmmtt`\nh:mm tt\n- `custom`\nCustomer-set format"},"timeFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"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`"},"timeZoneMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"title":"localePolicy"},"sealIdentifier":{"type":"object","properties":{"sealDisplayName":{"type":"string","description":"The user-friendly display name for a seal."},"sealName":{"type":"string","description":"The name of a seal."}},"title":"sealIdentifier"},"senderEmailNotifications":{"type":"object","properties":{"changedSigner":{"type":"string","description":"When **true,** the sender receives an email notification if the signer changes."},"clickwrapResponsesLimitNotificationEmail":{"type":"string"},"commentsOnlyPrivateAndMention":{"type":"string","description":"When **true,** the user receives only comments that mention their own user name."},"commentsReceiveAll":{"type":"string","description":"When **true,** the user receives all comments."},"deliveryFailed":{"type":"string","description":"When **true,** the sender receives an email notification if envelope delivery fails."},"envelopeComplete":{"type":"string","description":"When **true,** the user receives an email notification when the envelope has been completed."},"offlineSigningFailed":{"type":"string","description":"When **true,** the user receives an email notification if offline signing failed."},"powerformResponsesLimitNotificationEmail":{"type":"string"},"purgeDocuments":{"type":"string","description":"When **true,** the user receives an email notification when a document purge occurs."},"recipientViewed":{"type":"string","description":"When **true,** the sender receives notification that a recipient viewed the envelope."},"senderEnvelopeDeclined":{"type":"string","description":"When **true,** the sender receives notification that the envelope was declined."},"withdrawnConsent":{"type":"string","description":"When **true,** the user receives an email notification if consent is withdrawn."}},"description":"Contains the settings for the email notifications that senders receive about the envelopes that they send.","title":"senderEmailNotifications"},"signerEmailNotifications":{"type":"object","properties":{"agentNotification":{"type":"string","description":"When **true,** the user receives agent notification emails."},"carbonCopyNotification":{"type":"string","description":"When **true,** the user receives notifications of carbon copy deliveries."},"certifiedDeliveryNotification":{"type":"string","description":"When **true,** the user receives notifications of certified deliveries."},"commentsOnlyPrivateAndMention":{"type":"string","description":"When **true,** the user receives only comments that mention their own user name."},"commentsReceiveAll":{"type":"string","description":"When **true,** the user receives all comments."},"documentMarkupActivation":{"type":"string","description":"When **true,** the user receives notification that document markup has been activated."},"envelopeActivation":{"type":"string","description":"When **true,** the user receives notification that the envelope has been activated."},"envelopeComplete":{"type":"string","description":"When **true,** the user receives an email notification when the envelope has been completed."},"envelopeCorrected":{"type":"string","description":"When **true,** the user receives notification that the envelope has been corrected."},"envelopeDeclined":{"type":"string","description":"When **true,** the user receives notification that the envelope has been declined."},"envelopeVoided":{"type":"string","description":"When **true,** the user receives notification that the envelope has been voided."},"faxReceived":{"type":"string","description":"Reserved for Docusign."},"offlineSigningFailed":{"type":"string","description":"When **true,** the user receives an email notification if offline signing failed."},"purgeDocuments":{"type":"string","description":"When **true,** the user receives an email notification when a document purge occurs."},"reassignedSigner":{"type":"string","description":"When **true,** the user receives notification that the envelope has been reassigned."},"whenSigningGroupMember":{"type":"string","description":"When **true,** the user receives notification that he or she is a member of the signing group."}},"description":"An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created.","title":"signerEmailNotifications"},"userSettingsInformation":{"type":"object","properties":{"accountAgreementsAccessType":{"type":"string","description":"Reserved for Docusign."},"accountAgreementsAccessTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"accountManagementGranular":{"$ref":"#/components/schemas/userAccountManagementGranularInformation"},"adminOnly":{"type":"string","description":"Reserved for Docusign."},"adminOnlyMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAccessToAllAccountAgreements":{"type":"string"},"allowAccessToAllAccountAgreementsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAutoTagging":{"type":"string","description":"When **true,** the API returns suggested tabs for documents for this user."},"allowedDocumentTemplateLibraryAccess":{"type":"string"},"allowedDocumentTemplateLibraryAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowedOrchestrationAccess":{"type":"string"},"allowedOrchestrationAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopeTransferTo":{"type":"string","description":"When **true,** this user can participate in envelope transfers on the account."},"allowEnvelopeTransferToMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEsealRecipients":{"type":"string","description":"When **true,** this user can create [electronic seal recipients](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient)."},"allowEsealRecipientsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPowerFormsAdminToAccessAllPowerFormEnvelope":{"type":"string","description":"When **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**"},"allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowRecipientLanguageSelection":{"type":"string","description":"When **true,** this user can set the language used in the standard email format for a recipient when creating an envelope."},"allowRecipientLanguageSelectionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSendOnBehalfOf":{"type":"string","description":"When **true,** this user can send envelopes \"on behalf of\" other users through the API."},"allowSendOnBehalfOfMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSupplementalDocuments":{"type":"string","description":"When **true,** this user can include supplemental documents."},"allowSupplementalDocumentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowTransactions":{"type":"string"},"allowTransactionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"anchorTagVersionedPlacementEnabled":{"type":"string","description":"Reserved for Docusign."},"apiAccountWideAccess":{"type":"string","description":"When **true,** indicates that this user can send envelope-specific API requests on the account."},"apiAccountWideAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"apiCanExportAC":{"type":"string","description":"When **true,** this user can export authoritative copy for the account."},"apiCanExportACMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"bulkSend":{"type":"string","description":"When **true,** this user can use the bulk send feature for the account."},"bulkSendMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canBulkUploadAgreements":{"type":"string","description":"Reserved for Docusign."},"canBulkUploadAgreementsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canChargeAccount":{"type":"string","description":"Reserved for Docusign."},"canChargeAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canCreateTransaction":{"type":"string"},"canCreateTransactionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canDeleteDocumentsInTransaction":{"type":"string"},"canDeleteDocumentsInTransactionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canDeleteTransaction":{"type":"string"},"canDeleteTransactionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canEditSharedAddressbook":{"type":"string","description":"When true, this user can edit the shared address book for the account."},"canEditSharedAddressbookMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canLockEnvelopes":{"type":"string","description":"Reserved for Docusign."},"canLockEnvelopesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageAccount":{"type":"string","description":"When **true,** this user is an administrator for the account."},"canManageAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageAgreementParties":{"type":"string"},"canManageAgreementPartiesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageDistributor":{"type":"string","description":"Reserved for Docusign."},"canManageDistributorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canManageTemplates":{"type":"string","description":"When **true,** this user can manage templates for the account."},"canManageTemplatesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSendAPIRequests":{"type":"string","description":"When **true,** this user can send API requests on the account."},"canSendAPIRequestsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSendEnvelope":{"type":"string","description":"When **true,** this user can send envelopes on the account."},"canSendEnvelopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSendEnvelopesViaSMS":{"type":"string"},"canSendEnvelopesViaSMSMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSignEnvelope":{"type":"string","description":"When **true,** this user can sign envelopes."},"canSignEnvelopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canUseScratchpad":{"type":"string","description":"When **true,** this user can use a scratchpad to edit information."},"canUseScratchpadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canUseSmartContracts":{"type":"string","description":"Reserved for Docusign."},"canUseSmartContractsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableDocumentUpload":{"type":"string","description":"When **true,** this user is prohibited from uploading documents during sending."},"disableDocumentUploadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableOtherActions":{"type":"string","description":"When **true,** this user can access the **Other Actions** menu."},"disableOtherActionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSPro":{"type":"string","description":"Reserved for Docusign."},"enableDSProMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableKeyTermsSuggestionsByDocumentType":{"type":"string"},"enableKeyTermsSuggestionsByDocumentTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSequentialSigningAPI":{"type":"string","description":"When **true,** the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note:** Only SysAdmin users can change this setting."},"enableSequentialSigningAPIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSequentialSigningUI":{"type":"string","description":"When **true,** the account can define the routing order\nof recipients for envelopes sent by using the Docusign application.\n\n**Note:** Only SysAdmin users can change this setting."},"enableSequentialSigningUIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSignerAttachments":{"type":"string","description":"When **true,** this user can use the signing attachments feature."},"enableSignerAttachmentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSignOnPaperOverride":{"type":"string","description":"When **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note:** Only Admin users can change this setting."},"enableSignOnPaperOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableTransactionPoint":{"type":"string","description":"Reserved for Docusign."},"enableTransactionPointMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableVaulting":{"type":"string","description":"When **true,** Vaulting is enabled for the account."},"enableVaultingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"expressSendOnly":{"type":"string","description":"When **false,** this user can apply tabs to documents during the sending experience."},"isManagedByScim":{"type":"string"},"isManagedByScimMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"isMembershipManagedByScim":{"type":"string"},"isMembershipManagedByScimMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"isMembershipRedacted":{"type":"string"},"isMembershipRedactedMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"isUserRedacted":{"type":"string"},"isUserRedactedMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"locale":{"type":"string","description":"The user's locale code. Valid values are:\n\n- `zh_CN`\n- `zh_TW`\n- `nl`\n- `en`\n- `fr`\n- `de`\n- `it`\n- `ja`\n- `ko`\n- `pt`\n- `pt_BR`\n- `ru`\n- `es`"},"localeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicy"},"manageClickwrapsMode":{"type":"string","description":"When **true,** this user can create and manage [Clickwraps](/docs/click-api/)."},"manageClickwrapsModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"modifiedBy":{"type":"string","description":"The user ID (GUID) of the user who last modified this user record. This property is read-only."},"modifiedByMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"modifiedDate":{"type":"string","description":"The date on which this user record was last modified."},"modifiedDateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"modifiedPage":{"type":"string","description":"Note referencing the page that modified this user record."},"modifiedPageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"newSendUI":{"type":"string","description":"Reserved for Docusign."},"newSendUIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"powerFormMode":{"type":"string","description":"Indicates the Power Form mode setting for the user:\n\n- `none`\n- `admin`\n- `user`"},"powerFormModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"recipientViewedNotification":{"type":"string","description":"When **true,** this user receives notifications when envelopes are viewed."},"recipientViewedNotificationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"redactAtMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"redactMembershipAt":{"type":"string"},"sealIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/sealIdentifier"},"description":"Information about the seals associated with this user."},"selfSignedRecipientEmailDocument":{"type":"string","description":"Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\nin the email.\n\n**Note:** Only Admin users can change this setting."},"selfSignedRecipientEmailDocumentMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"senderEmailNotifications":{"$ref":"#/components/schemas/senderEmailNotifications"},"signerEmailNotifications":{"$ref":"#/components/schemas/signerEmailNotifications"},"supplementalDocumentIncludeInDownload":{"type":"string","description":"When **true,** this user gets supplemental documents when downloading documents."},"supplementalDocumentsMustAccept":{"type":"string","description":"When **true,** this user must accept supplemental documents."},"supplementalDocumentsMustAcceptMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustRead":{"type":"string","description":"When **true,** this user must both view and accept supplemental documents."},"supplementalDocumentsMustReadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustView":{"type":"string","description":"When **true,** this user must view supplemental documents."},"supplementalDocumentsMustViewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"templateActiveCreation":{"type":"string","description":"When **true,** a new template is created each time the user sends an envelope."},"templateActiveCreationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"templateApplyNotify":{"type":"string","description":"When **true,** the system notifies this user before applying a matching template."},"templateApplyNotifyMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"templateAutoMatching":{"type":"string","description":"When **true,** the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from."},"templateAutoMatchingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"templateMatchingSensitivity":{"type":"string","description":"Percentage used when matching templates."},"templateMatchingSensitivityMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"templatePageLevelMatching":{"type":"string","description":"When **true,** users see template matching functionality."},"templatePageLevelMatchingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timezoneDST":{"type":"string","description":"When true, daylight savings time is in effect for this user's time zone."},"timezoneDSTMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timezoneMask":{"type":"string","description":"The custom DateTime format setting for this user."},"timezoneMaskMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timezoneOffset":{"type":"string","description":"The timezone offset for the user. Valid values:\n\n- `tz_01_afghanistan`\n- `tz_02_alaskan`\n- `tz_03_arab`\n- `tz_04_arabian`\n- `tz_05_arabic`\n- `tz_06_argentina`\n- `tz_07_atlantic`\n- `tz_08_aus_central`\n- `tz_09_aus_eastern`\n- `tz_10_azerbaijan`\n- `tz_11_azores`\n- `tz_12_bangladesh`\n- `tz_13_canada_central`\n- `tz_14_cape_verde`\n- `tz_15_caucasus`\n- `tz_16_central_australia`\n- `tz_17_central_america`\n- `tz_18_central_asia`\n- `tz_19_central_brazilian`\n- `tz_20_central_europe`\n- `tz_21_central_european`\n- `tz_22_central_pacific`\n- `tz_23_central`\n- `tz_24_central_mexico`\n- `tz_25_china`\n- `tz_26_dateline`\n- `tz_27_east_africa`\n- `tz_28_east_australia`\n- `tz_29_east_europe`\n- `tz_30_east_south_america`\n- `tz_31_eastern`\n- `tz_32_egypt`\n- `tz_33_ekaterinburg`\n- `tz_34_fiji`\n- `tz_35_fli`\n- `tz_36_georgian`\n- `tz_37_gmt`\n- `tz_38_greenland`\n- `tz_39_greenwich`\n- `tz_40_gtb`\n- `tz_41_hawaiian`\n- `tz_42_india`\n- `tz_43_iran`\n- `tz_44_israel`\n- `tz_45_jordan`\n- `tz_46_kaliningrad`\n- `tz_47_kamchatka`\n- `tz_48_korea`\n- `tz_49_magadan`\n- `tz_50_mauritius`\n- `tz_51_mid_atlantic`\n- `tz_52_middle_east`\n- `tz_53_montevideo`\n- `tz_54_morocco`\n- `tz_55_mountain`\n- `tz_56_mountain_mexico`\n- `tz_57_myanmar`\n- `tz_58_north_central_asia`\n- `tz_59_namibia`\n- `tz_60_nepal`\n- `tz_61_new_zealand`\n- `tz_62_new_foundland`\n- `tz_63_north_asia_east`\n- `tz_64_north_asia`\n- `tz_65_pacific_sa`\n- `tz_66_pacific`\n- `tz_67_pacific_mexico`\n- `tz_68_pakistan`\n- `tz_69_paraguay`\n- `tz_70_romance`\n- `tz_71_russian`\n- `tz_72_sa_eastern`\n- `tz_73_sa_pacific`\n- `tz_74_sa_western`\n- `tz_75_samoa`\n- `tz_76_se_asia`\n- `tz_77_singapore`\n- `tz_78_south_africa`\n- `tz_79_sriLanka`\n- `tz_80_syria`\n- `tz_81_taipei`\n- `tz_82_tasmania`\n- `tz_83_tokyo`\n- `tz_84_tonga`\n- `tz_85_turkey`\n- `tz_86_ulaanbaatar`\n- `tz_87_us_eastern`\n- `tz_88_us_mountain`\n- `tz_89_venezuela`\n- `tz_90_vladivostok`\n- `tz_91_west_australia`\n- `tz_92_west_central_africa`\n- `tz_93_west_europe`\n- `tz_94_west_asia`\n- `tz_95_west_pacific`\n- `tz_96_yakutsk`"},"timezoneOffsetMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timezoneSendingPref":{"type":"string","description":"Reserved for Docusign."},"timezoneSendingPrefMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timezoneSigningPref":{"type":"string","description":"Reserved for Docusign."},"timezoneSigningPrefMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"transactionPointSiteNameURL":{"type":"string","description":"Reserved for Docusign."},"transactionPointSiteNameURLMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"transactionPointUserName":{"type":"string","description":"Reserved for Docusign."},"transactionPointUserNameMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"vaultingMode":{"type":"string","description":"Indicates the specified Vaulting mode:\n\n- `none`\n- `estored`\n- `electronic_original`"},"vaultingModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"webForms":{"type":"string"},"webFormsMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"description":"Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)","title":"userSettingsInformation"},"userInformation":{"type":"object","properties":{"activationAccessCode":{"type":"string","description":"Access code provided to the user to activate the account."},"company":{"type":"string","description":"The name of the user's company."},"connectConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/connectUserObject"},"description":"Object representing the user's custom Connect configuration."},"countryCode":{"type":"string","description":"The two-letter code for the user's country."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"customSettings":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"The name/value pair information for the user custom setting."},"defaultAccountId":{"type":"string","description":"The default account ID associated with the user."},"email":{"type":"string","description":"The user's email address.\n\nThis property cannot be updated via `PUT` requests."},"enableConnectForUser":{"type":"string","description":"Boolean value that specifies whether the user is enabled for updates from Docusign Connect."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"firstName":{"type":"string","description":"The user's first name. \nMaximum Length: 50 characters."},"forgottenPasswordInfo":{"$ref":"#/components/schemas/forgottenPasswordInformation"},"groupList":{"type":"array","items":{"$ref":"#/components/schemas/group"},"description":"A list of the group information for groups to add the user to.\nUse [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required."},"hasRemoteNotary":{"type":"boolean"},"homeAddress":{"$ref":"#/components/schemas/addressInformation"},"initialsImageUri":{"type":"string","description":"The URI for retrieving the image of the user's initials."},"isAdmin":{"type":"string","description":"When **true,** the user is an administrator."},"isAlternateAdmin":{"type":"string","description":"When **true,** the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed."},"isManagedByScim":{"type":"string"},"isMembershipManagedByScim":{"type":"string"},"isNAREnabled":{"type":"string","description":"When **true,** National Association of Realtors (NAR) signature logos are enabled for the user."},"jobTitle":{"type":"string","description":"The user's job title."},"lastLogin":{"type":"string","description":"This property has been deprecated."},"lastName":{"type":"string","description":"The user's last name. \nMaximum Length: 50 characters."},"licenseStatus":{"type":"string","description":"If successful this value will be \"Assigned\"\nIf there was an error, this value will be \"Failed. Please try again later.\""},"licenseType":{"type":"string","description":"The user’s assigned license type. Only available for IAM plans. Must be one of the following values:\n\n- `Full - Enterprise`: Full license type available for customers who purchase the IAM Enterprise plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.\n- `Full - Professional`: Full license type available for customers who purchase the IAM Professional plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.\n- `Full - Standard`: Full license type available for customers who purchase the IAM Standard plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.\n- `Full - Sales`: Full license type available for customers who purchase the IAM Sales plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder.\n- `Full - CX`: Full license type available for customers who purchase the IAM Sales plan; includes access to sending envelopes and Workflow Builder.\n- `Free`: Free license type available for all IAM customers; includes access to viewing the user’s own agreements and signing."},"licenseTypes":{"type":"array","items":{"type":"string"}},"loginStatus":{"type":"string","description":"Boolean value that indicates whether the user is currently logged in or not."},"middleName":{"type":"string","description":"The user's middle name.\nLimit: 50 characters."},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"passwordExpiration":{"type":"string","description":"If password expiration is enabled, the date-time when the user's password expires."},"permissionProfileId":{"type":"string","description":"The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page."},"permissionProfileName":{"type":"string","description":"The name of the account permission profile.\n\nExample: `Account Administrator`"},"profileImageUri":{"type":"string","description":"The URL for retrieving the user's profile image."},"sendActivationEmail":{"type":"string","description":"This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).\n\nYou can also use this field to resend the activation email to a user who is not yet active by setting this field to the `\"send\"`."},"sendActivationOnInvalidLogin":{"type":"string","description":"When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated."},"signatureImageUri":{"type":"string","description":"An endpoint URI that you can use to retrieve the user's signature image."},"subscribe":{"type":"string"},"suffixName":{"type":"string","description":"The suffix for the user's name, such as Jr, IV, PhD, etc.\n\nLimit: 50 characters."},"title":{"type":"string","description":"The title of the user."},"uri":{"type":"string","description":"A URI containing the user ID."},"userAddedToAccountDateTime":{"type":"string","description":"The date and time that the user was added to the account."},"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."},"userName":{"type":"string","description":"The name of the user."},"userProfileLastModifiedDate":{"type":"string","description":"The date and time that the user's profile was last modified."},"userSettings":{"$ref":"#/components/schemas/userSettingsInformation"},"userStatus":{"type":"string","description":"Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`"},"userType":{"type":"string","description":"The type of user, for example `CompanyUser`."},"workAddress":{"$ref":"#/components/schemas/addressInformation"}},"description":"User information.","title":"userInformation"},"permissionProfile":{"type":"object","properties":{"modifiedByUsername":{"type":"string","description":"The username of the user who last modified the permission profile."},"modifiedDateTime":{"type":"string","description":"The date and time when the permission profile was last modified."},"permissionProfileId":{"type":"string","description":"The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page."},"permissionProfileName":{"type":"string","description":"The name of the account permission profile.\n\nExample: `Account Administrator`"},"settings":{"$ref":"#/components/schemas/accountRoleSettings"},"userCount":{"type":"string","description":"The total number of users in the group associated with the account permission profile."},"users":{"type":"array","items":{"$ref":"#/components/schemas/userInformation"},"description":"A list of user objects containing information about the users who are associated with the account permission profile."}},"description":"This object defines the account permissions for a profile that you can apply to a group of users.","title":"permissionProfile"},"Accounts_PermissionProfiles_DeletePermissionProfiles_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_PermissionProfiles_DeletePermissionProfiles_Response_200"},"permissionProfileInformation":{"type":"object","properties":{"permissionProfiles":{"type":"array","items":{"$ref":"#/components/schemas/permissionProfile"},"description":"A complex type containing a collection of permission profiles."}},"description":"Contains details about the permission profiles associated with an account.","title":"permissionProfileInformation"},"accessCodeFormat":{"type":"object","properties":{"formatRequired":{"type":"string","description":"Boolean specifying whether this format configuration is required."},"formatRequiredMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"letterRequired":{"type":"string","description":"Boolean specifying whether alphabetical characters are required in the access code string."},"letterRequiredMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"minimumLength":{"type":"string","description":"Minimum length of the access code string."},"minimumLengthMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"numberRequired":{"type":"string","description":"Boolean specifying whether numerical characters (0-9) are required in the access code string."},"numberRequiredMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"specialCharacterRequired":{"type":"string","description":"Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '&lt;', '>', '&', or '#'."},"specialCharacterRequiredMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"description":"Object specifying the format of the string provided to a recipient in order to access an envelope.","title":"accessCodeFormat"},"expirations":{"type":"object","properties":{"expireAfter":{"type":"string","description":"An integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**"},"expireEnabled":{"type":"string","description":"When **true,** the envelope expires in the number of days set by `expireAfter`. When **false** or not set, the envelope expires in the number of days specified by the [default expiration account setting](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html). If you have not modified these settings, envelopes will expire after 120 days by default."},"expireWarn":{"type":"string","description":"An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent."}},"description":"A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided.","title":"expirations"},"reminders":{"type":"object","properties":{"maximumReminderCount":{"type":"string"},"reminderDelay":{"type":"string","description":"An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0."},"reminderEnabled":{"type":"string","description":"When **true,** reminders are enabled. The default value is **false.**"},"reminderFrequency":{"type":"string","description":"An integer specifying the interval in days between reminder emails. The default value is 0."},"smartReminderEnabled":{"type":"string"}},"description":"A complex element that specifies reminder settings for the envelope","title":"reminders"},"accountNotification":{"type":"object","properties":{"expirations":{"$ref":"#/components/schemas/expirations"},"reminders":{"$ref":"#/components/schemas/reminders"},"userOverrideEnabled":{"type":"string","description":"When **true,** the user can override envelope expirations."}},"description":"A complex element that specifies notifications (expirations and reminders) for the envelope.","title":"accountNotification"},"adminMessage":{"type":"object","properties":{"baseMessage":{"type":"string"},"moreInformation":{"type":"string"}},"title":"adminMessage"},"askAnAdmin":{"type":"object","properties":{"email":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}},"title":"askAnAdmin"},"accountUISettings":{"type":"object","properties":{"adminMessage":{"$ref":"#/components/schemas/adminMessage"},"allowUsersToEditSharedAccess":{"type":"string"},"allowUsersToEditSharedAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"askAnAdmin":{"$ref":"#/components/schemas/askAnAdmin"},"clickwrapSchemaVersion":{"type":"string"},"clickwrapSchemaVersionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableWebAppAccess":{"type":"string"},"disableWebAppAccessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdminMessage":{"type":"string"},"enableAdminMessageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEasySignCanUseMultiTemplateApply":{"type":"string"},"enableEasySignCanUseMultiTemplateApplyMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEasySignTemplateUpload":{"type":"string"},"enableEasySignTemplateUploadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEnvelopeCopyWithData":{"type":"string"},"enableEnvelopeCopyWithDataMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEnvelopeTypes":{"type":"string"},"enableEnvelopeTypesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableLegacySendflowLink":{"type":"string"},"enableLegacySendflowLinkMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"hasExternalLinkedAccounts":{"type":"string"},"hasExternalLinkedAccountsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"hideSendAnEnvelope":{"type":"string"},"hideSendAnEnvelopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"hideUseATemplate":{"type":"string","description":"When **true,** the **Templates** menu is hidden from account users who are not Admins. The default value is **false.**"},"hideUseATemplateInPrepare":{"type":"string"},"hideUseATemplateInPrepareMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"hideUseATemplateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"orderBasedRecipientIdGeneration":{"type":"string"},"orderBasedRecipientIdGenerationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"removeEnvelopeForwarding":{"type":"string"},"removeEnvelopeForwardingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"shouldRedactAccessCode":{"type":"string"},"shouldRedactAccessCodeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"uploadNewImageToSignOrInitial":{"type":"string"},"uploadNewImageToSignOrInitialMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"description":"An object that defines the options that are available to non-administrators in the UI.","title":"accountUISettings"},"additionalSetting":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/settingsMetadata"},"name":{"type":"string"},"value":{"type":"string","description":"Specifies the value of the tab. "}},"title":"additionalSetting"},"externalDocumentSources":{"type":"object","properties":{"boxnetEnabled":{"type":"string","description":"The account is enabled to allow external documents to be attached from BoxNet."},"boxnetMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"dropboxEnabled":{"type":"string","description":"The account is enabled to allow external documents to be attached from DropBox."},"dropboxMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"googleDriveEnabled":{"type":"string","description":"The account is enabled to allow external documents to be attached from Google Drive."},"googleDriveMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"oneDriveEnabled":{"type":"string","description":"The account is enabled to allow external documents to be attached from OneDrive."},"oneDriveMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"salesforceEnabled":{"type":"string","description":"The account is enabled to allow external documents to be attached from Salesforce."},"salesforceMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"description":"A complex object specifying the external document sources.","title":"externalDocumentSources"},"idCheckSecurityStep":{"type":"object","properties":{"authType":{"type":"string","description":"Type of authorization used for the security check."}},"title":"idCheckSecurityStep"},"idCheckConfiguration":{"type":"object","properties":{"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."},"name":{"type":"string","description":"The name of the signature."}},"description":"A complex object specifying ID check configuration.","title":"idCheckConfiguration"},"accountIdentityInputOption":{"type":"object","properties":{"isRequired":{"type":"boolean"},"optionName":{"type":"string"},"valueType":{"type":"string"}},"title":"accountIdentityInputOption"},"accountSignatureProviderOption":{"type":"object","properties":{"signatureProviderOptionDisplayName":{"type":"string","description":"Reserved for Docusign."},"signatureProviderOptionHintOverrideValue":{"type":"string"},"signatureProviderOptionId":{"type":"string","description":"Reserved for Docusign."},"signatureProviderOptionName":{"type":"string","description":"Reserved for Docusign."},"signatureProviderOptionRegexValidationPattern":{"type":"string"}},"description":"Reserved for DocuSign.","title":"accountSignatureProviderOption"},"signatureProviderRequiredOption":{"type":"object","properties":{"requiredSignatureProviderOptionIds":{"type":"array","items":{"type":"string"},"description":"Reserved for Docusign."},"signerType":{"type":"string","description":"Reserved for Docusign."}},"description":"Contains additional information that a specific signature provider requires.","title":"signatureProviderRequiredOption"},"accountSignatureProvider":{"type":"object","properties":{"isRequired":{"type":"string","description":"Reserved for Docusign."},"priority":{"type":"string","description":"Reserved for Docusign."},"signatureProviderDisplayName":{"type":"string","description":"Reserved for Docusign."},"signatureProviderId":{"type":"string","description":"Reserved for Docusign."},"signatureProviderName":{"type":"string","description":"The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method.\n\nExample: `universalsignaturepen_default`"},"signatureProviderOptionsMetadata":{"type":"array","items":{"$ref":"#/components/schemas/accountSignatureProviderOption"},"description":"Reserved for Docusign."},"signatureProviderRequiredOptions":{"type":"array","items":{"$ref":"#/components/schemas/signatureProviderRequiredOption"},"description":"Reserved for Docusign."}},"description":"Contains information about the signature provider associated with the Identity Verification workflow.\nIf empty, then this specific workflow is not intended for signers.","title":"accountSignatureProvider"},"accountIdentityVerificationStep":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"description":"Information about a specific step in an Identity Verification workflow.","title":"accountIdentityVerificationStep"},"accountIdentityVerificationWorkflow":{"type":"object","properties":{"defaultDescription":{"type":"string","description":"Text describing the purpose of the Identity Verification workflow."},"defaultName":{"type":"string","description":"The name of the Identity Verification workflow."},"displayOrder":{"type":"string","format":"int32"},"inputOptions":{"type":"array","items":{"$ref":"#/components/schemas/accountIdentityInputOption"}},"isDisabled":{"type":"string","description":"When **true,** the workflow is disabled."},"ownerType":{"type":"string"},"signatureProvider":{"$ref":"#/components/schemas/accountSignatureProvider"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/accountIdentityVerificationStep"}},"workflowId":{"type":"string","description":"Workflow unique IDThis is the ID you must specify when setting ID Verification in an envelope using the `identityVerification` [core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters)"},"workflowLabel":{"type":"string"},"workflowResourceKey":{"type":"string","description":"Reserved for Docusign."}},"description":"Specifies an Identity Verification workflow.","title":"accountIdentityVerificationWorkflow"},"externalPrimaryAccountRecipientAuthRequirements":{"type":"object","properties":{"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"},"kba":{"type":"string"},"phone":{"type":"string"}},"title":"externalPrimaryAccountRecipientAuthRequirements"},"linkedExternalPrimaryAccount":{"type":"object","properties":{"accountName":{"type":"string","description":"The name on the account."},"configurationId":{"type":"string"},"email":{"type":"string"},"exemptMembersOfSameAccountFromAuth":{"type":"string"},"linkId":{"type":"string"},"pdfFieldHandlingOption":{"type":"string"},"pdfFieldHandlingPrefillTabPermission":{"type":"string"},"pdfFieldHandlingStandardInputTabPermission":{"type":"string"},"pdfFieldHandlingStandardTabPermission":{"type":"string"},"recipientAuthRequirements":{"$ref":"#/components/schemas/externalPrimaryAccountRecipientAuthRequirements"},"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."}},"title":"linkedExternalPrimaryAccount"},"tabAccountSettings":{"type":"object","properties":{"allowTabOrder":{"type":"string","description":"When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting."},"allowTabOrderMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"approveDeclineTabsEnabled":{"type":"string","description":"When **true,** approve and decline tabs are enabled."},"approveDeclineTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"calculatedFieldsEnabled":{"type":"string","description":"When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs."},"calculatedFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"checkboxTabsEnabled":{"type":"string","description":"When **true,** checkbox tabs are enabled."},"checkBoxTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"dataFieldRegexEnabled":{"type":"string","description":"When **true,** regular expressions are enabled for tabs that contain data fields."},"dataFieldRegexMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"dataFieldSizeEnabled":{"type":"string","description":"When **true,** setting character limits for input fields is enabled."},"dataFieldSizeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"drawTabsEnabled":{"type":"string"},"drawTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableTabAgreementDetails":{"type":"string"},"enableTabAgreementDetailsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"firstLastEmailTabsEnabled":{"type":"string","description":"Reserved for Docusign."},"firstLastEmailTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"listTabsEnabled":{"type":"string","description":"When **true,** list tabs are enabled."},"listTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"noteTabsEnabled":{"type":"string","description":"When **true,** note tabs are enabled."},"noteTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"numericalTabsEnabled":{"type":"string"},"numericalTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"prefillTabsEnabled":{"type":"string"},"prefillTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"radioTabsEnabled":{"type":"string","description":"When **true,** radio button tabs are enabled."},"radioTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"savingCustomTabsEnabled":{"type":"string","description":"When **true,** saving custom tabs is enabled."},"savingCustomTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"senderToChangeTabAssignmentsEnabled":{"type":"string","description":"Reserved for Docusign."},"senderToChangeTabAssignmentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sharedCustomTabsEnabled":{"type":"string","description":"When **true,** shared custom tabs are enabled."},"sharedCustomTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"tabDataLabelEnabled":{"type":"string","description":"When **true,** [data labels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting."},"tabDataLabelMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"tabLocationEnabled":{"type":"string","description":"Reserved for Docusign."},"tabLocationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"tabLockingEnabled":{"type":"string","description":"When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting."},"tabLockingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"tabScaleEnabled":{"type":"string","description":"Reserved for Docusign."},"tabScaleMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"tabTextFormattingEnabled":{"type":"string","description":"When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** This property is read-only and cannot be used to be update the account settings"},"tabTextFormattingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"textTabsEnabled":{"type":"string","description":"When **true,** text tabs are enabled."},"textTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"uriTabsEnabled":{"type":"string"},"uriTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"title":"tabAccountSettings"},"accountSettingsInformation":{"type":"object","properties":{"accessCodeFormat":{"$ref":"#/components/schemas/accessCodeFormat"},"accountDateTimeFormat":{"type":"string","description":"UTC date/time format for the account."},"accountDateTimeFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"accountDefaultLanguage":{"type":"string","description":"The default language used for the Docusign web application, settings, and organization application. The supported languages are:\n\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Dutch (`nl`)\n- English (`en`)\n- French (`fr`)\n- German (`de`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Polish (`pl`)\n- Brazilian Portuguese (`pt_BR`)\n- Portuguese (`pt`)\n- Russian (`ru`)\n- Spanish (`es`)"},"accountDefaultLanguageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"accountName":{"type":"string","description":"The name on the account."},"accountNameMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"accountNotification":{"$ref":"#/components/schemas/accountNotification"},"accountUISettings":{"$ref":"#/components/schemas/accountUISettings"},"additionalSettings":{"type":"array","items":{"$ref":"#/components/schemas/additionalSetting"}},"adoptSigConfig":{"type":"string","description":"When **true,** [Signature Adoption Configuration](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=dsz1583277358168.html) is enabled.\n\n**Note:** Only Admin users can change this setting."},"adoptSigConfigMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"advancedCorrect":{"type":"string","description":"When **true,** the Advanced Correction feature is enabled for this account."},"advancedCorrectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"advancedSearchEnableTabField":{"type":"string"},"advancedSearchEnableTabFieldMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"advancedSearchEnableTemplateIdField":{"type":"string"},"advancedSearchEnableTemplateIdFieldMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"advancedSearchEnableTemplateNameField":{"type":"string"},"advancedSearchEnableTemplateNameFieldMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"aiAssistedWebFormCreationLevel":{"type":"string"},"aiAssistedWebFormCreationLevelMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAccessCodeFormat":{"type":"string","description":"When **true,** the configured [Access Code Format](/docs/esign-rest-api/reference/accounts/accounts/get/#accessCodeFormat) page is enabled for account administrators.\n\n**Note:** Only Admin users can change this setting."},"allowAccessCodeFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAccountManagementGranular":{"type":"string","description":"When **true,** the account can be managed on a per-user basis.\n\n**Note:** Only Admin users can change this setting."},"allowAccountManagementGranularMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAccountMemberNameChange":{"type":"string","description":"Boolean that specifies whether member names can be changed in the account."},"allowAccountMemberNameChangeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowACE":{"type":"string"},"allowACEMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAdvancedRecipientRoutingConditional":{"type":"string","description":"When **true,** [Conditional Routing](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=aqm1578456487908.html) is enabled for the account as part of Docusign's Advanced Recipient Routing feature."},"allowAdvancedRecipientRoutingConditionalMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAgentNameEmailEdit":{"type":"string","description":"When **true,** an agent recipient can change the email addresses of recipients later in the signing order."},"allowAgentNameEmailEditMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAgreementActions":{"type":"string"},"allowAgreementActionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAgreementOrchestrations":{"type":"string"},"allowAgreementOrchestrationsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAutoNavSettings":{"type":"string","description":"When **true,** auto-navigation can be enabled for this account."},"allowAutoNavSettingsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowAutoTagging":{"type":"string","description":"When **true,** auto-tagging is enabled for the account."},"allowAutoTaggingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowBulkSend":{"type":"string","description":"When **true,** bulk send functionality is enabled for the account.\n\n**Note:** Only Admin users can change this setting."},"allowBulkSendMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowBYOIDV":{"type":"string"},"allowBYOIDVMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowCDWithdraw":{"type":"string","description":"When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.** **Note:** Only Admin users can change this setting."},"allowCDWithdrawMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowConnectAgreementUI":{"type":"string"},"allowConnectAgreementUIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowConnectAuthoritativeCopyReadyEventUI":{"type":"string"},"allowConnectEnvelopeReminderSentEventUI":{"type":"string"},"allowConnectEnvelopeRemovedEvent":{"type":"string"},"allowConnectExtensionUI":{"type":"string"},"allowConnectHttpListenerConfigs":{"type":"string","description":"Boolean that specifies whether a Connect configuration can use HTTP listeners."},"AllowConnectIdentityVerificationUI":{"type":"string"},"allowConnectOAuthUI":{"type":"string"},"allowConnectSendFinishLater":{"type":"string","description":"Reserved for Docusign."},"allowConnectSendFinishLaterMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowConnectUnifiedPayloadUI":{"type":"string"},"allowConnectWorkspaceUploadRequestUI":{"type":"string"},"allowConsumerDisclosureOverride":{"type":"string","description":"When **true,**\nthe account has the ability to change the\n[Consumer Disclosure](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=aqg1583277336549.html)\nsetting."},"allowConsumerDisclosureOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDataDownload":{"type":"string","description":"When **true,** senders can download form data from the envelopes that they send.\n\n**Note:** Only Admin users can change this setting."},"allowDataDownloadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDelayedRouting":{"type":"string","description":"\"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise."},"allowDelayedRoutingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDelegatedSigning":{"type":"string"},"allowDelegatedSigningMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDocGenDocuments":{"type":"string"},"allowDocGenDocumentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDocumentDisclosures":{"type":"string","description":"Boolean that specifies whether disclosure documents can be included in envelopes."},"allowDocumentDisclosuresMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDocumentsOnSignedEnvelopes":{"type":"string","description":"Boolean that specifies whether notifications can include the envelope's signed document."},"allowDocumentsOnSignedEnvelopesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowDocumentVisibility":{"type":"string","description":"When **true,** the [Document Visibility](https://support.docusign.com/guides/ndse-user-guide-document-visibility) feature is enabled for the account."},"allowDocumentVisibilityMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEditingEnvelopesOnBehalfOfOthers":{"type":"string"},"allowEditingEnvelopesOnBehalfOfOthersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEHankoStamps":{"type":"string","description":"When **true,** [eHanko stamps](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=dys1578456666697.html)\nare enabled."},"allowEHankoStampsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowENoteEOriginal":{"type":"string","description":"Specifies whether eNote eOriginal integration is enabled."},"allowENoteEOriginalMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopeCorrect":{"type":"string","description":"When **true,** the envelope correction feature is enabled.\n\n**Note:** Only Admin users can change this setting."},"allowEnvelopeCorrectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopeCustodyTransfer":{"type":"string","description":"Specifies whether the account is able to\nmanage rules that [transfer ownership](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=xqx1583277378404.html)\nof envelopes within the same account."},"allowEnvelopeCustodyTransferMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopeCustomFields":{"type":"string","description":"Specifies whether\n[envelope custom fields](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=mns1578456285568.html)\nare enabled."},"allowEnvelopeCustomFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopePublishReporting":{"type":"string","description":"When **true,** envelope publishing reporting is enabled.\n\n**Note:** Only Admin users can change this setting."},"allowEnvelopePublishReportingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowEnvelopeReporting":{"type":"string","description":"Specifies whether the account has access to reports."},"allowEnvelopeReportingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowExpression":{"type":"string","description":"If the account plan does not include calculated fields, this setting allows an account to use them."},"allowExpressionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowExpressSignerCertificate":{"type":"string","description":"When **true,** signers are required to use Express Digital Signatures.\n\n**Note:** Only Admin users can change this setting."},"allowExpressSignerCertificateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowExtendedSendingResourceFile":{"type":"string","description":"Boolean that specifies whether resource files can be used for extended sending."},"allowExtendedSendingResourceFileMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowExternalLinkedAccounts":{"type":"string"},"allowExternalLinkedAccountsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowExternalSignaturePad":{"type":"string","description":"When **true,** the account can\nconfigure and use signature pads for their recipients.\n\n**Note:** Only Admin users can change this setting."},"allowExternalSignaturePadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowFedRampIDVLevel1":{"type":"string"},"allowFedRampIDVLevel1Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowFedRampIDVLevel2":{"type":"string"},"allowFedRampIDVLevel2Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIDVForEUQualifiedSignatures":{"type":"string"},"allowIDVForEUQualifiedSignaturesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIDVLevel1":{"type":"string","description":"When **true,** IDV Level 1 is allowed. The default value is **false.**"},"allowIDVLevel1Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIDVLevel1Trial":{"type":"string"},"allowIDVLevel1TrialMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIDVLevel2":{"type":"string"},"allowIDVLevel2Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIDVLevel3":{"type":"string"},"allowIDVLevel3Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIdvPassiveRiskAssessment":{"type":"string"},"allowIdvPassiveRiskAssessmentMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIDVPlatform":{"type":"string"},"allowIDVPlatformMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowIdvRiskAssessment":{"type":"string"},"allowIdvRiskAssessmentMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowInPerson":{"type":"string","description":"When **true,** the account administrator can enable in-person signing.\n\n**Note:** Only SysAdmin users can change this setting."},"allowInPersonElectronicNotary":{"type":"string","description":"Account-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions."},"allowInPersonElectronicNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowInPersonMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManagedStamps":{"type":"string","description":"When **true,** [Managed Stamps](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=cex1583277417267.html) are enabled."},"allowManagedStampsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowManagingEnvelopesOnBehalfOfOthers":{"type":"string"},"allowManagingEnvelopesOnBehalfOfOthersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowMarkup":{"type":"string","description":"When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level."},"allowMarkupMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowMemberTimeZone":{"type":"string","description":"When **true,** account users can set their own\n[time zone settings](https://support.docusign.com/s/articles/How-do-I-modify-time-zone-settings-for-my-account).\n\n**Note:** Only Admin users can change this setting."},"allowMemberTimeZoneMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowMergeFields":{"type":"string","description":"When **true,** the account can use\n[merge fields](https://support.docusign.com/s/document-item?bundleId=evk1581360654067&topicId=ipy1581360621906.html)\nwith Docusign for Salesforce."},"allowMergeFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowMultipleBrandProfiles":{"type":"string","description":"Specifies whether the account supports multiple brands."},"allowMultipleBrandProfilesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowMultipleSignerAttachments":{"type":"string","description":"When **true,** recipients can\nupload multiple signer attachments with a single attachment.\n\n**Note:** Only Admin users can change this setting."},"allowMultipleSignerAttachmentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowNonUSPhoneAuth":{"type":"string","description":"Specifies whether users can use\ninternational numbers\nfor phone authentication."},"allowNonUSPhoneAuthMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOcrOfEnvelopeDocuments":{"type":"string"},"allowOcrOfEnvelopeDocumentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOfflineSigning":{"type":"string","description":"When **true,** [offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch)\nis enabled for the account.\n\n**Note:** Only Admin users can change this setting."},"allowOfflineSigningMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOnlyStandaloneWebForms":{"type":"string"},"allowOnlyStandaloneWebFormsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOpenTrustSignerCertificate":{"type":"string","description":"When **true,** senders can use OpenTrust signer certificates.\n\n**Note:** Only Admin users can change this setting."},"allowOpenTrustSignerCertificateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationBranding":{"type":"string"},"allowOrganizationBrandingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationDocusignMonitor":{"type":"string"},"allowOrganizationDocusignMonitorFree":{"type":"string"},"allowOrganizationDocusignMonitorFreeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationDocusignMonitorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationDomainUserManagement":{"type":"string"},"allowOrganizationDomainUserManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizations":{"type":"string","description":"Boolean that specifies whether [Docusign Admin](/docs/admin-api/) is enabled for the account."},"allowOrganizationsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationSsoManagement":{"type":"string"},"allowOrganizationSsoManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationToUseInPersonElectronicNotary":{"type":"string","description":"Organization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions."},"allowOrganizationToUseInPersonElectronicNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationToUseRemoteNotary":{"type":"string"},"allowOrganizationToUseRemoteNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowOrganizationToUseThirdPartyElectronicNotary":{"type":"string","description":"Org level flag that determines the availability to perform Third Party Notary (3PN) actions."},"allowOrganizationToUseThirdPartyElectronicNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowParticipantRecipientType":{"type":"string"},"allowParticipantRecipientTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPaymentProcessing":{"type":"string","description":"When **true,** payment processing is enabled for the account.\n\n**Note:** Only Admin users can change this setting."},"allowPaymentProcessingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPendingDestinationUrlEdition":{"type":"string"},"allowPendingDestinationUrlEditionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPerformanceAnalytics":{"type":"string"},"allowPerformanceAnalyticsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPhoneAuthentication":{"type":"string","description":"Boolean that specifies whether phone authentication is enabled for the account."},"allowPhoneAuthenticationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPhoneAuthOverride":{"type":"string","description":"Boolean that specifies whether users can override phone authentication."},"allowPhoneAuthOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowPrivateSigningGroups":{"type":"string","description":"Reserved for Docusign. This property returns the value **false** when listing account settings. This property is read-only."},"allowPrivateSigningGroupsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowRecipientConnect":{"type":"string"},"allowRecipientConnectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowReminders":{"type":"string","description":"When **true,**\nan account administrator can to turn on reminders\nand expiration defaults for the account.\n\n**Note:** Only Admin users can change this setting."},"allowRemindersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowRemoteNotary":{"type":"string"},"allowRemoteNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowResourceFileBranding":{"type":"string","description":"When **true,**\nresource files can be uploaded in branding."},"allowResourceFileBrandingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSafeBioPharmaSignerCertificate":{"type":"string","description":"When **true,**\naccount administrators can\nspecify that signers are\nrequired to use SAFE-BioPharma digital signatures.\n\n**Note:** Only Admin users can change this setting."},"allowSafeBioPharmaSignerCertificateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowScheduledSending":{"type":"string","description":"\\\"true\\\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \\\"false\\\" otherwise."},"allowScheduledSendingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSecurityAppliance":{"type":"string","description":"Boolean that specifies whether a Docusign Signature Appliance can be used with the account."},"allowSecurityApplianceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSendingEnvelopesOnBehalfOfOthers":{"type":"string"},"allowSendingEnvelopesOnBehalfOfOthersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSendToCertifiedDelivery":{"type":"string","description":"When **true,**\nthe account admin can enable the\nSend to Certified Delivery\nfeature on the account."},"allowSendToCertifiedDeliveryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSendToIntermediary":{"type":"string","description":"When **true,**\nthe account admin can enable the Send to Intermediary\nfeature on the account."},"allowSendToIntermediaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowServerTemplates":{"type":"string","description":"When **true,**\nthe account can use templates."},"allowServerTemplatesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSetEmbeddedRecipientStartURL":{"type":"string"},"allowSetEmbeddedRecipientStartURLMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSharedTabs":{"type":"string","description":"When **true,**\nshared tabs are enabled for the account.\n\n**Note:** Only Admin users can change this setting."},"allowSharedTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSignatureStamps":{"type":"string","description":"When **true,** Signature Stamps are enabled.\n\n**Note:** Only Admin users can change this setting."},"allowSignatureStampsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSignDocumentFromHomePage":{"type":"string","description":"When **true,** recipients can sign documents from the home page.\n\n**Note:** Only Admin users can change this setting."},"allowSignDocumentFromHomePageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSignerReassign":{"type":"string","description":"When **true,** the recipient of an envelope sent from this account can reassign it to another person.\n\n**Note:** Only Admin users can change this setting."},"allowSignerReassignMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSignerReassignOverride":{"type":"string","description":"When **true,** an account administrator can override the ability of an envelope recipient to reassign it to another person.\n\n**Note:** Only Admin users can change this setting."},"allowSignerReassignOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSigningExtensions":{"type":"string","description":"Boolean that specifies whether Signing and App Extensions are allowed."},"allowSigningExtensionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSigningGroups":{"type":"string","description":"When **true,** the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only."},"allowSigningGroupsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSigningInsights":{"type":"string"},"allowSigningInsightsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSigningRadioDeselect":{"type":"string","description":"Boolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](/docs/esign-soap-api/reference/sending-group/tab/)."},"allowSigningRadioDeselectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSignNow":{"type":"string","description":"When **true,**\nthe account administrator can enable\nthe Sign Now feature."},"allowSignNowMetadata":{"type":"string","description":"Metadata that indicates whether the `allowSignNow` property is editable."},"allowSMSDelivery":{"type":"string"},"allowSMSDeliveryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSocialIdLogin":{"type":"string","description":"Deprecated."},"allowSocialIdLoginMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowSupplementalDocuments":{"type":"string","description":"When **true,** this user can include supplemental documents."},"allowSupplementalDocumentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowThirdPartyElectronicNotary":{"type":"string","description":"Account level flag that determines the availability to perform Third Party Notary (3PN) actions."},"allowThirdPartyElectronicNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowTransactionsWorkspace":{"type":"string"},"allowTransactionsWorkspaceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowTransactionsWorkspaceOriginal":{"type":"string"},"allowTransactionsWorkspaceOriginalMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowUsersToAccessDirectory":{"type":"string"},"allowUsersToAccessDirectoryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowValueInsights":{"type":"string"},"allowValueInsightsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowWebForms":{"type":"string"},"allowWebFormsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"allowWhatsAppDelivery":{"type":"string"},"allowWhatsAppDeliveryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"anchorPopulationScope":{"type":"string","description":"This property determines how template anchor tabs are applied.\n\nValid values are:\n\n- `document`: Anchor tabs are applied only to the document that you specify.\n- `envelope`: Anchor tabs are applied to all of the documents in the envelope associated with the template.\n\n**Note:** When you are using the `anchorPopulationScope` property with a Composite Template, the value `document` is supported only with a single server template and a single inline template."},"anchorPopulationScopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"anchorTagVersionedPlacementEnabled":{"type":"string","description":"Reserved for Docusign."},"anchorTagVersionedPlacementMetadataEnabled":{"$ref":"#/components/schemas/settingsMetadata"},"attachCompletedEnvelope":{"type":"string","description":"When **true,** envelope documents are included as a PDF file attachment to \"signing completed\" emails.\n\n**Note:** Only SysAdmin users can change this setting."},"attachCompletedEnvelopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"authenticationCheck":{"type":"string","description":"Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks:\n\n- Phone Authentication\n- SMS Authentication\n- Knowledge-Based ID\n\nThis setting takes one of the following options:\n\n- `initial_access`: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.\n- `each_access`: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame.\n\n**Note:** Only Admin users can change this setting."},"authenticationCheckMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"autoNavRule":{"type":"string","description":"Specifies how auto-navigation works.\nValid values are:\n\n- `off`\n- `required_fields`\n- `required_and_blank_fields`\n- `all_fields`\n- `page_then_required_fields`\n- `page_then_required_and_blank_fields`\n- `page_then_all_fields`"},"autoNavRuleMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"autoProvisionSignerAccount":{"type":"string","description":"Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)"},"autoProvisionSignerAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"bccEmailArchive":{"type":"string","description":"Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address."},"bccEmailArchiveMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"betaSwitchConfiguration":{"type":"string","description":"Reserved for Docusign."},"betaSwitchConfigurationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"billingAddress":{"$ref":"#/components/schemas/addressInformation"},"billingAddressMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"bulkSend":{"type":"string","description":"When **true,** this user can use the bulk send feature for the account."},"bulkSendActionResendLimit":{"type":"string"},"bulkSendMaxCopiesInBatch":{"type":"string"},"bulkSendMaxUnprocessedEnvelopesCount":{"type":"string"},"bulkSendMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSelfBrandSend":{"type":"string","description":"When **true,** account administrators can self-brand their sending console through the Docusign console."},"canSelfBrandSendMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canSelfBrandSign":{"type":"string","description":"When **true,** account administrators can self-brand their signing console through the Docusign console."},"canSelfBrandSignMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"canUseSalesforceOAuth":{"type":"string"},"canUseSalesforceOAuthMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"captureVoiceRecording":{"type":"string","description":"Reserved for Docusign."},"captureVoiceRecordingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"cfr21SimplifiedSigningEnabled":{"type":"string"},"cfr21SimplifiedSigningEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"cfrUseWideImage":{"type":"string","description":"Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image."},"cfrUseWideImageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"checkForMultipleAdminsOnAccount":{"type":"string"},"checkForMultipleAdminsOnAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"chromeSignatureEnabled":{"type":"string","description":"Boolean that specifies whether the signers of the envelopes from this account use a signature with a Docusign chrome around it or not."},"chromeSignatureEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"cloudReady":{"type":"string"},"commentEmailShowMessageText":{"type":"string","description":"When **true,** the text of comments is included in email notifications when a comment is posted.\n\n**Note:** If the envelope requires additional recipient authentication, comment text is not included."},"commentEmailShowMessageTextMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"commentsAllowEnvelopeOverride":{"type":"string","description":"When **true** and comments are enabled for the account, senders can disable comments for an envelope through the **Advanced Options** menu that appears during the sending process."},"commentsAllowEnvelopeOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"conditionalFieldsEnabled":{"type":"string","description":"When **true,** conditional fields can be used in documents.\n\n**Note:** Only Admin users can change this setting."},"conditionalFieldsEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"consumerDisclosureFrequency":{"type":"string","description":"Speficies how often to display the consumer disclosure.\n\nValid values are:\n\n- `once`: Per account, the supplemental document is displayed once only per `userId`.\n- `always`: Per envelope, the supplemental document is displayed once only per `userId`.\n- `each_access`: Per envelope, the supplemental document is displayed once only per `recipientId`."},"consumerDisclosureFrequencyMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"convertPdfFields":{"type":"string","description":"Boolean that specifies whether to enable PDF form fields to get converted to Docusign secure fields when the document is added or uploaded to an envelope."},"convertPdfFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"customExtractionPlanLevels":{"type":"string"},"customExtractionPlanLevelsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"dataPopulationScope":{"type":"string","description":"Specifies how data is shared for tabs with the same tabLabel. Valid values are:\n\n- `document`: Tabs in a document with the same label populate with the same data.\n- `envelope`: Tabs in all documents in the envelope with the same label populate with the same data.\n- `notset`: Use the global account setting.\n\nThis setting applies to the following tab types:\n\n- Check box\n- Company\n- Data field\n- Drop-down list\n- Full name\n- Formula\n- Note\n- Title\n\n**Note:** Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed."},"dataPopulationScopeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"defaultSigningResponsiveView":{"type":"string"},"defaultSigningResponsiveViewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"defaultSigningResponsiveViewUseGrade":{"type":"string"},"defaultSigningResponsiveViewUseGradeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"defaultToAdvancedEnvelopesFilterForm":{"type":"string"},"defaultToAdvancedEnvelopesFilterFormMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableAutoTemplateMatching":{"type":"string"},"disableAutoTemplateMatchingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableLegacyKba":{"type":"string"},"disableLegacyKbaMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableLegacySharedEnvelopes":{"type":"string"},"disableLegacySharedEnvelopesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableMobileApp":{"type":"string","description":"When **true,** the mobile app distributor key is prevented from connecting for account users."},"disableMobileAppMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableMobilePushNotifications":{"type":"string","description":"When **true,** push notifications are disabled for the account.\n\n**Note:** Only Admin users can change this setting."},"disableMobilePushNotificationsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableMobileSending":{"type":"string","description":"When **true,** sending from a mobile application is disabled.\n\n**Note:** Only Admin users can change this setting."},"disableMobileSendingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableMultipleSessions":{"type":"string","description":"When **true,** account users cannot be logged into multiple sessions at the same time.\n\n**Note:** Only Admin users can change this setting."},"disableMultipleSessionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disablePurgeNotificationsForSenderMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableSignerCertView":{"type":"string","description":"When **true,** signers cannot view certificates of completion."},"disableSignerCertViewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableSignerHistoryView":{"type":"string","description":"When **true,** signers cannot view envelope history."},"disableSignerHistoryViewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableStyleSignature":{"type":"string","description":"When **true,** the **Select Style** option is hidden from signers and they must draw their signature instead."},"disableStyleSignatureMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableUploadSignature":{"type":"string","description":"When **true,** signers cannot upload custom image files of their signature and initials.\n\n**Note:** Only Admin users can change this setting."},"disableUploadSignatureMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"disableUserSharing":{"type":"string","description":"When **true,** the User Sharing feature is disabled for the account."},"disableUserSharingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"displayBetaSwitch":{"type":"string","description":"Boolean that specifies whether to display a Beta switch for your app."},"displayBetaSwitchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"documentConversionRestrictions":{"type":"string","description":"Sets the account document upload restriction for non-account administrators. Valid values are:\n\n- `no_restrictions`: There are no restrictions on the type of documents that can be uploaded.\n- `allow_pdf_only`: Non-administrators can only upload PDF files.\n- `no_upload`: Non-administrators cannot upload files.\n\n**Note:** Only Admin users can change this setting."},"documentConversionRestrictionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"documentRetention":{"type":"string","description":"Sets a document retention period, which controls the number of days that Docusign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is `356` days."},"documentRetentionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"documentRetentionPurgeTabs":{"type":"string","description":"When **true** and `documentRetention` is set, document fields and metadata are also purged after the document retention period ends. The default value is **false.**\n\n**Note:** Only Admins can change this setting."},"documentVisibility":{"type":"string","description":"Configures the Document Visibility feature for the account. Valid values are:\n\n- `Off`: Document Visibility is not active for the account.\n- `MustSignToViewUnlessSenderAccount`: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope.\n- `MustSignToViewUnlessSender`: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope.\n- `SenderCanSetMustSignToViewUnlessSenderAccount`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account.\nVd- `SenderCanSetMustSignToViewUnlessSender`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender.\n\n**Note:** For this configuration to take effect, `allowDocumentVisibility` must be set to **true.**"},"documentVisibilityMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"docusignPDF":{"type":"string"},"docusignPDFMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"draftEnvelopeRetention":{"type":"string"},"draftEnvelopeRetentionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"dss_SIGN_28411_EnableLeavePagePrompt_RadminOption":{"type":"string"},"dss_SIGN_29182_SlideUpBar_RadminOption":{"type":"string"},"emailTemplateVersion":{"type":"string","description":"Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account."},"emailTemplateVersionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAccessCodeGenerator":{"type":"string","description":"When **true,** enables Access Code Generator on the account."},"enableAccessCodeGeneratorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAccountWideSearch":{"type":"string"},"enableAccountWideSearchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdditionalAdvancedWebFormsFeatures":{"type":"string"},"enableAdditionalAdvancedWebFormsFeaturesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdmHealthcare":{"type":"string","description":"Account Level Flag that determines the availability to use ADM Healthcare fields"},"enableAdmHealthcareMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdvancedEnvelopesSearch":{"type":"string"},"enableAdvancedEnvelopesSearchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdvancedPayments":{"type":"string","description":"When **true,** enables Advanced Payments for the account."},"enableAdvancedPaymentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdvancedPowerForms":{"type":"string","description":"When **true,** enables advanced PowerForms for the account."},"enableAdvancedPowerFormsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAdvancedSearch":{"type":"string"},"enableAdvancedSearchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAgreementActionsForCLM":{"type":"string"},"enableAgreementActionsForCLMMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAgreementActionsForESign":{"type":"string"},"enableAgreementActionsForESignMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAgreementDeskAdvanced":{"type":"string"},"enableAgreementDeskAdvancedMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableAIAgents":{"type":"string"},"enableAIAgentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAIContractReview":{"type":"string"},"enableAIContractReviewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAISenderMessage":{"type":"string"},"enableAISenderMessageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAISuggestedFields":{"type":"string"},"enableAISuggestedFieldsAutoPlace":{"type":"string"},"enableAISuggestedFieldsAutoPlaceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAISuggestedFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableAutoNav":{"type":"string","description":"When **true,** enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope.\n\n**Note:** To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set."},"enableAutoNavMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableBatchUpdateEnvelopeTypes":{"type":"string"},"enableBatchUpdateEnvelopeTypesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableBccDummyLink":{"type":"string"},"enableBccDummyLinkMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCacPivSignatureGroup":{"type":"string"},"enableCacPivSignatureGroupMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCalculatedFields":{"type":"string","description":"When **true,** calculated fields are enabled for the account.\n\n**Note:** This setting can be changed only by Admin users, and only if the account-level setting `allowExpression` is set to **true.**"},"enableCalculatedFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCFRRapidSigningEmbeddedAuth":{"type":"string"},"enableCFRRapidSigningEmbeddedAuthMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableClickPlus":{"type":"string"},"enableClickPlusConditionalContent":{"type":"string"},"enableClickPlusConditionalContentMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableClickPlusCustomFields":{"type":"string"},"enableClickPlusCustomFieldsMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableClickPlusCustomStyle":{"type":"string"},"enableClickPlusCustomStyleMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableClickPlusDynamicContent":{"type":"string"},"enableClickPlusDynamicContentMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableClickPlusMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableClickwraps":{"type":"string","description":"Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap](/docs/click-api/click101/) is an iframe that you embed in your own website or app."},"enableClickwrapsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCombinedPDFDownloadForSBS":{"type":"string"},"enableCommentsHistoryDownloadInSigning":{"type":"string"},"enableCommentsHistoryDownloadInSigningMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableContactSuggestions":{"type":"string"},"enableContactSuggestionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableContentSearch":{"type":"string"},"enableContentSearchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCoupaCoreExtension":{"type":"string"},"enableCoupaCoreExtensionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCoupaIAMConnector":{"type":"string"},"enableCoupaIAMConnectorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCustomDataVerificationExtensions":{"type":"string"},"enableCustomDataVerificationExtensionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableCustomerSatisfactionMetricTracking":{"type":"string","description":"When **true,** enables customer satisfaction metric tracking for the account."},"enableCustomerSatisfactionMetricTrackingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDataVerificationExtensions":{"type":"string"},"enableDataVerificationExtensionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDocumentTemplateLibrary":{"type":"string"},"enableDocumentTemplateLibraryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigEUAdvancedPens":{"type":"string"},"enableDSigEUAdvancedPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigExpressPens":{"type":"string"},"enableDSigExpressPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigIDCheckForAESPens":{"type":"string"},"enableDSigIDCheckForAESPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigIDCheckInPersonForQESPens":{"type":"string"},"enableDSigIDCheckInPersonForQESPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigIDCheckRemoteForQESPens":{"type":"string"},"enableDSigIDCheckRemoteForQESPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigIDVerificationPens":{"type":"string"},"enableDSigIDVerificationPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigIDVerificationPremierPens":{"type":"string"},"enableDSigIDVerificationPremierPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigPenGroupEuQes":{"type":"string"},"enableDSigPenGroupEuQesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSigPlgEuQesPens":{"type":"string"},"enableDSigPlgEuQesPensMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableDSPro":{"type":"string","description":"Reserved for Docusign."},"enableDSProMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEnforceTlsEmailsSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEnvelopeStampingByAccountAdmin":{"type":"string","description":"When **true,** enables the account administrator\nto control envelope stamping for an account\n(stamping the `envelopeId` in the document margins).\n\n**Note:** This setting can be changed only\nby Admin users, and only if the account-level\nsetting `enableEnvelopeStampingByDSAdmin` is set to **true.**"},"enableEnvelopeStampingByAccountAdminMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEnvelopeStampingByDSAdmin":{"type":"string","description":"When **true,** enables the Docusign administrator to control envelope stamping for an account (placement of the `envelopeId`)."},"enableEnvelopeStampingByDSAdminMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableESignAPIHourlyLimitManagement":{"type":"string"},"enableESignAPIHourlyLimitManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEsignCommunities":{"type":"string"},"enableEsignCommunitiesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableEsignTaskList":{"type":"string"},"enableEsignTaskListMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableGenAndAPI":{"type":"string"},"enableGenAndAPIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableGenerationWith3PIntegration":{"type":"string"},"enableGenerationWith3PIntegrationMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableGreenhouseApp":{"type":"string"},"enableGreenhouseAppMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableI9OnDemand":{"type":"string"},"enableI9OnDemandMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIAMClauseLibrary":{"type":"string"},"enableIAMClauseLibraryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIAMDataConnector":{"type":"string"},"enableIAMDataConnectorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIAMforXEmbeddedUX":{"type":"string"},"enableIAMforXEmbeddedUXMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIDFxAccountlessSMSAuthForPart11":{"type":"string"},"enableIDFxAccountlessSMSAuthForPart11Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIDFxIntuitKBA":{"type":"string"},"enableIDFxIntuitKBAMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIDFxPhoneAuthentication":{"type":"string"},"enableIDFxPhoneAuthenticationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableIdfxPhoneAuthSignatureAuthStatus":{"type":"string"},"enableIdfxPhoneAuthSignatureAuthStatusMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableInboxBrowseViewsPoweredByElasticSearch":{"type":"string"},"enableInboxBrowseViewsPoweredByElasticSearchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableInboxRelevanceSort":{"type":"string"},"enableInboxRelevanceSortMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableInBrowserEditor":{"type":"string"},"enableInBrowserEditorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableKeyTermsSuggestionsByDocumentType":{"type":"string"},"enableKeyTermsSuggestionsByDocumentTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableLargeFileSupport":{"type":"string"},"enableLargeFileSupportMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableLegacySharedEnvelopes":{"type":"string"},"enableLegacySharedEnvelopesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableLicenseManagement":{"type":"string"},"enableLicenseManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableMicrosoftDynamics365Extension":{"type":"string"},"enableMicrosoftDynamics365ExtensionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableMultiUserRepositoryFeatures":{"type":"string"},"enableMultiUserRepositoryFeaturesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorAPIDataIn":{"type":"string"},"enableNavigatorAPIDataInMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorAPIDataOut":{"type":"string"},"enableNavigatorAPIDataOutMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorAPIUtilities":{"type":"string"},"enableNavigatorAPIUtilitiesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorForHR":{"type":"string"},"enableNavigatorForHRMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorHierarchyAI":{"type":"string"},"enableNavigatorHierarchyAIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorPartialIngestion":{"type":"string"},"enableNavigatorPartialIngestionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNavigatorTrial":{"type":"string"},"enableNavigatorTrialMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableNotaryOnDemandWitness":{"type":"string"},"enableNotaryOnDemandWitnessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableObligationManagement":{"type":"string"},"enableObligationManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableOwnerInsightsAndRecommendationsSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableParticipantRecipientSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enablePaymentProcessing":{"type":"string","description":"When **true,** payment processing is enabled for this account.\n\n**Note:** This setting can be changed only by Admin users, and only if the account-level setting `allowPaymentProcessing` is set."},"enablePaymentProcessingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enablePDFAConversion":{"type":"string"},"enablePDFAConversionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enablePowerForm":{"type":"string","description":"When **true,** enables PowerForms for the account.\n\n**Note:** Only SysAdmin users can change this setting."},"enablePowerFormDirect":{"type":"string","description":"When **true,** enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.\n\n**Note:** Only Admin users can change this setting."},"enablePowerFormDirectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enablePowerFormMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enablePremiumDataVerificationExtensions":{"type":"string"},"enablePremiumDataVerificationExtensionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableRecipientDomainValidation":{"type":"string","description":"Reserved for Docusign."},"enableRecipientDomainValidationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableRecipientMayProvidePhoneNumber":{"type":"string"},"enableRecipientMayProvidePhoneNumberMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableReportLinks":{"type":"string","description":"Enables direct links to envelopes in reports for administrators in the following scopes:\n\n- `NoEnvelopes`\n- `AllEnvelopes`\n- `OnlyOwnEnvelopes`"},"enableReportLinksMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableRequireSignOnPaper":{"type":"string","description":"When **true,** the account can use the `requireSignOnPaper` option.\n\n**Note:** Only Admin users can change this setting."},"enableRequireSignOnPaperMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableReservedDomain":{"type":"string","description":"When **true,** account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as `@exampledomain.com`. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users.\n\n- Domains may be claimed by an organization.\n- When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts.\n- You can set domain controls for all users of the domain.\n- You can export information about your organization’s users that are associated with your reserved domains.\n\n**Note:** Only SysAdmin users can change this setting."},"enableReservedDomainMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableResponsiveSigning":{"type":"string","description":"When **true,** enables responsive signing."},"enableResponsiveSigningMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableReviewerEventsSetting":{"type":"string"},"enableReviewerEventsSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSAPAribaExtension":{"type":"string"},"enableSAPAribaExtensionMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableScheduledRelease":{"type":"string","description":"When **true,** scheduled releases are enabled. The default value is **false.**"},"enableScheduledReleaseMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSearchServiceAzureUri":{"type":"string"},"enableSearchServiceAzureUriMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSearchSiteSpecificApi":{"type":"string"},"enableSearchSiteSpecificApiMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSenderInsightsAndRecommendationsSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSendingTagsFontSettings":{"type":"string","description":"When **true,** enables fonts to be set on tags for the account."},"enableSendingTagsFontSettingsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSendToAgent":{"type":"string","description":"When **true,** this account can use the Agent recipient type.\n\n**Note:** Only SysAdmin users can change this setting."},"enableSendToAgentMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSendToIntermediary":{"type":"string","description":"When **true,** this account can use the Intermediary recipient type.\n\n**Note:** Only Admin users can change this setting, and only if `allowSendToIntermediary` is set."},"enableSendToIntermediaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSendToManage":{"type":"string","description":"When **true,** this account can use the Editor recipient type.\n\n**Note:** Only Admin users can change this setting."},"enableSendToManageMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSequentialSigningAPI":{"type":"string","description":"When **true,** the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note:** Only SysAdmin users can change this setting."},"enableSequentialSigningAPIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSequentialSigningUI":{"type":"string","description":"When **true,** the account can define the routing order\nof recipients for envelopes sent by using the Docusign application.\n\n**Note:** Only SysAdmin users can change this setting."},"enableSequentialSigningUIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSignerAttachments":{"type":"string","description":"When **true,** users can use the signing attachments feature to request attachments from signers.\n\n**Note:** Only Admin users can change this setting."},"enableSignerAttachmentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSigningAIFeaturesPlan":{"type":"string"},"enableSigningAIFeaturesPlanMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSigningExtensionComments":{"type":"string","description":"When **true,** enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent."},"enableSigningExtensionCommentsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSigningExtensionConversations":{"type":"string","description":"When **true,** enables conversation functionality."},"enableSigningExtensionConversationsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSigningGroupContinuePageSetting":{"type":"string"},"enableSigningGroupContinuePageSettingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSigningOrderSettingsForAccount":{"type":"string","description":"When **true,** switches Signing Order to On by default for new envelopes."},"enableSigningOrderSettingsForAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSignOnPaper":{"type":"string","description":"When **true,** a sender can allow signers to use the sign on paper option.\n\n**Note:** Only Admin users can change this setting."},"enableSignOnPaperMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSignOnPaperOverride":{"type":"string","description":"When **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note:** Only Admin users can change this setting."},"enableSignOnPaperOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSignWithNotary":{"type":"string","description":"When **true,** Sign with Notary functionality is enabled for the account.\n\n**Note:** Only Admin users can change this setting."},"enableSignWithNotaryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSmartContracts":{"type":"string","description":"When **true,** blockchain-based [Smart Contracts](https://www.docusign.com/products/blockchain) are enabled. The default value is **false.**"},"enableSmartContractsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSMSAuthentication":{"type":"string","description":"When **true,** the account can use SMS authentication.\n\n**Note:** Only Admin users can change this setting."},"enableSMSAuthenticationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSMSDeliveryAdditionalNotification":{"type":"string"},"enableSMSDeliveryAdditionalNotificationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableSMSDeliveryPrimary":{"type":"string"},"enableSocialIdLogin":{"type":"string","description":"Deprecated."},"enableSocialIdLoginMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableStrikeThrough":{"type":"string","description":"When **true,** enables strikethrough formatting in documents."},"enableStrikeThroughMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableTickets":{"type":"string"},"enableTicketsMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableTransactionPoint":{"type":"string","description":"Reserved for Docusign."},"enableTransactionPointMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableUnifiedRepository":{"type":"string"},"enableUnifiedRepositoryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableVaulting":{"type":"string","description":"When **true,** Vaulting is enabled for the account."},"enableVaultingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableWebFormsRuntimeAPIs":{"type":"string"},"enableWebFormsRuntimeAPIsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableWebFormsSeparateUserPermissions":{"type":"string"},"enableWebFormsSeparateUserPermissionsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableWitnessing":{"type":"string","description":"Reserved for Docusign."},"enableWitnessingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableWorkdayFinancialsExtension":{"type":"string"},"enableWorkdayFinancialsExtensionMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"enableWorkdayHRApp":{"type":"string"},"enableWorkdayHRAppMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enableWorksheets":{"type":"string"},"enableWorksheetsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enforceTemplateNameUniqueness":{"type":"string","description":"When **true,** the template name must be unique."},"enforceTemplateNameUniquenessMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"enforceTlsEmails":{"type":"string"},"enforceTlsEmailsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"envelopeIntegrationAllowed":{"type":"string","description":"Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are:\n\n- `not_allowed`\n- `full`\n\n**Note:** Only SysAdmin users can change this setting."},"envelopeIntegrationAllowedMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"envelopeIntegrationEnabled":{"type":"string","description":"When **true,** enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.\n\n**Note:** Only Admin users can change this setting, and only when `envelopeIntegrationAllowed` is set."},"envelopeIntegrationEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"EnvelopeLimitsTotalDocumentSizeAllowedInMB":{"type":"string"},"EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabled":{"type":"string"},"EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"envelopeSearchMode":{"type":"string"},"envelopeSearchModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"envelopeStampingDefaultValue":{"type":"string","description":"When **true,** envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped."},"envelopeStampingDefaultValueMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"exitPrompt":{"type":"string"},"exitPromptMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"expressSend":{"type":"string","description":"Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents."},"expressSendAllowTabs":{"type":"string","description":"Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger)."},"expressSendAllowTabsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"expressSendMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"externalDocumentSources":{"$ref":"#/components/schemas/externalDocumentSources"},"externalSignaturePadType":{"type":"string","description":"Specifies the signature pad type.\nValid values are:\n\n- `none`\n- `topaz`\n- `e_padv9`\n- `e_pad_integrisign`\n- `topaz_sigplusextlite`\n\n**Note:** Only Admin users can change this setting."},"externalSignaturePadTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"faxOutEnabled":{"type":"string","description":"When **true,** fax delivery to recipients is allowed for the account.\n\n**Note:** Only Admin users can change this setting."},"faxOutEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"finishReminder":{"type":"string"},"finishReminderMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"forbidAddingUserStamps":{"type":"string"},"forbidAddingUserStampsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"guidedFormsHtmlAllowed":{"type":"string","description":"When **true,** HTML used to implement [Guided Forms](https://www.docusign.com/products/guided-forms) is enabled for the account."},"guidedFormsHtmlAllowedMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"guidedFormsHtmlConversionPolicy":{"type":"string"},"guidedFormsHtmlConversionPolicyMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"hasRecipientConnectClaimedDomain":{"type":"string"},"hideAccountAddressInCoC":{"type":"string","description":"Boolean that specifies whether to hide the account address in the Certificate of Completion."},"hideAccountAddressInCoCMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"hidePricing":{"type":"string","description":"Boolean that specifies whether to hide the pricing functionality for an account."},"hidePricingMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"idCheckConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/idCheckConfiguration"},"description":"A list of ID check configuration objects."},"idCheckExpire":{"type":"string","description":"Determines when a user's authentication with the account expires. Valid values are:\n\n- `always`: Users are required to authenticate each time.\n- `variable`: If the authentication for a user is valid and falls within the value for the `idCheckExpireDays` property, the user is not required to authenticate again.\n\n**Note:** Only Admin users can change this setting."},"idCheckExpireDays":{"type":"string","description":"The number of days before user authentication credentials expire. A value of `0` specifies that users must re-authenticate for each new session.\n\n**Note:** Only Admin users can change this setting."},"idCheckExpireDaysMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"idCheckExpireMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"idCheckExpireMinutes":{"type":"string","description":"The number of minutes before user authentication credentials expire."},"idCheckExpireMinutesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"idCheckRequired":{"type":"string","description":"Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope.\n- `never`: Authentication checks are not performed on any envelopes.\n- `optional`: Authentication is configurable per envelope.\n\n**Note:** Only Admin users can change this setting."},"idCheckRequiredMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"identityVerification":{"type":"array","items":{"$ref":"#/components/schemas/accountIdentityVerificationWorkflow"},"description":"Specifies the ID Verification workflow applied on an envelope by workflow ID.\nSee the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.\nNote that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."},"identityVerificationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"idfxKBAAuthenticationOverride":{"type":"string"},"idfxKBAAuthenticationOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"idfxPhoneAuthenticationOverride":{"type":"string"},"idfxPhoneAuthenticationOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"ignoreErrorIfAnchorTabNotFound":{"type":"string","description":"Reserved for Docusign."},"ignoreErrorIfAnchorTabNotFoundMetadataEnabled":{"$ref":"#/components/schemas/settingsMetadata"},"inPersonIDCheckQuestion":{"type":"string","description":"A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.\n\n**Note:** Only Admin users can change this setting."},"inPersonIDCheckQuestionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"inPersonSigningEnabled":{"type":"string","description":"When **true,** in-person signing is enabled for the account."},"inPersonSigningEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"inSessionEnabled":{"type":"string","description":"When **true,** the account can send in-session (embedded) envelopes.\n\n**Note:** Only Admin users can change this setting."},"inSessionEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"inSessionSuppressEmails":{"type":"string","description":"When **true,** emails are not sent to the in-session (embedded) recipients on an envelope.\n\n**Note:** Only Admin users can change this setting."},"inSessionSuppressEmailsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"isConnectDocumentFieldsEnabled":{"type":"string"},"isvEmbed":{"type":"string"},"isvEmbedMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"isvOemEmbed":{"type":"string"},"isvOemEmbedMetaData":{"$ref":"#/components/schemas/settingsMetadata"},"linkedExternalPrimaryAccounts":{"type":"array","items":{"$ref":"#/components/schemas/linkedExternalPrimaryAccount"}},"maestroPlanLevels":{"type":"string"},"maestroPlanLevelsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"maximumSigningGroups":{"type":"string","description":"The maximum number of signing groups allowed on the account. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note:** Only SysAdmin users can change this setting."},"maximumSigningGroupsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"maximumUsersPerSigningGroup":{"type":"string","description":"The maximum number of users per signing group. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note:** Only SysAdmin users can change this setting."},"maximumUsersPerSigningGroupMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"maxNumberOfCustomStamps":{"type":"string","description":"The maximum number of custom stamps."},"mergeMixedModeResults":{"type":"string"},"mergeMixedModeResultsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"mobileSessionTimeout":{"type":"string","description":"The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are `1` to `120` minutes. The default value is `20` minutes.\n\n**Note:** Only Admin users can change this setting."},"mobileSessionTimeoutMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"numberOfActiveCustomStamps":{"type":"string","description":"The number of active custom stamps associated with the account. Docusign calculates this number automatically. This property is only visible to the Docusign account manager."},"optInMobileSigningV02":{"type":"string","description":"Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality."},"optInMobileSigningV02Metadata":{"$ref":"#/components/schemas/settingsMetadata"},"optInUniversalSignatures":{"type":"string"},"optOutAutoNavTextAndTabColorUpdates":{"type":"string","description":"Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color."},"optOutAutoNavTextAndTabColorUpdatesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"optOutNewPlatformSeal":{"type":"string","description":"Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal."},"optOutNewPlatformSealPlatformMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"originalAccountSite":{"type":"string"},"participantCopyOptOut":{"type":"string"},"participantCopyOptOutMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"pdfMaxChunkedUploadPartSize":{"type":"string"},"pdfMaxChunkedUploadPartSizeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"pdfMaxChunkedUploadTotalSize":{"type":"string"},"pdfMaxChunkedUploadTotalSizeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"pdfMaxIndividualUploadSize":{"type":"string"},"pdfMaxIndividualUploadSizeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"phoneAuthRecipientMayProvidePhoneNumber":{"type":"string","description":"When **true,** senders can allow recipients to provide a phone number for the Phone Authentication process.\n\n**Note:** Only Admin users can change this setting."},"phoneAuthRecipientMayProvidePhoneNumberMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"pkiSignDownloadedPDFDocs":{"type":"string","description":"The policy for adding a digital certificate to downloaded, printed, and emailed documents.\n\nPossible values are:\n\n- `no_sign`\n- `no_sign_allow_user_override`\n- `yes_sign` (Specifies that PDF files downloaded from the platform are signed.)\n\n**Note:** Only Admin users can change this setting."},"pkiSignDownloadedPDFDocsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"readOnlyMode":{"type":"string"},"readOnlyModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"recipientsCanSignOffline":{"type":"string","description":"When **true,**\nrecipients receiving envelopes from this account\ncan sign offline.\n\n**Note:** Only Admin users can change this setting."},"recipientsCanSignOfflineMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"recipientSigningAutoNavigationControl":{"type":"string","description":"When **true,** recipients receiving envelopes from this account can override auto-navigation functionality.\n\n**Note:** Only Admin users can change this setting."},"recipientSigningAutoNavigationControlMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"recycleBinEnvelopeRetention":{"type":"string"},"recycleBinEnvelopeRetentionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"require21CFRpt11Compliance":{"type":"string","description":"When **true,**\nrecipients are required\nto use a 21 CFR part 11-compliant signing experience.\n\n**Note:** Only Admin users can change this setting."},"require21CFRpt11ComplianceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"requireDeclineReason":{"type":"string","description":"When **true,** signers who decline to sign an envelope sent from this account\nare required to provide a reason for declining.\n\n**Note:** Only Admin users can change this setting."},"requireDeclineReasonMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"requireExternalUserManagement":{"type":"string","description":"When **true,** the account requires external management of users.\n\n**Note:** Only Admin users can change this setting."},"requireExternalUserManagementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"requireSignerCertificateType":{"type":"string","description":"Sets the Digital Signature certificate requirements for sending envelopes.\nValid values are:\n\n- `none`: A Digital Signature certificate is not required.\n- `docusign_express`: Signers must use a Docusign Express certificate.\n- `docusign_personal`: Signers must use a Docusign personal certificate.\n- `safe`\n- `open_trust`: Signers must use an OpenTrust certificate."},"requireSignerCertificateTypeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"rsaVeridAccountName":{"type":"string","description":"The RSA account name.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it."},"rsaVeridPassword":{"type":"string","description":"The password for the RSA account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it."},"rsaVeridRuleset":{"type":"string","description":"The RSA rule set used with the account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it."},"rsaVeridUserId":{"type":"string","description":"The user ID for the RSA account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it."},"selfSignedRecipientEmailDocument":{"type":"string","description":"Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\nin the email.\n\n**Note:** Only Admin users can change this setting."},"selfSignedRecipientEmailDocumentMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"selfSignedRecipientEmailDocumentUserOverride":{"type":"string","description":"When **true,** the `selfSignedRecipientEmailDocument` user setting\ncan be set for an individual user.\nThe user setting overrides the account setting.\n\n**Note:** Only Admin users can change this account setting."},"selfSignedRecipientEmailDocumentUserOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"senderCanSignInEachLocation":{"type":"string","description":"When **true,** a signer can draw their signature in each\nlocation where a sign or initial tab exists. This functionality\nis typically used for mobile signing.\n\n**Note:** Only Admin users can change this setting."},"senderCanSignInEachLocationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"senderMustAuthenticateSigning":{"type":"string","description":"When **true,** a sender who is also a recipient of an envelope\nmust follow the authentication requirements for the envelope.\n\n**Note:** Only Admin users can change this setting."},"senderMustAuthenticateSigningMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sendingTagsFontColor":{"type":"string","description":"The account-wide default font color to use for the content of the tab.\n\nValid values are:\n\n- `Black`\n- `BrightBlue`\n- `BrightRed`\n- `DarkGreen`\n- `DarkRed`\n- `Gold`\n- `Green`\n- `NavyBlue`\n- `Purple`\n- `White`"},"sendingTagsFontColorMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sendingTagsFontName":{"type":"string","description":"The account-wide default 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`"},"sendingTagsFontNameMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sendingTagsFontSize":{"type":"string","description":"The account-wide default font size used for the information in the tab:\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`"},"sendingTagsFontSizeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sendLockoutRecipientNotification":{"type":"string"},"sendLockoutRecipientNotificationMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sendToCertifiedDeliveryEnabled":{"type":"string","description":"When true,\nthe account can use the\ncertified deliveries recipient type."},"sendToCertifiedDeliveryEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sessionTimeout":{"type":"string","description":"The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes."},"sessionTimeoutMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"setRecipEmailLang":{"type":"string","description":"When **true,** senders can set the email language to use for\neach recipient.\n\n**Note:** Only Admin users can change this setting."},"setRecipEmailLangMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"setRecipSignLang":{"type":"string","description":"When **true,**\nsetting a unique language for a recipient\nnot only affects the email language, but also the signing\nlanguage they are presented with. When **false,** only the email will\nbe affected when the sender specifies a unique language for a\nrecipient.\n\n**Note:** Only Admin users can change this setting."},"setRecipSignLangMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"sharedTemplateFolders":{"type":"string","description":"Boolean that specifies whether an account can use Shared Template Folders."},"sharedTemplateFoldersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"showCompleteDialogInEmbeddedSession":{"type":"string","description":"Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions."},"showCompleteDialogInEmbeddedSessionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"showConditionalRoutingOnSend":{"type":"string","description":"When **true,** Conditional Routing options display to senders during the sending experience."},"showConditionalRoutingOnSendMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"showInitialConditionalFields":{"type":"string","description":"Boolean that specifies whether conditional field options are initially displayed (before a user makes entries)."},"showInitialConditionalFieldsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"showLocalizedWatermarks":{"type":"string","description":"Boolean that specifies whether localized watermarks are displayed."},"showLocalizedWatermarksMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"showMaskedFieldsWhenDownloadingDocumentAsSender":{"type":"string"},"showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"showTutorials":{"type":"string","description":"When **true,**\nshow tutorials."},"showTutorialsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signatureProviders":{"type":"array","items":{"type":"string"},"description":"Names of electronic or digital signature providers that can be used."},"signatureProvidersMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"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."},"signDateFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signDateTimeAccountLanguageOverride":{"type":"string"},"signDateTimeAccountLanguageOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signDateTimeAccountTimezoneOverride":{"type":"string"},"signDateTimeAccountTimezoneOverrideMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerAttachCertificateToEnvelopePDF":{"type":"string","description":"When **true,**\nthe Certificate of Completion is included in the PDF of the envelope documents\nwhen it is downloaded.\n\n**Note:** Only Admin users can change this setting."},"signerAttachCertificateToEnvelopePDFMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerAttachConcat":{"type":"string","description":"When **true,** signer attachments are added to the parent document\nthat contains the attachment.\nThe default behavior creates\na new document in the envelope for every signer attachment.\n\n**Note:** Only Admin users can change this setting."},"signerAttachConcatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerCanCreateAccount":{"type":"string","description":"When **true,**\na signer can create a Docusign account\nafter signing.\n\n**Note:** Only Admin users can change this setting."},"signerCanCreateAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerCanSignOnMobile":{"type":"string","description":"When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting."},"signerCanSignOnMobileMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerInSessionUseEnvelopeCompleteEmail":{"type":"string","description":"When **true,** an \"envelope complete\" email is sent to an in-session\n(embedded) or offline signer after Docusign processes the envelope\nif in-session emails are not suppressed.\n\n**Note:** Only Admin users can change this setting."},"signerInSessionUseEnvelopeCompleteEmailMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerLoginRequirements":{"type":"string","description":"Sets the login requirements for signers. Valid values are:\n\n- `login_not_required`: Signers are not required to log in.\n- `login_required_if_account_holder`: If the signer has a Docusign account,\nthey must log in to sign the document.\n- `login_required_per_session`: The sender cannot send an envelope to anyone\nwho does not have a Docusign account.\n- `login_required_per_envelope`: The sender cannot send an envelope to anyone\nwho does not have a Docusign account, and the signer must also log in for\neach envelope they will sign.\n\n**Note:** Only Admin users can change this setting. If you use Direct PowerForms\nor captive (embedded signers), the \"Account required\" settings are bypassed for\nthose signers. If your workflow requires that the signer have an account,\nyou should not use those methods."},"signerLoginRequirementsMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerMustHaveAccount":{"type":"string","description":"When **true,** senders can only send an envelope to a recipient\nthat has a Docusign account.\n\n**Note:** Only Account Administrators can change this setting."},"signerMustHaveAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerMustLoginToSign":{"type":"string","description":"When **true,**\nsigners must log in to the Docusign platform to sign an envelope.\n\n**Note:** Only Admin users can change this setting."},"signerMustLoginToSignMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signerShowSecureFieldInitialValues":{"type":"string","description":"When **true,** the initial values of all SecureFields are written\nto the document when it is sent.\n\n**Note:** Only Admin users can change this setting."},"signerShowSecureFieldInitialValuesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signingSessionTimeout":{"type":"string","description":"The number of minutes\nthat a signing session stays\nalive without any activity."},"signingSessionTimeoutMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signingUiVersion":{"type":"string","description":"Reserved for Docusign."},"signingUiVersionMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"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`"},"signTimeFormatMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"signTimeShowAmPm":{"type":"string","description":"When **true,**\nthe time shows the AM or PM indicator."},"signTimeShowAmPmMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"simplifiedSendingEnabled":{"type":"string","description":"When **true,** simplified sending is enabled for the account. The default value is **false.**"},"simplifiedSendingEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"singleSignOnEnabled":{"type":"string","description":"When **true,**\nsingle sign-on (SSO) is enabled."},"singleSignOnEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"skipAuthCompletedEnvelopes":{"type":"string","description":"When **true,**\ndo not require authentication prompt for viewing completed envelopes"},"skipAuthCompletedEnvelopesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"socialIdRecipAuth":{"type":"string","description":"When **true,**\nrecipients can use\n[social ids](https://support.docusign.com/guides/signer-authentication)\nwhen signing"},"socialIdRecipAuthMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"specifyDocumentVisibility":{"type":"string","description":"When **true,** senders can specify the visibility of the documents in an envelope at the recipient level."},"specifyDocumentVisibilityMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"startInAdvancedCorrect":{"type":"string","description":"When **true,**\nwhen initiating correction of an in-flight envelope\nthe sender starts in advanced correct mode."},"startInAdvancedCorrectMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustAccept":{"type":"string","description":"When **true,** account users must accept supplemental documents when signing."},"supplementalDocumentsMustAcceptMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustRead":{"type":"string","description":"When **true,** account users must both view and accept supplemental documents when signing."},"supplementalDocumentsMustReadMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"supplementalDocumentsMustView":{"type":"string","description":"When **true,** account users must view supplemental documents when signing."},"supplementalDocumentsMustViewMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"suppressCertificateEnforcement":{"type":"string","description":"Boolean that specifies whether or not API calls require a x509 cert in the header of the call."},"suppressCertificateEnforcementMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"tabAccountSettings":{"$ref":"#/components/schemas/tabAccountSettings"},"timezoneOffsetAPI":{"type":"string","description":"Specifies the time zone\nto use with the API.\n\nValid values are:\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`"},"timezoneOffsetAPIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"timezoneOffsetUI":{"type":"string","description":"Specifies the time zone\nto use in the UI.\n\nValid values are:\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`"},"timezoneOffsetUIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"universalSignatureOptIn":{"type":"string","description":"Reserved for Docusign."},"universalSignatureSkipPlatformSignature":{"type":"string"},"universalSignatureSkipPlatformSignatureMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useAccountLevelEmail":{"type":"string","description":"Reserved for Docusign."},"useAccountLevelEmailMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useConsumerDisclosure":{"type":"string","description":"When **true,** the account uses an Electronic Record and\nSignature Disclosure Statement.\n\n**Note:** Only Admin users can change this setting."},"useConsumerDisclosureMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useConsumerDisclosureWithinAccount":{"type":"string","description":"When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."},"useConsumerDisclosureWithinAccountMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useDerivedKeys":{"type":"string","description":"Reserved for Docusign."},"useDerivedKeysMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useDocuSignExpressSignerCertificate":{"type":"string","description":"When **true,**\nsigners\nare required to use Express Digital Signatures."},"useDocuSignExpressSignerCertificateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useEnvelopeSearchMixedMode":{"type":"string"},"useEnvelopeSearchMixedModeMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useMultiAppGroupsData":{"type":"string"},"useMultiAppGroupsDataMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useNewBlobForPdf":{"type":"string","description":"Reserved for Docusign."},"useNewBlobForPdfMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useNewEnvelopeSearch":{"type":"string"},"useNewEnvelopeSearchMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useNewEnvelopeSearchOnlyWhenSearchingAfterDate":{"type":"string"},"useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useNewEnvelopeSearchOnlyWithSearchTerm":{"type":"string"},"useNewEnvelopeSearchOnlyWithSearchTermMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useSAFESignerCertificates":{"type":"string","description":"When **true,**\nsigners are\nrequired to use SAFE digital signatures."},"useSAFESignerCertificatesMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"usesAPI":{"type":"string","description":"When **true,**\nthe account can use the API.\n\n**Note:** Only SysAdmin users can change this setting."},"usesAPIMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useSignatureProviderPlatform":{"type":"string","description":"Boolean that specifies whether the account uses the digital signature provider platform to eSign."},"useSignatureProviderPlatformMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"useSmartContractsV1":{"type":"string"},"validationsAllowed":{"type":"string","description":"Boolean that specifies whether validations on recipient email domains are allowed."},"validationsAllowedMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"validationsBrand":{"type":"string","description":"Valid values are:\n\n- `docusign`\n- `account`"},"validationsBrandMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"validationsCadence":{"type":"string","description":"Valid values are:\n\n- `none`\n- `monthly`"},"validationsCadenceMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"validationsEnabled":{"type":"string","description":"When **true,**\nenables validations."},"validationsEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"validationsReport":{"type":"string","description":"Valid values are:\n\n- `none`\n- `life_sciences_part11`"},"validationsReportMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"waterMarkEnabled":{"type":"string","description":"When **true,**\nthe\n[watermark feature](https://support.docusign.com/s/articles/How-do-I-manage-the-watermark-for-In-Process-envelopes-sent-from-my-account)\nis enabled for the account."},"waterMarkEnabledMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"writeReminderToEnvelopeHistory":{"type":"string","description":"When **true,**\nsent reminders are included in the envelope history."},"writeReminderToEnvelopeHistoryMetadata":{"$ref":"#/components/schemas/settingsMetadata"},"wurflMinAllowableScreenSize":{"type":"string","description":"The smallest screen allowed."},"wurflMinAllowableScreenSizeMetadata":{"$ref":"#/components/schemas/settingsMetadata"}},"description":"Contains account settings information. Used in requests to set property values. Used in responses to report property values.","title":"accountSettingsInformation"},"province":{"type":"object","properties":{"isoCode":{"type":"string"},"name":{"type":"string"}},"title":"province"},"country":{"type":"object","properties":{"isoCode":{"type":"string"},"name":{"type":"string"},"provinces":{"type":"array","items":{"$ref":"#/components/schemas/province"}},"provinceValidated":{"type":"string"}},"title":"country"},"accountAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The first line of the address. Maximum length: 100 characters."},"address2":{"type":"string","description":"The second line of the address. Maximum length: 100 characters."},"city":{"type":"string","description":"The city associated with the address. Maximum length: 40 characters."},"country":{"type":"string","description":"The country associated with the address. Maximum length: 50 characters."},"email":{"type":"string","description":"The email address associated with the account."},"fax":{"type":"string","description":"The fax number associated with the account."},"firstName":{"type":"string","description":"The first name of the user associated with the account. Maximum Length: 50 characters."},"lastName":{"type":"string","description":"The last name of the user associated with the account."},"phone":{"type":"string","description":"The phone number associated with the account."},"postalCode":{"type":"string","description":"The postal code associated with the address. Maximum length: 20 characters."},"state":{"type":"string","description":"The state or province associated with the address. Maximum length: 40 characters."},"supportedCountries":{"type":"array","items":{"$ref":"#/components/schemas/country"},"description":"An array of supported countries associated with the account."}},"description":"Contains information about the address associated with the account.","title":"accountAddress"},"creditCardInformation":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/addressInformation"},"cardLastDigits":{"type":"string"},"cardNumber":{"type":"string","description":"The credit card number."},"cardType":{"type":"string","description":"The type of credit card. Valid values are:\n\n- `visa`\n- `mastercard`\n- `amex`"},"cvNumber":{"type":"string","description":"The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs)."},"expirationMonth":{"type":"string","description":"The month that the credit card expires, expressed as a number from 1 to 12."},"expirationYear":{"type":"string","description":"The year in which the credit card expires, in 4-digit format."},"nameOnCard":{"type":"string","description":"The exact name as it appears on the credit card."},"tokenizedCard":{"type":"string"}},"description":"This object contains information about a credit card that is associated with an account.","title":"creditCardInformation"},"directDebitProcessorInformation":{"type":"object","properties":{"bankBranchCode":{"type":"string","description":"The branch code of the bank used for direct debit.\n\nMaximum Length: 10 characters."},"bankCheckDigit":{"type":"string","description":"The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account.\n\nMaximum Length: 4 characters."},"bankCode":{"type":"string","description":"The code or number that identifies the bank. This is also known as the sort code.\n\nExample: `200000`\n\nMaximum Length: 18 characters."},"bankName":{"type":"string","description":"The name of the direct debit bank.\n\nMaximum Length: 80 characters."},"bankTransferAccountName":{"type":"string","description":"The name on the direct debit bank account. This field is required for POST and PUT requests.\n\nMaximum Length: 60 characters."},"bankTransferAccountNumber":{"type":"string","description":"The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters."},"bankTransferType":{"type":"string","description":"Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are:\n\n- `DirectDebitUK`\n- `DirectEntryAU`\n- `SEPA`"},"country":{"type":"string","description":"The user's country. The system populates this value automatically."},"email":{"type":"string","description":"The email address of the user who is associated with the payment method. This field is required for POST and PUT requests.\n\nMaximum Length: 80 characters."},"firstName":{"type":"string","description":"The user's first name. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters."},"iBAN":{"type":"string","description":"The International Bank Account Number (IBAN).\n\nExample: `DE89370400440532013000`\n\nFor more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm).\n\n**Note:** This number will be obfuscated."},"lastName":{"type":"string","description":"The user's last name. This field is required for POST and PUT requests.\n\nMaximum Length: 70 characters."}},"description":"Contains information about a bank that processes a customer's direct debit payments.","title":"directDebitProcessorInformation"},"paymentProcessorInformation":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/addressInformation"},"billingAgreementId":{"type":"string","description":"The ID of the billing agreement."},"email":{"type":"string","description":"The email address associated with the payment processor."}},"title":"paymentProcessorInformation"},"addOn":{"type":"object","properties":{"active":{"type":"string","description":"Reserved for Docusign."},"addOnId":{"type":"string","description":"Reserved for Docusign."},"id":{"type":"string","description":"A unique ID for the Salesforce object."},"name":{"type":"string","description":"Reserved for Docusign."}},"description":"Contains information about add ons.","title":"addOn"},"currencyFeatureSetPrice":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Specifies the alternate ISO currency code for the account. "},"currencySymbol":{"type":"string","description":"Reserved for Docusign."},"envelopeFee":{"type":"string","description":"Reserved for Docusign."},"fixedFee":{"type":"string","description":"Reserved for Docusign."},"seatFee":{"type":"string","description":"Reserved for Docusign."}},"description":"Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.","title":"currencyFeatureSetPrice"},"featureSet":{"type":"object","properties":{"currencyFeatureSetPrices":{"type":"array","items":{"$ref":"#/components/schemas/currencyFeatureSetPrice"},"description":"Reserved for Docusign."},"envelopeFee":{"type":"string","description":"Reserved for Docusign."},"featureSetId":{"type":"string","description":"Reserved for Docusign."},"fixedFee":{"type":"string","description":"Reserved for Docusign."},"is21CFRPart11":{"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."},"name":{"type":"string","description":"Reserved for Docusign."},"seatFee":{"type":"string","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.","title":"featureSet"},"recipientDomain":{"type":"object","properties":{"active":{"type":"string"},"domainCode":{"type":"string"},"domainName":{"type":"string"},"recipientDomainId":{"type":"string"}},"title":"recipientDomain"},"planInformation":{"type":"object","properties":{"addOns":{"type":"array","items":{"$ref":"#/components/schemas/addOn"},"description":"Reserved for Docusign."},"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."},"freeTrialDaysOverride":{"type":"string","description":"Reserved for Docusign."},"planFeatureSets":{"type":"array","items":{"$ref":"#/components/schemas/featureSet"},"description":"Reserved for Docusign."},"planId":{"type":"string","description":"Docusign's ID for the account plan."},"recipientDomains":{"type":"array","items":{"$ref":"#/components/schemas/recipientDomain"}}},"description":"An object used to identify the features and attributes of the account being created.","title":"planInformation"},"referralInformation":{"type":"object","properties":{"advertisementId":{"type":"string","description":"A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only."},"enableSupport":{"type":"string","description":"When **true,** customer support is provided as part of the account plan."},"externalOrgId":{"type":"string","description":"An optional external ID for the referral."},"groupMemberId":{"type":"string"},"idType":{"type":"string"},"includedSeats":{"type":"string","description":"The number of seats (users) included in the plan."},"industry":{"type":"string","description":"The name of the industry associated with the referral.\n\nExample: `Accounting`"},"planStartMonth":{"type":"string"},"promoCode":{"type":"string"},"publisherId":{"type":"string"},"referralCode":{"type":"string"},"referrerName":{"type":"string","description":"The name of the referrer."},"saleDiscountAmount":{"type":"string","description":"Reserved for Docusign."},"saleDiscountFixedAmount":{"type":"string","description":"Reserved for Docusign."},"saleDiscountPercent":{"type":"string","description":"Reserved for Docusign."},"saleDiscountPeriods":{"type":"string","description":"Reserved for Docusign."},"saleDiscountSeatPriceOverride":{"type":"string","description":"Reserved for Docusign."},"shopperId":{"type":"string"}},"description":"A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.","title":"referralInformation"},"socialAccountInformation":{"type":"object","properties":{"email":{"type":"string","description":"The users email address."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"provider":{"type":"string","description":"The social account provider (Facebook, Yahoo, etc.)"},"socialId":{"type":"string","description":"The ID provided by the Socal Account."},"userName":{"type":"string","description":"The full user name for the account."}},"title":"socialAccountInformation"},"newAccountDefinition":{"type":"object","properties":{"accountName":{"type":"string","description":"The account name for the new account."},"accountSettings":{"$ref":"#/components/schemas/accountSettingsInformation"},"addressInformation":{"$ref":"#/components/schemas/accountAddress"},"creditCardInformation":{"$ref":"#/components/schemas/creditCardInformation"},"directDebitProcessorInformation":{"$ref":"#/components/schemas/directDebitProcessorInformation"},"distributorCode":{"type":"string","description":"The Distributor Code that you received from Docusign."},"distributorPassword":{"type":"string","description":"The password for the distributorCode."},"enablePreAuth":{"type":"string"},"envelopePartitionId":{"type":"string","description":"Reserved for Docusign."},"initialUser":{"$ref":"#/components/schemas/userInformation"},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"},"paymentProcessor":{"type":"string"},"paymentProcessorInformation":{"$ref":"#/components/schemas/paymentProcessorInformation"},"planInformation":{"$ref":"#/components/schemas/planInformation"},"processPayment":{"type":"string"},"referralInformation":{"$ref":"#/components/schemas/referralInformation"},"socialAccountInformation":{"$ref":"#/components/schemas/socialAccountInformation"},"taxExemptId":{"type":"string"}},"title":"newAccountDefinition"},"billingInvoiceItem":{"type":"object","properties":{"chargeAmount":{"type":"string","description":"Reserved for Docusign."},"chargeName":{"type":"string","description":"Reserved for Docusign."},"invoiceItemId":{"type":"string","description":"Reserved for Docusign."},"quantity":{"type":"string","description":"The quantity of envelopes to add to the account."},"taxAmount":{"type":"string"},"taxExemptAmount":{"type":"string"},"unitPrice":{"type":"string","description":"Reserved for Docusign."}},"description":"Contains information about an item on a billing invoice.","title":"billingInvoiceItem"},"billingInvoice":{"type":"object","properties":{"amount":{"type":"string","description":"The total amount of the purchase."},"balance":{"type":"string","description":"Reserved for Docusign."},"dueDate":{"type":"string","description":"Reserved for Docusign."},"invoiceId":{"type":"string","description":"Reserved for Docusign."},"invoiceItems":{"type":"array","items":{"$ref":"#/components/schemas/billingInvoiceItem"},"description":"Reserved for Docusign."},"invoiceNumber":{"type":"string","description":"Reserved for Docusign."},"invoiceUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve invoice information."},"nonTaxableAmount":{"type":"string"},"pdfAvailable":{"type":"string"},"taxableAmount":{"type":"string"}},"description":"Contains information about a billing invoice.","title":"billingInvoice"},"billingPlanPreview":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."},"invoice":{"$ref":"#/components/schemas/billingInvoice"},"isProrated":{"type":"string","description":"When **true,** the billing plan is prorated."},"subtotalAmount":{"type":"string"},"taxAmount":{"type":"string"},"totalAmount":{"type":"string"}},"description":"Information used to provide a preview of a billing plan.","title":"billingPlanPreview"},"newAccountSummary":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID associated with the envelope."},"accountIdGuid":{"type":"string","description":"The GUID associated with the account ID."},"accountName":{"type":"string","description":"The account name for the new account."},"apiPassword":{"type":"string","description":"Contains a token that can be used for authentication in API calls instead of using the user name and password."},"baseUrl":{"type":"string","description":"The URL that should be used for successive calls to this account. It includes the protocol (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."},"billingPlanPreview":{"$ref":"#/components/schemas/billingPlanPreview"},"userId":{"type":"string","description":"Specifies the user ID of the new user."}},"title":"newAccountSummary"},"Accounts_deleteaccount_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_deleteaccount_Response_200"},"captiveRecipient":{"type":"object","properties":{"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"email":{"type":"string","description":"The email address associated with the captive recipient."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"userName":{"type":"string","description":"The username associated with the captive recipient."}},"description":"This object contains details about a captive (embedded) recipient.","title":"captiveRecipient"},"captiveRecipientInformation":{"type":"object","properties":{"captiveRecipients":{"type":"array","items":{"$ref":"#/components/schemas/captiveRecipient"},"description":"A complex type containing information about one or more captive recipients."}},"description":"Contains information about captive (embedded) recipients.","title":"captiveRecipientInformation"},"accountInformation":{"type":"object","properties":{"accountIdGuid":{"type":"string","description":"The GUID associated with the account ID."},"accountName":{"type":"string","description":"The name of the current account."},"accountSettings":{"$ref":"#/components/schemas/accountSettingsInformation"},"allowTransactionRooms":{"type":"string","description":"When **true,** the transaction rooms feature exposed through the Workspaces API is enabled."},"billingPeriodDaysRemaining":{"type":"string","description":"Number of days remaining in the current billing period."},"billingPeriodEndDate":{"type":"string","description":"The billing period end date in UTC timedate format."},"billingPeriodEnvelopesAllowed":{"type":"string","description":"The number of envelopes that can be sent in the current billing period (can be unlimited)."},"billingPeriodEnvelopesSent":{"type":"string","description":"The number of envelopes that have been sent in the current billing period."},"billingPeriodStartDate":{"type":"string","description":"The billing period start date in UTC timedate format."},"billingProfile":{"type":"string","description":"Reserved for Docusign."},"brands":{"$ref":"#/components/schemas/brandsResponse"},"canUpgrade":{"type":"string","description":"When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."},"connectPermission":{"type":"string","description":"Value is \"full\" when Connect is enabled for this account."},"createdDate":{"type":"string","description":"The creation date of the account in UTC timedate format."},"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."},"currentPlanId":{"type":"string","description":"ID of the plan used to create this account."},"displayApplianceStartUrl":{"type":"string"},"displayApplianceUrl":{"type":"string"},"distributorCode":{"type":"string","description":"The code that identifies the billing plan groups and plans for the new account."},"docuSignLandingUrl":{"type":"string","description":"URL of the landing page used to create the account."},"dssValues":{"type":"object","additionalProperties":{"type":"string"}},"envelopeSendingBlocked":{"type":"string","description":"When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent."},"envelopeUnitPrice":{"type":"string","description":"The price of sending an envelope, represented in the account's local currency."},"externalAccountId":{"type":"string","description":"The Account ID displayed on the user's Account page."},"forgottenPasswordQuestionsCount":{"type":"string","description":" A complex element that contains up to four Question/Answer pairs for forgotten password information for a user."},"freeEnvelopeSendsRemainingForAdvancedDocGen":{"type":"integer"},"isDowngrade":{"type":"string","description":"When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"},"isFreeToTrialEligible":{"type":"string"},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"},"planClassification":{"type":"string","description":"Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free."},"planEndDate":{"type":"string","description":"The date that the current plan will end."},"planName":{"type":"string","description":"The name of the Billing Plan."},"planStartDate":{"type":"string","description":"The date that the Account started using the current plan."},"recipientDomains":{"type":"array","items":{"$ref":"#/components/schemas/recipientDomain"}},"seatsAllowed":{"type":"string","description":"The number of active users the account can have at one time."},"seatsInUse":{"type":"string","description":"The number of users currently active on the account."},"status21CFRPart11":{"type":"string","description":"The status of the account content per [Title 21 CFR Part 11](https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application). This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy."},"suspensionDate":{"type":"string","description":"The date on which the account was suspended."},"suspensionStatus":{"type":"string","description":"Indicates whether the account is currently suspended."},"useDisplayAppliance":{"type":"boolean"}},"description":"Contains account Information.","title":"accountInformation"},"billingDiscount":{"type":"object","properties":{"beginQuantity":{"type":"string","description":"Reserved for Docusign."},"discount":{"type":"string"},"endQuantity":{"type":"string"}},"title":"billingDiscount"},"billingPrice":{"type":"object","properties":{"beginQuantity":{"type":"string","description":"Reserved for Docusign."},"endQuantity":{"type":"string"},"unitPrice":{"type":"string","description":"Reserved for Docusign."}},"title":"billingPrice"},"billingCharge":{"type":"object","properties":{"allowedQuantity":{"type":"string","description":"Reserved for Docusign."},"blocked":{"type":"string","description":"Reserved for Docusign."},"chargeName":{"type":"string","description":"Provides information on what services the charge item is for.\n\nThe following table provides a description of the different chargeName values available at this time.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | IDÂ Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |"},"chargeType":{"type":"string","description":"Reserved for Docusign."},"chargeUnitOfMeasure":{"type":"string","description":"Reserved for Docusign."},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/billingDiscount"}},"firstEffectiveDate":{"type":"string"},"includedQuantity":{"type":"string"},"incrementalQuantity":{"type":"string","description":"Reserved for Docusign."},"lastEffectiveDate":{"type":"string"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/billingPrice"}},"unitPrice":{"type":"string","description":"Reserved for Docusign."},"usedQuantity":{"type":"string"}},"description":"Contains information about a billing charge.","title":"billingCharge"},"billingChargeResponse":{"type":"object","properties":{"billingChargeItems":{"type":"array","items":{"$ref":"#/components/schemas/billingCharge"},"description":"Reserved for Docusign."}},"description":"Defines a billing charge response object.","title":"billingChargeResponse"},"envelopePurgeConfiguration":{"type":"object","properties":{"applyPurgePolicyForUnaccountedRecipients":{"type":"string"},"purgeEnvelopes":{"type":"string","description":"When **true,** purging is enabled."},"purgeEnvelopesReceived":{"type":"string","description":"When true, document purging is enabled from received envelopes."},"redactPII":{"type":"string","description":"When **true,** the system also redacts personally identifiable information (PII) when purging documents from sent envelopes.\n\n**Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.**"},"redactPIIReceived":{"type":"string","description":"When true, the system also redacts personally identifiable information (PII) when purging documents from received envelopes."},"removeTabsAndEnvelopeAttachments":{"type":"string","description":"When **true,** the system also purges the tabs and attachments associated with the envelopes."},"retentionDays":{"type":"string","description":"The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`."}},"description":"Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ","title":"envelopePurgeConfiguration"},"notificationDefaultSettings":{"type":"object","properties":{"senderEmailNotifications":{"$ref":"#/components/schemas/senderEmailNotifications"},"signerEmailNotifications":{"$ref":"#/components/schemas/signerEmailNotifications"}},"description":"Contains details about the default notification settings for the envelope notifications that senders and signers receive.","title":"notificationDefaultSettings"},"notificationDefaults":{"type":"object","properties":{"apiEmailNotifications":{"$ref":"#/components/schemas/notificationDefaultSettings"},"emailNotifications":{"$ref":"#/components/schemas/notificationDefaultSettings"}},"title":"notificationDefaults"},"provisioningInformation":{"type":"object","properties":{"defaultConnectionId":{"type":"string"},"defaultPlanId":{"type":"string"},"distributorCode":{"type":"string","description":"The code that identifies the billing plan groups and plans for the new account."},"distributorPassword":{"type":"string","description":"The password for the distributorCode."},"passwordRuleText":{"type":"string"},"planPromotionText":{"type":"string"},"purchaseOrderOrPromAllowed":{"type":"string"}},"title":"provisioningInformation"},"sharedItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"shared":{"type":"string","description":"How the item is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`"},"user":{"$ref":"#/components/schemas/userInfo"}},"description":"Information about the shared item.","title":"sharedItem"},"memberGroupSharedItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"group":{"$ref":"#/components/schemas/group"},"shared":{"type":"string","description":"How the item is shared. One of:\n\n- `not_shared`: The item is not shared.\n\n- `shared_to`: The item is shared."}},"description":"Information about items shared among groups.","title":"memberGroupSharedItem"},"userSharedItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"shared":{"type":"string","description":"How the item is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`"},"user":{"$ref":"#/components/schemas/userInfo"}},"description":"Information about a shared item.","title":"userSharedItem"},"folderSharedItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"folderId":{"type":"string","description":"The ID of the folder."},"name":{"type":"string","description":"The name of the folder."},"owner":{"$ref":"#/components/schemas/userInfo"},"parentFolderId":{"type":"string","description":"The ID of the parent folder."},"parentFolderUri":{"type":"string","description":"The URI for the parent folder."},"shared":{"type":"string","description":"Indicates how the folder is shared. Valid values are:\n\n- `not_shared`\n- `shared_to`"},"sharedGroups":{"type":"array","items":{"$ref":"#/components/schemas/memberGroupSharedItem"},"description":"A list of groups that share the folder."},"sharedUsers":{"type":"array","items":{"$ref":"#/components/schemas/userSharedItem"},"description":"A list of users that share the folder."},"uri":{"type":"string","description":"A URI containing the user ID."},"user":{"$ref":"#/components/schemas/userInfo"}},"title":"folderSharedItem"},"templateSharedItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"owner":{"$ref":"#/components/schemas/userInfo"},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"shared":{"type":"string","description":"How the template is shared. One of:\n\n- `not_shared`\n- `shared_to`"},"sharedGroups":{"type":"array","items":{"$ref":"#/components/schemas/memberGroupSharedItem"},"description":"List of groups that share the template."},"sharedUsers":{"type":"array","items":{"$ref":"#/components/schemas/userSharedItem"},"description":"List of users that share the template."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "},"templateName":{"type":"string","description":"The name of the shared template."}},"description":"Information about shared templates.","title":"templateSharedItem"},"memberSharedItems":{"type":"object","properties":{"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/sharedItem"},"description":"List of information about shared envelopes."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folderSharedItem"},"description":"List of information about shared folders."},"templates":{"type":"array","items":{"$ref":"#/components/schemas/templateSharedItem"},"description":"List of information about shared templates."},"user":{"$ref":"#/components/schemas/userInfo"}},"description":"Information about shared items.","title":"memberSharedItems"},"accountSharedAccess":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID associated with the envelope."},"endPosition":{"type":"string","description":"The last index position in the result set."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"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`."},"sharedAccess":{"type":"array","items":{"$ref":"#/components/schemas/memberSharedItems"},"description":"A list of shared access information of envelope and templates for the users specified in the request."},"startPosition":{"type":"string","description":"The starting index position of the current result set."},"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`."}},"description":"Contains shared access information.","title":"accountSharedAccess"},"supportedLanguages":{"type":"object","properties":{"languages":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"A list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** Setting a language for a recipient affects only the Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nExample:\n\n```json\n{\n    \"languages\": [\n        {\n            \"name\": \"Arabic (ar)\",\n            \"value\": \"ar\"\n        },\n        {\n            \"name\": \"Bulgarian (bg)\",\n            \"value\": \"bg\"\n        },\n        .\n        .\n        .\n}\n```"}},"description":"A list of supported languages.","title":"supportedLanguages"},"fileType":{"type":"object","properties":{"fileExtension":{"type":"string"},"mimeType":{"type":"string","description":"The mime-type of a file type listed in a fileTypes collection."}},"title":"fileType"},"fileTypeList":{"type":"object","properties":{"fileTypes":{"type":"array","items":{"$ref":"#/components/schemas/fileType"},"description":"A collection of file types."}},"title":"fileTypeList"},"Accounts_Settings_PutSettings_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_Settings_PutSettings_Response_200"},"accountSeals":{"type":"object","properties":{"seals":{"type":"array","items":{"$ref":"#/components/schemas/sealIdentifier"}}},"title":"accountSeals"},"accountSignatureProviders":{"type":"object","properties":{"signatureProviders":{"type":"array","items":{"$ref":"#/components/schemas/accountSignatureProvider"},"description":"Names of electronic or digital signature providers that can be used."}},"title":"accountSignatureProviders"},"dateStampProperties":{"type":"object","properties":{"dateAreaHeight":{"type":"string","description":"The height of the rectangle."},"dateAreaWidth":{"type":"string","description":"The width of the rectangle."},"dateAreaX":{"type":"string","description":"The X axis position of the top-left corner."},"dateAreaY":{"type":"string","description":"The Y axis position of the top-left corner."}},"description":"Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.","title":"dateStampProperties"},"signatureGroup":{"type":"object","properties":{"groupId":{"type":"string","description":"The ID of the group being accessed."},"groupName":{"type":"string","description":"The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."},"rights":{"type":"string","description":"Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"}},"title":"signatureGroup"},"signatureUser":{"type":"object","properties":{"isDefault":{"type":"string","description":"Boolean that specifies whether the signature is the default signature for the user."},"rights":{"type":"string","description":"Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"},"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."},"userName":{"type":"string","description":"The name of the user."}},"title":"signatureUser"},"accountSignature":{"type":"object","properties":{"adoptedDateTime":{"type":"string","description":"The UTC date and time when the user adopted the signature."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"customField":{"type":"string"},"dateStampProperties":{"$ref":"#/components/schemas/dateStampProperties"},"disallowUserResizeStamp":{"type":"string","description":"When **true,** users may not resize the stamp."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"externalID":{"type":"string","description":"Optionally specify an external identifier for the user's signature."},"imageBase64":{"type":"string"},"imageType":{"type":"string","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"},"initials150ImageId":{"type":"string","description":"The ID of the user's initials image."},"initialsImageUri":{"type":"string","description":"The URI for retrieving the image of the user's initials."},"isDefault":{"type":"string","description":"Boolean that specifies whether the signature is the default signature for the user."},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"nrdsId":{"type":"string","description":"The National Association of Realtors (NAR) membership ID for a user who is a realtor."},"nrdsLastName":{"type":"string","description":"The realtor's last name."},"nrdsStatus":{"type":"string","description":"The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`"},"phoneticName":{"type":"string","description":"The phonetic spelling of the `signatureName`."},"signature150ImageId":{"type":"string","description":"The ID of the user's signature image."},"signatureFont":{"type":"string","description":"The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`"},"signatureGroups":{"type":"array","items":{"$ref":"#/components/schemas/signatureGroup"}},"signatureId":{"type":"string","description":"Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."},"signatureImageUri":{"type":"string","description":"An endpoint URI that you can use to retrieve the user's signature image."},"signatureInitials":{"type":"string","description":"Specifies the user's signature in initials format."},"signatureName":{"type":"string","description":"Specifies the user's signature name."},"signatureRights":{"type":"string","description":"The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`"},"signatureType":{"type":"string","description":"Specifies the type of signature."},"signatureUsers":{"type":"array","items":{"$ref":"#/components/schemas/signatureUser"}},"stampFormat":{"type":"string","description":"The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date."},"stampImageUri":{"type":"string","description":"The URI for retrieving the image of the user's stamp."},"stampSizeMM":{"type":"string","description":"The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."},"stampType":{"type":"string","description":"The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"},"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."}},"title":"accountSignature"},"accountSignaturesInformation":{"type":"object","properties":{"accountSignatures":{"type":"array","items":{"$ref":"#/components/schemas/accountSignature"}}},"title":"accountSignaturesInformation"},"Uncategorized_AccountSignatures_DeleteAccountSignature_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_AccountSignatures_DeleteAccountSignature_Response_200"},"signatureGroupDef":{"type":"object","properties":{"groupId":{"type":"string","description":"The ID of the group being accessed."},"rights":{"type":"string","description":"Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"}},"title":"signatureGroupDef"},"signatureUserDef":{"type":"object","properties":{"isDefault":{"type":"string","description":"Boolean that specifies whether the signature is the default signature for the user."},"rights":{"type":"string","description":"Indicates whether you are assigning or removing a signature from a user.\n\n- `read`: when you are assigning a new signature to a user.\n- `none`: when you are removing an existing signature from a 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."}},"title":"signatureUserDef"},"accountSignatureDefinition":{"type":"object","properties":{"dateStampProperties":{"$ref":"#/components/schemas/dateStampProperties"},"disallowUserResizeStamp":{"type":"string","description":"When **true,** users may not resize the stamp."},"externalID":{"type":"string","description":"Optionally specify an external identifier for the user's signature."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"},"isDefault":{"type":"string","description":"Boolean that specifies whether the signature is the default signature for the user."},"nrdsId":{"type":"string","description":"The National Association of Realtors (NAR) membership ID for a user who is a realtor."},"nrdsLastName":{"type":"string","description":"The realtor's last name."},"phoneticName":{"type":"string","description":"The phonetic spelling of the `signatureName`."},"signatureFont":{"type":"string","description":"The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`"},"signatureGroups":{"type":"array","items":{"$ref":"#/components/schemas/signatureGroupDef"}},"signatureId":{"type":"string","description":"Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."},"signatureInitials":{"type":"string","description":"Specifies the user's signature in initials format."},"signatureName":{"type":"string","description":"Specifies the user's signature name."},"signatureType":{"type":"string","description":"Specifies the type of signature."},"signatureUsers":{"type":"array","items":{"$ref":"#/components/schemas/signatureUserDef"}},"stampFormat":{"type":"string","description":"The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date."},"stampSizeMM":{"type":"string","description":"The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."}},"title":"accountSignatureDefinition"},"watermark":{"type":"object","properties":{"displayAngle":{"type":"string","description":"The display angle of the watermark. Valid values:\n\n- 0 (horizontal)\n- 45 (diagonal)\n- 90 (vertical)"},"enabled":{"type":"string","description":"When **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied."},"font":{"type":"string","description":"The watermark's font. Valid values:\n\n- `courier`\n- `helvetica`\n- `timesnewroman`"},"fontColor":{"type":"string","description":"The watermark's font color. Valid values:\n\n- `black`\n- `blue`\n- `red`\n- `gray`\n- `yellow`"},"fontSize":{"type":"string","description":"The watermark's font size. Valid values:\n\n- `30`\n- `40`\n- `50`\n- `60`\n- `70`\n- `80`\n- `90`"},"id":{"type":"string","description":"The ID of the watermark."},"imageBase64":{"type":"string","description":"The Base64 representation of the watermark image.\n\nThis property is read-only."},"transparency":{"type":"string","description":"The transparency percentage of the watermark image. Valid values:\n\n- `5`\n- `10`\n- `15`\n- `20`\n- `25`\n- `30`\n- `35`\n- `40`\n- `45`"},"watermarkText":{"type":"string","description":"The text for the watermark."}},"title":"watermark"},"authorizationUser":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID."},"email":{"type":"string","description":"The email address of the authorization user."},"name":{"type":"string","description":"The name of the authorization user."},"userId":{"type":"string","description":"The ID of the authorization user."}},"title":"authorizationUser"},"userAuthorizationCreateRequest":{"type":"object","properties":{"agentUser":{"$ref":"#/components/schemas/authorizationUser"},"endDate":{"type":"string","description":"The UTC DateTime to end the authorization. The default value is the max UTC value (`9999-12-31T23:59:59.0000000+00:00`)."},"permission":{"type":"string","description":"The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/share-access-to-mailbox-or-envelopes) to grant the agent. Valid values:\n\n- `Send`\n- `Manage`\n- `Sign`\n- `Edit`\n\nThis property is required."},"startDate":{"type":"string","description":"The UTC DateTime to initiate the authorization. The default value is the current date and time."},"taskSource":{"type":"string"},"taskType":{"type":"string"}},"description":"The request object to create a user authorization.","title":"userAuthorizationCreateRequest"},"userAuthorization":{"type":"object","properties":{"agentUser":{"$ref":"#/components/schemas/authorizationUser"},"authorizationId":{"type":"string","description":"The ID of the user authorization."},"created":{"type":"string","description":"The UTC DateTime when the workspace user authorization was created."},"createdBy":{"type":"string","description":"The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`"},"endDate":{"type":"string","description":"The UTC DateTime at which the authorization will expire."},"modified":{"type":"string","description":"The UTC DateTime when the workspace user authorization was last updated."},"modifiedBy":{"type":"string","description":"The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`"},"permission":{"type":"string","description":"The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/share-access-to-mailbox-or-envelopes) to grant the agent. Valid values:\n\n- `Send`\n- `Manage`\n- `Sign`\n- `Edit`\n\nThis property is required."},"principalUser":{"$ref":"#/components/schemas/authorizationUser"},"startDate":{"type":"string","description":"The UTC DateTime at which the authorization will start."},"taskSource":{"type":"string"},"taskType":{"type":"string"}},"description":"A complex object describing a user authorization.","title":"userAuthorization"},"userAuthorizationCreateRequestWithId":{"type":"object","properties":{"agentUser":{"$ref":"#/components/schemas/authorizationUser"},"authorizationId":{"type":"string","description":"The ID of the user authorization. This property is required to update an existing authorization."},"endDate":{"type":"string","description":"The UTC DateTime to end the authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`."},"permission":{"type":"string","description":"The [permission level](/docs/esign-rest-api/esign101/concepts/envelopes/share-access-to-mailbox-or-envelopes) to grant the agent. Valid values:\n\n- `Send`\n- `Manage`\n- `Sign`\n- `Edit`\n\nThis property is required."},"startDate":{"type":"string","description":"The UTC DateTime to initiate the authorization. The default value is the current date and time."},"taskSource":{"type":"string"},"taskType":{"type":"string"}},"description":"A user authorizations to create or update.","title":"userAuthorizationCreateRequestWithId"},"userAuthorizationsRequest":{"type":"object","properties":{"authorizations":{"type":"array","items":{"$ref":"#/components/schemas/userAuthorizationCreateRequestWithId"},"description":"The list of user authorizations to create and/or update."},"sendNotification":{"type":"string"}},"description":"An object that describes the user authorizations to create or update.","title":"userAuthorizationsRequest"},"userAuthorizationWithStatus":{"type":"object","properties":{"authorization":{"$ref":"#/components/schemas/userAuthorization"},"errorMessage":{"type":"string"},"success":{"type":"string"}},"title":"userAuthorizationWithStatus"},"userAuthorizationsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/userAuthorizationWithStatus"}}},"title":"userAuthorizationsResponse"},"Uncategorized_UserAuthorization_DeleteUserAuthorization_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_UserAuthorization_DeleteUserAuthorization_Response_200"},"userAuthorizationsDeleteRequest":{"type":"object","properties":{"authorizations":{"type":"array","items":{"type":"string"}},"sendNotification":{"type":"string"}},"title":"userAuthorizationsDeleteRequest"},"userAuthorizationIdWithStatus":{"type":"object","properties":{"authorizationId":{"type":"string"},"errorMessage":{"type":"string"},"success":{"type":"string"}},"title":"userAuthorizationIdWithStatus"},"userAuthorizationsDeleteResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/userAuthorizationIdWithStatus"}}},"title":"userAuthorizationsDeleteResponse"},"userAuthorizations":{"type":"object","properties":{"authorizations":{"type":"array","items":{"$ref":"#/components/schemas/userAuthorization"}},"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."}},"title":"userAuthorizations"},"userAuthorizationUpdateRequest":{"type":"object","properties":{"endDate":{"type":"string","description":"The end date for the user authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`."},"startDate":{"type":"string","description":"The start date for the user authorization. The default value is the current date and time."}},"description":"The request object to update a user authorization.","title":"userAuthorizationUpdateRequest"},"Accounts_ENoteConfiguration_DeleteENoteConfiguration_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Accounts_ENoteConfiguration_DeleteENoteConfiguration_Response_200"},"eNoteConfiguration":{"type":"object","properties":{"apiKey":{"type":"string"},"connectConfigured":{"type":"string","description":"When **false,** the user must configure Connect and eOriginal for the integration to work."},"eNoteConfigured":{"type":"string","description":"When **false,** the user must configure eNote for the feature to work.\n\n**Note:** In the account settings, `allowENoteEOriginal` must be **true**\nto make changes to the configuration."},"organization":{"type":"string","description":"The name of the organization."},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"userName":{"type":"string","description":"The user's username."}},"description":"This object contains information used to configure [eNote](https://www.docusign.com/products/enote) functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly.","title":"eNoteConfiguration"},"favoriteTemplatesContentItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"favoritedDate":{"type":"string","description":"Time at which the template was marked as favorite."},"templateId":{"type":"string","description":"The ID of the template."}},"title":"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","description":"The number of templates successfully updated by the call. This property is read-only."}},"title":"favoriteTemplatesInfo"},"accountIdentityVerificationResponse":{"type":"object","properties":{"identityVerification":{"type":"array","items":{"$ref":"#/components/schemas/accountIdentityVerificationWorkflow"},"description":"Specifies the ID Verification workflow applied on an envelope by workflow ID.\nSee the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.\nNote that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."}},"title":"accountIdentityVerificationResponse"},"appStoreProduct":{"type":"object","properties":{"marketPlace":{"type":"string"},"productId":{"type":"string","description":"The Product ID from the AppStore."}},"description":"Contains information about an APP store product.","title":"appStoreProduct"},"creditCardTypes":{"type":"object","properties":{"cardTypes":{"type":"array","items":{"type":"string"},"description":"An array containing supported credit card types."}},"title":"creditCardTypes"},"currencyPlanPrice":{"type":"object","properties":{"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."},"currencySymbol":{"type":"string","description":"Specifies the currency symbol.\nValid values:\n\n- `AED`\n\"د.إ\"\n- `AFN`\n\"؋\"\n- `ALL`\n\"L\"\n- `AMD`\n\"֏\"\n- `ANG`\n\"ƒ\"\n- `AOA`\n\"Kz\"\n- `ARS`\n\"$\"\n- `AUD`\n\"$\"\n- `AWG`\n\"ƒ\"\n- `AZN`\n\"₼\"\n- `BAM`\n\"KM\"\n- `BBD`\n\"$\"\n- `BDT`\n\"৳\"\n- `BGN`\n\"лв\"\n- `BHD`\n\".د.ب\"\n- `BIF`\n\"FBu\"\n- `BMD`\n\"$\"\n- `BND`\n\"$\"\n- `BOB`\n\"$b\"\n- `BOV`\n\"BOV\"\n- `BRL`\n\"R$\"\n- `BSD`\n\"$\"\n- `BTN`\n\"Nu.\"\n- `BWP`\n\"P\"\n- `BYN`\n\"Br\"\n- `BYR`\n\"Br\"\n- `BZD`\n\"BZ$\"\n- `CAD`\n\"$\"\n- `CDF`\n\"FC\"\n- `CHE`\n\"CHE\"\n- `CHF`\n\"CHF\"\n- `CHW`\n\"CHW\"\n- `CLF`\n\"CLF\"\n- `CLP`\n\"$\"\n- `CNY`\n\"¥\"\n- `COP`\n\"$\"\n- `COU`\n\"COU\"\n- `CRC`\n\"₡\"\n- `CUC`\n\"$\"\n- `CUP`\n\"₱\"\n- `CVE`\n\"$\"\n- `CZK`\n\"Kč\"\n- `DJF`\n\"Fdj\"\n- `DKK`\n\"kr\"\n- `DOP`\n\"RD$\"\n- `DZD`\n\"دج\"\n- `EGP`\n\"£\"\n- `ERN`\n\"Nfk\"\n- `ETB`\n\"Br\"\n- `EUR`\n\"€\"\n- `FJD`\n\"$\"\n- `FKP`\n\"£\"\n- `GBP`\n\"£\"\n- `GEL`\n\"₾\"\n- `GHS`\n\"GH₵\"\n- `GIP`\n\"£\"\n- `GMD`\n\"D\"\n- `GNF`\n\"FG\"\n- `GTQ`\n\"Q\"\n- `GYD`\n\"$\"\n- `HKD`\n\"$\"\n- `HNL`\n\"L\"\n- `HRK`\n\"kn\"\n- `HTG`\n\"G\"\n- `HUF`\n\"Ft\"\n- `IDR`\n\"Rp\"\n- `ILS`\n\"₪\"\n- `INR`\n\"₹\"\n- `IQD`\n\"ع.د\"\n- `IRR`\n\"﷼\"\n- `ISK`\n\"kr\"\n- `JMD`\n\"J$\"\n- `JOD`\n\"JD\"\n- `JPY`\n\"¥\"\n- `KES`\n\"KSh\"\n- `KGS`\n\"лв\"\n- `KHR`\n\"៛\"\n- `KMF`\n\"CF\"\n- `KPW`\n\"₩\"\n- `KRW`\n\"₩\"\n- `KWD`\n\"KD\"\n- `KYD`\n\"$\"\n- `KZT`\n\"₸\"\n- `LAK`\n\"₭\"\n- `LBP`\n\"£\"\n- `LKR`\n\"₨\"\n- `LRD`\n\"$\"\n- `LSL`\n\"M\"\n- `LYD`\n\"LD\"\n- `MAD`\n\"MAD\"\n- `MDL`\n\"lei\"\n- `MGA`\n\"Ar\"\n- `MKD`\n\"ден\"\n- `MMK`\n\"K\"\n- `MNT`\n\"₮\"\n- `MOP`\n\"MOP$\"\n- `MRO`\n\"UM\"\n- `MUR`\n\"₨\"\n- `MVR`\n\"Rf\"\n- `MWK`\n\"MK\"\n- `MXN`\n\"$\"\n- `MXV`\n\"MXV\"\n- `MYR`\n\"RM\"\n- `MZN`\n\"MT\"\n- `NAD`\n\"$\"\n- `NGN`\n\"₦\"\n- `NIO`\n\"C$\"\n- `NOK`\n\"kr\"\n- `NPR`\n\"₨\"\n- `NZD`\n\"$\"\n- `OMR`\n\"﷼\"\n- `PAB`\n\"B/.\"\n- `PEN`\n\"S/.\"\n- `PGK`\n\"K\"\n- `PHP`\n\"₱\"\n- `PKR`\n\"₨\"\n- `PLN`\n\"zł\"\n- `PYG`\n\"Gs\"\n- `QAR`\n\"﷼\"\n- `RON`\n\"lei\"\n- `RSD`\n\"Дин.\"\n- `RUB`\n\"₽\"\n- `RWF`\n\"R₣\"\n- `SAR`\n\"﷼\"\n- `SBD`\n\"$\"\n- `SCR`\n\"₨\"\n- `SDG`\n\"ج.س.\"\n- `SEK`\n\"kr\"\n- `SGD`\n\"S$\"\n- `SHP`\n\"£\"\n- `SLL`\n\"Le\"\n- `SOS`\n\"S\"\n- `SRD`\n\"$\"\n- `SSP`\n\"£\"\n- `STD`\n\"Db\"\n- `SVC`\n\"$\"\n- `SYP`\n\"£\"\n- `SZL`\n\"E\"\n- `THB`\n\"฿\"\n- `TJS`\n\"SM\"\n- `TMT`\n\"T\"\n- `TND`\n\"د.ت\"\n- `TOP`\n\"T$\"\n- `TRY`\n\"₺\"\n- `TTD`\n\"TT$\"\n- `TWD`\n\"NT$\"\n- `TZS`\n\"TSh\"\n- `UAH`\n\"₴\"\n- `UGX`\n\"USh\"\n- `USD`\n\"$\"\n- `USN`\n\"$\"\n- `UYI`\n\"UYI\"\n- `UYU`\n\"$U\"\n- `UZS`\n\"лв\"\n- `VEF`\n\"Bs\"\n- `VND`\n\"₫\"\n- `VUV`\n\"VT\"\n- `WST`\n\"WS$\"\n- `XAF`\n\"FCFA\"\n- `XAG`\n\"XAG\" Silver\n- `XAU`\n\"XAU\" Gold\n- `XBA`\n\"XBA\" Bond Markets Units European Composite Unit (EURCO)\n- `XBB`\n\"XBB\" European Monetary Unit (E.M.U.-6)\n- `XBC`\n\"XBC\" European Unit of Account 9(E.U.A.-9)\n- `XBD`\n\"XBD\" European Unit of Account 17(E.U.A.-17)\n- `XCD`\n\"$\"\n- `XDR`\n\"XDR\" &#125; `<br> // Special Drawing Rights (SDRs)`\nunits of account for IMF\n- `XOF`\n\"CFA\"\n- `XPD`\n\"XPD\" Palladium\n- `XPF`\n\"₣\"\n- `XPT`\n\"XPT\" Platinum\n- `XSU`\n\"Sucre\"\n- `XTS`\n\"XTS\" Reserved for testing purposes\n- `XUA`\n\"XUA\"\n- `XXX`\n\"XXX\" Denotes transaction involving no currency\n- `YER`\n\"﷼\"\n- `ZAR`\n\"R\"\n- `ZMW`\n\"ZK\"\n- `ZWL`\n\"$\""},"perSeatPrice":{"type":"string","description":"The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`"},"supportedCardTypes":{"$ref":"#/components/schemas/creditCardTypes"},"supportIncidentFee":{"type":"string","description":"The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"},"supportPlanFee":{"type":"string","description":"The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"}},"title":"currencyPlanPrice"},"seatDiscount":{"type":"object","properties":{"beginSeatCount":{"type":"string","description":"Reserved for Docusign."},"discountPercent":{"type":"string","description":"The percent of the discount.\n\nExample: `\"0.00\"`"},"endSeatCount":{"type":"string","description":"Reserved for Docusign."}},"description":"This object contains information about a seat discount.","title":"seatDiscount"},"billingPlan":{"type":"object","properties":{"appStoreProducts":{"type":"array","items":{"$ref":"#/components/schemas/appStoreProduct"},"description":"Reserved for Docusign."},"currencyPlanPrices":{"type":"array","items":{"$ref":"#/components/schemas/currencyPlanPrice"},"description":"Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set."},"enableSupport":{"type":"string","description":"When **true,** customer support is provided as part of the account plan."},"includedSeats":{"type":"string","description":"The number of seats (users) included in the plan."},"otherDiscountPercent":{"type":"string","description":"Any other percentage discount for the plan.\n\nExample: `\"0.00\"`"},"paymentCycle":{"type":"string","description":"The payment cycle associated with the plan. Valid values: Monthly or Annually."},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"},"perSeatPrice":{"type":"string","description":"The per seat price for the plan."},"planClassification":{"type":"string","description":"Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free."},"planFeatureSets":{"type":"array","items":{"$ref":"#/components/schemas/featureSet"},"description":"Reserved for Docusign."},"planId":{"type":"string","description":"Docusign's ID for the account plan."},"planName":{"type":"string","description":"The name of the Billing Plan."},"seatDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/seatDiscount"},"description":"A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`."},"supportIncidentFee":{"type":"string","description":"The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"},"supportPlanFee":{"type":"string","description":"The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"}},"description":"Contains information about a billing plan.","title":"billingPlan"},"billingPlanResponse":{"type":"object","properties":{"billingPlan":{"$ref":"#/components/schemas/billingPlan"},"successorPlans":{"type":"array","items":{"$ref":"#/components/schemas/billingPlan"},"description":"A list of billing plans that the current billing plan can be rolled into."}},"description":"Defines a billing plan response object.","title":"billingPlanResponse"},"downgradePlanUpdateResponse":{"type":"object","properties":{"accountPaymentMethod":{"type":"string","description":"The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n-"},"discountApplied":{"type":"string"},"downgradeEffectiveDate":{"type":"string"},"downgradePaymentCycle":{"type":"string"},"downgradePlanId":{"type":"string"},"downgradePlanName":{"type":"string"},"downgradeRequestStatus":{"type":"string"},"message":{"type":"string"},"productId":{"type":"string","description":"The Product ID from the AppStore."},"promoCode":{"type":"string"},"saleDiscount":{"type":"string"},"saleDiscountPeriods":{"type":"string","description":"Reserved for Docusign."},"saleDiscountType":{"type":"string"}},"title":"downgradePlanUpdateResponse"},"accountBillingPlan":{"type":"object","properties":{"addOns":{"type":"array","items":{"$ref":"#/components/schemas/addOn"},"description":"Reserved for Docusign."},"appStoreReceiptExpirationDate":{"type":"string"},"appStoreReceiptPurchaseDate":{"type":"string"},"canCancelRenewal":{"type":"string","description":"Reserved for Docusign."},"canUpgrade":{"type":"string","description":"When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."},"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use for the account."},"downgradePlanInformation":{"$ref":"#/components/schemas/downgradePlanUpdateResponse"},"enableSupport":{"type":"string","description":"When **true,** customer support is provided as part of the account plan."},"includedSeats":{"type":"string","description":"The number of seats (users) included in the plan."},"incrementalSeats":{"type":"string","description":"Reserved for Docusign."},"isDowngrade":{"type":"string","description":"When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"},"notificationType":{"type":"string"},"otherDiscountPercent":{"type":"string","description":" Any other percentage discount for the plan. "},"paymentCycle":{"type":"string","description":"The payment cycle associated with the plan. Valid values:\n\n- `Monthly`\n- `Annually`"},"paymentMethod":{"type":"string","description":"The payment method used with the plan. Valid values: CreditCard, PurchaseOrder, Premium, or Freemium."},"perSeatPrice":{"type":"string","description":"The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`"},"planClassification":{"type":"string","description":"Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free."},"planFeatureSets":{"type":"array","items":{"$ref":"#/components/schemas/featureSet"},"description":"A complex type that sets the feature sets for the account. It contains the following information (all string content):\n\n* currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set.\n* envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true).\n* featureSetId - A unique ID for the feature set.\n* fixedFee - A one-time fee associated with the plan (when isEnabled=true).\n* isActive - Specifies whether the feature set is actively set as part of the plan.\n* isEnabled - Specifies whether the feature set is actively enabled as part of the plan.\n* name - The name of the feature set.\n* seatFee - An incremental seat cost for seat-based plans (when isEnabled=true).\n"},"planId":{"type":"string","description":"Docusign's ID for the account plan."},"planName":{"type":"string","description":"The name of the Billing Plan."},"planStartDate":{"type":"string","description":"The date that the Account started using the current plan."},"productId":{"type":"string","description":"The Product ID from the AppStore."},"renewalDate":{"type":"string"},"renewalStatus":{"type":"string","description":"The renewal status for the account. Valid values are:\n\n- `auto`: The account automatically renews.\n- `queued_for_close`: The account will be closed at the `billingPeriodEndDate`.\n- `queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`.\n\n**Note:** For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."},"seatDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/seatDiscount"},"description":"A complex type that contains any seat discount information. Valid values:\n\n- `BeginSeatCount`\n- `EndSeatCount`\n- `SeatDiscountPercent`"},"subscriptionStartDate":{"type":"string"},"supportIncidentFee":{"type":"string","description":"The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"},"supportPlanFee":{"type":"string","description":"The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"},"taxExemptId":{"type":"string"}},"description":"Contains information about an account billing plan.","title":"accountBillingPlan"},"downgradeRequestInformation":{"type":"object","properties":{"downgradeRequestCreation":{"type":"string"},"downgradeRequestProductId":{"type":"string"},"downgradeRequestStatus":{"type":"string"}},"title":"downgradeRequestInformation"},"billingEntityInformationResponse":{"type":"object","properties":{"billingProfile":{"type":"string","description":"The type of billing method on the account. Valid values are:\n\n- `direct`\n- `web`"},"entityName":{"type":"string"},"externalEntityId":{"type":"string"},"isExternallyBilled":{"type":"string"}},"title":"billingEntityInformationResponse"},"accountBillingPlanResponse":{"type":"object","properties":{"billingAddress":{"$ref":"#/components/schemas/accountAddress"},"billingAddressIsCreditCardAddress":{"type":"string","description":"When **true,** the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different."},"billingPlan":{"$ref":"#/components/schemas/accountBillingPlan"},"creditCardInformation":{"$ref":"#/components/schemas/creditCardInformation"},"directDebitProcessorInformation":{"$ref":"#/components/schemas/directDebitProcessorInformation"},"downgradePlanInformation":{"$ref":"#/components/schemas/downgradePlanUpdateResponse"},"downgradeRequestInformation":{"$ref":"#/components/schemas/downgradeRequestInformation"},"entityInformation":{"$ref":"#/components/schemas/billingEntityInformationResponse"},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"},"paymentProcessorInformation":{"$ref":"#/components/schemas/paymentProcessorInformation"},"referralInformation":{"$ref":"#/components/schemas/referralInformation"},"successorPlans":{"type":"array","items":{"$ref":"#/components/schemas/billingPlan"},"description":"A list of billing plans that the current billing plan can be rolled into."},"taxExemptId":{"type":"string"}},"description":"Defines an account billing plan response object.","title":"accountBillingPlanResponse"},"downgradRequestBillingInfoResponse":{"type":"object","properties":{"downgradePlanInformation":{"$ref":"#/components/schemas/downgradePlanUpdateResponse"},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"}},"title":"downgradRequestBillingInfoResponse"},"billingPlansResponse":{"type":"object","properties":{"billingPlans":{"type":"array","items":{"$ref":"#/components/schemas/billingPlan"},"description":"Reserved for Docusign."}},"description":"Defines a billing plans response object.","title":"billingPlansResponse"},"purchasedEnvelopesInformation":{"type":"object","properties":{"amount":{"type":"string","description":"The total amount of the purchase."},"appName":{"type":"string","description":"The AppName of the client application."},"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase."},"platform":{"type":"string","description":"The Platform of the client application"},"productId":{"type":"string","description":"The Product ID from the AppStore."},"quantity":{"type":"string","description":"The quantity of envelopes to add to the account."},"receiptData":{"type":"string","description":"The encrypted Base64 encoded receipt data."},"storeName":{"type":"string","description":"The name of the AppStore."},"transactionId":{"type":"string","description":"Specifies the Transaction ID from the AppStore."}},"title":"purchasedEnvelopesInformation"},"Billing_PurchasedEnvelopes_PutPurchasedEnvelopes_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Billing_PurchasedEnvelopes_PutPurchasedEnvelopes_Response_200"},"appStoreReceipt":{"type":"object","properties":{"downgradeProductId":{"type":"string"},"isDowngradeCancellation":{"type":"string"},"productId":{"type":"string","description":"The Product ID from the AppStore."},"receiptData":{"type":"string","description":"Reserved for Docusign."}},"description":"Contains information about an APP store receipt.","title":"appStoreReceipt"},"billingPlanInformation":{"type":"object","properties":{"appStoreReceipt":{"$ref":"#/components/schemas/appStoreReceipt"},"billingAddress":{"$ref":"#/components/schemas/accountAddress"},"creditCardInformation":{"$ref":"#/components/schemas/creditCardInformation"},"directDebitProcessorInformation":{"$ref":"#/components/schemas/directDebitProcessorInformation"},"downgradeReason":{"type":"string","description":"(Optional) The user's reason for downgrading their billing plan."},"enablePreAuth":{"type":"string"},"enableSupport":{"type":"string","description":"When **true,** customer support is provided as part of the account plan."},"includedSeats":{"type":"string","description":"The number of seats (users) included in the plan."},"incrementalSeats":{"type":"string","description":"Reserved for Docusign."},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"},"paymentProcessor":{"type":"string"},"paymentProcessorInformation":{"$ref":"#/components/schemas/paymentProcessorInformation"},"planInformation":{"$ref":"#/components/schemas/planInformation"},"processPayment":{"type":"string"},"referralInformation":{"$ref":"#/components/schemas/referralInformation"},"renewalStatus":{"type":"string","description":"The renewal status of the account. Possible values are:\n\n- `auto`: The account automatically renews.\n- `queued_for_close`: The account will be closed at the billingPeriodEndDate.\n- queued_for_downgrade`: The account will be downgraded at the` billingPeriodEndDate`."},"saleDiscountAmount":{"type":"string","description":"Reserved for Docusign."},"saleDiscountFixedAmount":{"type":"string","description":"Reserved for Docusign."},"saleDiscountPercent":{"type":"string","description":"Reserved for Docusign."},"saleDiscountPeriods":{"type":"string","description":"Reserved for Docusign."},"saleDiscountSeatPriceOverride":{"type":"string","description":"Reserved for Docusign."},"taxExemptId":{"type":"string"}},"description":"This object contains details about a billing plan.","title":"billingPlanInformation"},"billingPlanUpdateResponse":{"type":"object","properties":{"accountPaymentMethod":{"type":"string","description":"The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n-"},"billingPlanPreview":{"$ref":"#/components/schemas/billingPlanPreview"},"currencyCode":{"type":"string","description":"Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."},"includedSeats":{"type":"string","description":"The number of seats (users) included in the plan."},"paymentCycle":{"type":"string","description":"The payment cycle associated with the plan. Valid values:\n\n- `Monthly`\n- `Annually`"},"paymentMethod":{"type":"string","description":"The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"},"planId":{"type":"string","description":"Docusign's ID for the account plan."},"planName":{"type":"string","description":"The name of the billing plan used for the account.\n\nExamples:\n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`"}},"description":"Defines a billing plan update response object.","title":"billingPlanUpdateResponse"},"downgradeBillingPlanInformation":{"type":"object","properties":{"downgradeEventType":{"type":"string"},"planInformation":{"$ref":"#/components/schemas/planInformation"},"promoCode":{"type":"string"},"saleDiscount":{"type":"string"},"saleDiscountPeriods":{"type":"string","description":"Reserved for Docusign."},"saleDiscountType":{"type":"string"}},"title":"downgradeBillingPlanInformation"},"billingInvoicesResponse":{"type":"object","properties":{"billingInvoices":{"type":"array","items":{"$ref":"#/components/schemas/billingInvoice"},"description":"Reserved for Docusign."},"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."},"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."}},"description":"Defines a billing invoice response object.","title":"billingInvoicesResponse"},"billingInvoicesSummary":{"type":"object","properties":{"accountBalance":{"type":"string"},"billingInvoices":{"type":"array","items":{"$ref":"#/components/schemas/billingInvoice"},"description":"Reserved for Docusign."},"currencyCode":{"type":"string","description":"The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code."},"pastDueBalance":{"type":"string"},"paymentAllowed":{"type":"string"}},"title":"billingInvoicesSummary"},"billingPaymentRequest":{"type":"object","properties":{"paymentAmount":{"type":"string","description":"The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices."}},"title":"billingPaymentRequest"},"billingPayment":{"type":"object","properties":{"amount":{"type":"string","description":"Reserved for Docusign."},"invoiceId":{"type":"string","description":"Reserved for Docusign."},"paymentId":{"type":"string","description":"The ID of the payment."}},"description":"Contains information on a billing plan.","title":"billingPayment"},"billingPaymentResponse":{"type":"object","properties":{"billingPayments":{"type":"array","items":{"$ref":"#/components/schemas/billingPayment"},"description":"Reserved for Docusign."}},"description":"Defines an billing payment response object.","title":"billingPaymentResponse"},"billingPaymentItem":{"type":"object","properties":{"amount":{"type":"string","description":"The total amount of the purchase."},"description":{"type":"string","description":"A sender-defined description of the line item."},"paymentDate":{"type":"string"},"paymentId":{"type":"string","description":"The ID of the payment."},"paymentNumber":{"type":"string","description":"When **true,** a PDF version of the invoice is available.\n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."}},"description":"Defines a billing payment request object.","title":"billingPaymentItem"},"billingPaymentsResponse":{"type":"object","properties":{"billingPayments":{"type":"array","items":{"$ref":"#/components/schemas/billingPaymentItem"},"description":"Reserved for Docusign."},"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."},"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."}},"description":"Defines a billing payments response object.","title":"billingPaymentsResponse"},"bulkSendingCopyCustomField":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom field."},"value":{"type":"string","description":"The value of the custom field."}},"description":"This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.","title":"bulkSendingCopyCustomField"},"bulkSendingCopyDocGenFormFieldRowValue":{"type":"object","properties":{"docGenFormFieldList":{"type":"array","items":{"$ref":"#/components/schemas/bulksendingCopyDocGenFormField"}}},"title":"bulkSendingCopyDocGenFormFieldRowValue"},"bulksendingCopyDocGenFormField":{"type":"object","properties":{"name":{"type":"string"},"rowValues":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingCopyDocGenFormFieldRowValue"}},"value":{"type":"string","description":"Specifies the value of the tab. "}},"title":"bulksendingCopyDocGenFormField"},"bulkSendingCopyPrefillTab":{"type":"object","properties":{"initialValue":{"type":"string","description":"The original value of the tab."},"tabLabel":{"type":"string","description":"The label string associated with the tab."}},"title":"bulkSendingCopyPrefillTab"},"propertyMetadata":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"},"description":"An array of option strings supported by this setting."},"rights":{"type":"string","description":"Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"}},"description":"Metadata about a property.","title":"propertyMetadata"},"recipientEmailNotification":{"type":"object","properties":{"emailBody":{"type":"string","description":"The body of the email message."},"emailBodyMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailSubject":{"type":"string","description":"The subject line for the email notification."},"emailSubjectMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"supportedLanguage":{"type":"string","description":"The language to use for the standard email format and signing view for a recipient.\n\nFor example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** This setting affects only Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nTo retrieve the possible values, use the [Accounts::listSupportedLanguages](/docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/) method."},"supportedLanguageMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.","title":"recipientEmailNotification"},"addressInformationInput":{"type":"object","properties":{"addressInformation":{"$ref":"#/components/schemas/addressInformation"},"displayLevelCode":{"type":"string","description":"Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay"},"receiveInResponse":{"type":"string","description":"A Boolean value that specifies whether the information must be returned in the response."}},"description":"Contains address input information.","title":"addressInformationInput"},"dobInformationInput":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"Specifies the recipient's date, month, and year of birth."},"displayLevelCode":{"type":"string","description":"Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay"},"receiveInResponse":{"type":"string","description":"A Boolean value that specifies whether the information must be returned in the response."}},"description":"Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse","title":"dobInformationInput"},"ssn4InformationInput":{"type":"object","properties":{"displayLevelCode":{"type":"string","description":"Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay"},"receiveInResponse":{"type":"string","description":"A Boolean value that specifies whether the information must be returned in the response."},"ssn4":{"type":"string","description":"The last four digits of the recipient's Social Security Number (SSN)."}},"title":"ssn4InformationInput"},"ssn9InformationInput":{"type":"object","properties":{"displayLevelCode":{"type":"string","description":"Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay"},"ssn9":{"type":"string","description":"The recipient's full Social Security Number (SSN)."}},"title":"ssn9InformationInput"},"idCheckInformationInput":{"type":"object","properties":{"addressInformationInput":{"$ref":"#/components/schemas/addressInformationInput"},"dobInformationInput":{"$ref":"#/components/schemas/dobInformationInput"},"ssn4InformationInput":{"$ref":"#/components/schemas/ssn4InformationInput"},"ssn9InformationInput":{"$ref":"#/components/schemas/ssn9InformationInput"}},"description":"A complex element that contains input information related to a recipient ID check.","title":"idCheckInformationInput"},"recipientIdentityPhoneNumber":{"type":"object","properties":{"countryCode":{"type":"string","description":"The numeric country calling code for the phone number. For example, the country calling code for the US and Canada is 1. For the UK, the country calling code is 44.\n\nDo not include the + symbol."},"countryCodeLock":{"type":"string"},"countryCodeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"extension":{"type":"string","description":"The telephone extension, if any."},"extensionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"number":{"type":"string","description":"The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`."},"numberMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"title":"recipientIdentityPhoneNumber"},"recipientIdentityInputOption":{"type":"object","properties":{"name":{"type":"string"},"phoneNumberList":{"type":"array","items":{"$ref":"#/components/schemas/recipientIdentityPhoneNumber"}},"stringValue":{"type":"string"},"valueType":{"type":"string"}},"title":"recipientIdentityInputOption"},"recipientIdentityVerification":{"type":"object","properties":{"hasAutoAttachedRiskAssessment":{"type":"string"},"inputOptions":{"type":"array","items":{"$ref":"#/components/schemas/recipientIdentityInputOption"}},"workflowId":{"type":"string","description":"ID of the Identity Verification worklow used to verify recipients' identity.\n\nThis ID must match one of the [workflowId](/docs/esign-rest-api/reference/accounts/identityverifications/list/) available to your account."},"workflowIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"workflowLabel":{"type":"string"}},"description":"Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/)\nmethod in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.","title":"recipientIdentityVerification"},"recipientPhoneAuthentication":{"type":"object","properties":{"recipMayProvideNumber":{"type":"string","description":"Boolean. When **true,** the recipient can supply a phone number their choice."},"recipMayProvideNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recordVoicePrint":{"type":"string","description":"Reserved for Docusign."},"recordVoicePrintMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"senderProvidedNumbers":{"type":"array","items":{"type":"string"},"description":"An array containing a list of phone numbers that the recipient can use for SMS text authentication."},"senderProvidedNumbersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validateRecipProvidedNumber":{"type":"string","description":"Reserved for Docusign."},"validateRecipProvidedNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A complex type that contains the elements:\n\n- `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n- `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n- `recordVoicePrint`: Reserved for Docusign.\n- `validateRecipProvidedNumber`: Reserved for Docusign.","title":"recipientPhoneAuthentication"},"recipientSignatureProviderOptions":{"type":"object","properties":{"cpfNumber":{"type":"string","description":"Reserved for Docusign."},"cpfNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"oneTimePassword":{"type":"string","description":"A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field."},"oneTimePasswordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signerRole":{"type":"string","description":"The role or capacity of the signing recipient. Examples: Manager, Approver, etc."},"signerRoleMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sms":{"type":"string","description":"The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."},"smsMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)","title":"recipientSignatureProviderOptions"},"recipientSignatureProvider":{"type":"object","properties":{"sealDocumentsWithTabsOnly":{"type":"string","description":"By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed.\n\nIf using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature, set this value to `false` for the notary recipient, and set it to `false` or omit it for the signer recipient."},"sealName":{"type":"string","description":"Indicates the name of the electronic seal to apply on documents."},"signatureProviderName":{"type":"string","description":"The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method.\n\nExample: `universalsignaturepen_default`\n\nIf using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature, set this value to `ds_authority_idv` for the notary recipient, and set it to `universalsignaturepen_imageonly` or omit it for the signer recipient."},"signatureProviderNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signatureProviderOptions":{"$ref":"#/components/schemas/recipientSignatureProviderOptions"}},"description":"An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).\n","title":"recipientSignatureProvider"},"recipientSMSAuthentication":{"type":"object","properties":{"senderProvidedNumbers":{"type":"array","items":{"type":"string"},"description":"An array containing a list of phone numbers that the recipient can use for SMS text authentication."},"senderProvidedNumbersMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Contains the element senderProvidedNumbers which is an Array  of phone numbers the recipient can use for SMS text authentication.","title":"recipientSMSAuthentication"},"socialAuthentication":{"type":"object","properties":{"authentication":{"type":"string","description":"Reserved for Docusign."}},"title":"socialAuthentication"},"bulkSendingCopyTab":{"type":"object","properties":{"initialValue":{"type":"string","description":"The initial value that you want to assign to the tab."},"tabLabel":{"type":"string","description":"The label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nMaximum Length: 500 characters."}},"description":"A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.","title":"bulkSendingCopyTab"},"bulkSendingCopyRecipient":{"type":"object","properties":{"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."},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"email":{"type":"string","description":"The recipient's email address."},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"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]]`"},"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."},"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."},"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."},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identificationMethod":{"type":"string"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"name":{"type":"string"},"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."},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"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`."},"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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"},"roleName":{"type":"string","description":"The name of the role associated with the recipient.\n\n**Note:** Every recipient must be assigned either a `recipientId` or a `roleName` but not both. You cannot use `roleName` and `recipientId` in the same list."},"signerName":{"type":"string","description":"The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters."},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"smsAuthentication":{"$ref":"#/components/schemas/recipientSMSAuthentication"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"tabs":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingCopyTab"},"description":"A list of tabs associated with the recipient. In a bulk send request, each of these recipient tabs must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.\n\nYou can use the following types of tabs to match bulk send recipients to an envelope:\n\n- Text tabs\n- Radio group tabs (where the name of the `radioGroup` on the envelope is used as the `tabLabel` in the bulk send list)\n- List tabs"}},"description":"This object contains details about a bulk send recipient.","title":"bulkSendingCopyRecipient"},"bulkSendingCopy":{"type":"object","properties":{"customFields":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingCopyCustomField"},"description":"The custom fields for this copy of the envelope.\n\n**Note:** These custom fields must also be included in the original envelope or template that you want to send."},"docGenFormFields":{"type":"array","items":{"$ref":"#/components/schemas/bulksendingCopyDocGenFormField"}},"emailBlurb":{"type":"string","description":"The email body for this copy of the envelope."},"emailSubject":{"type":"string","description":"The email subject line for this copy of the envelope.\n\nFor information about adding merge field information to the email subject,\nsee [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."},"prefillTabs":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingCopyPrefillTab"},"description":"Specifies a collection of prefill tabs to apply to each copy in a bulk send operation. Use this property to set envelope-level values for prefill tabs. Currently, only text tabs are supported; radio and list tabs are not supported.\n\nThe `tabLabel` value must exactly match a prefill tab label on the envelope or template.\n\nA prefill tab can have an empty string value, but its `initialValue` cannot be null. If you do not need prefill tabs, omit this property or set it to an empty array; do not set it to null.\n\nValidate `initialValue` against the expected format for the tab. Validation occurs during envelope creation and can cause envelope generation to fail.\n\nRecipients can typically modify prefilled values unless the corresponding tab is read-only on the master or draft envelope.\n\nThis property applies to every copy in the bulk send batch."},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingCopyRecipient"},"description":"Information about the recipients associated with this copy of the envelope."}},"description":"This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.","title":"bulkSendingCopy"},"bulkSendingList":{"type":"object","properties":{"bulkCopies":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingCopy"},"description":"An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information."},"listId":{"type":"string","description":"The GUID of the bulk send list."},"name":{"type":"string","description":"The name of the bulk send list."}},"description":"This object contains the details for the bulk send list.","title":"bulkSendingList"},"bulkSendRequest":{"type":"object","properties":{"batchName":{"type":"string","description":"The human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object."},"envelopeOrTemplateId":{"type":"string","description":"The GUID of the envelope or template that you want to send in bulk."}},"description":"This object contains information about the envelope or template that you want to send in bulk.","title":"bulkSendRequest"},"bulkSendResponse":{"type":"object","properties":{"batchId":{"type":"string","description":"A batch identifier that you can use to get the status of the batch."},"batchName":{"type":"string"},"batchSize":{"type":"string","description":"The total number of items in the batch being queried."},"envelopeOrTemplateId":{"type":"string","description":"The GUID of the envelope or template that was sent."},"errorDetails":{"type":"array","items":{"type":"string"},"description":"A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests."},"errors":{"type":"array","items":{"type":"string"},"description":"A list of errors that occurred. This information is intended to be parsed by machine."},"queueLimit":{"type":"string"},"totalQueued":{"type":"string"}},"description":"The object contains the response to a bulk send request.","title":"bulkSendResponse"},"bulkSendTestResponse":{"type":"object","properties":{"canBeSent":{"type":"boolean","description":"When **true,** the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend: createBulkSendRequest](/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/) method.\n\n**Note:** This property is only returned in responses and ignored in requests."},"validationErrorDetails":{"type":"array","items":{"type":"string"},"description":"Human-readable details about any validation errors that occurred."},"validationErrors":{"type":"array","items":{"type":"string"},"description":"A list of validation errors that were encountered during the bulk send test.\n\n**Note:** This information is intended to be parsed by machine."}},"description":"This object contains the results of a bulk send test.","title":"bulkSendTestResponse"},"bulkSendingListSummary":{"type":"object","properties":{"bulkSendListId":{"type":"string","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list."},"createdByUser":{"type":"string","description":"The GUID of the user who created the bulk send list."},"createdDate":{"type":"string","description":"The UTC DateTime that the bulk send list was created."},"name":{"type":"string","description":"The name of the bulk send list."}},"description":"This object contains basic information about a bulk send list.","title":"bulkSendingListSummary"},"bulkSendingListSummaries":{"type":"object","properties":{"bulkListSummaries":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendingListSummary"},"description":"An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user."}},"description":"This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.","title":"bulkSendingListSummaries"},"bccEmailAddress":{"type":"object","properties":{"bccEmailAddressId":{"type":"string","description":"Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. \n \nExample: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address."},"email":{"type":"string","description":"Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.\n\nMaximum of length: 100 characters. "}},"description":"Contains information about the BCC email address.","title":"bccEmailAddress"},"emailSettings":{"type":"object","properties":{"bccEmailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/bccEmailAddress"},"description":"An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note:** Only users with the `canManageAccount` setting set to **true** can use this option.\n\nDocusign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope.\n\n**Example:** if your account has BCC for Email Archive set up for the email address [archive@mycompany.com](mailto:archive@mycompany.com) and you send an envelope using the BCC Email Override to send a BCC email to [salesarchive@mycompany.com](mailto:salesarchive@mycompany.com), then a copy of the envelope is only sent to the [salesarchive@mycompany.com](mailto:salesarchive@mycompany.com) email address."},"replyEmailAddressOverride":{"type":"string","description":"The Reply To email address to use for email replies, instead of the one that is configured at the account level. Docusign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters."},"replyEmailNameOverride":{"type":"string","description":"The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters."}},"description":"A complex element that allows  the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT**: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.","title":"emailSettings"},"attachment":{"type":"object","properties":{"accessControl":{"type":"string","description":"Valid values are `sender` and `senderAndAllRecipients`."},"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"attachmentType":{"type":"string","description":"Specifies the type of the attachment for the recipient."},"data":{"type":"string","description":"A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."},"label":{"type":"string","description":"A label for the attachment. Potential values include:\n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property."},"name":{"type":"string","description":"The name of the attachment."},"remoteUrl":{"type":"string","description":"The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads."}},"description":"Contains information about an attachment.","title":"attachment"},"envelopeCustomMetadata":{"type":"object","properties":{"envelopeCustomMetadataDetails":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"}}},"title":"envelopeCustomMetadata"},"signatureType":{"type":"object","properties":{"isDefault":{"type":"string","description":"When **true,** the signature type is the default type."},"type":{"type":"string","description":"The type of signature. Valid values are:\n\n- `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that Docusign uses.\n- `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [Docusign Signature Appliance](/docs/dsa-api/).\n\nFor more information, see [Standards Based Signatures](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)."}},"description":"This object contains information about the type of signature.","title":"signatureType"},"docGenSyntaxError":{"type":"object","properties":{"errorCode":{"type":"string","description":"A code associated with the error condition."},"message":{"type":"string","description":"The error message."},"tagIdentifier":{"type":"string","description":"The tag that caused the syntax error.\nSee [Document Generation Syntax](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ftc1679700030026.html)\nto learn more about document generation syntax rules."}},"description":"Describes document generation errors.","title":"docGenSyntaxError"},"connectedObjectDetails":{"type":"object","properties":{"recordId":{"type":"string"}},"title":"connectedObjectDetails"},"DocGenFormFieldFilter":{"type":"object","properties":{},"title":"DocGenFormFieldFilter"},"docGenFormat":{"type":"object","properties":{"expression":{"type":"string"},"locale":{"type":"string"}},"title":"docGenFormat"},"docGenFormFieldOption":{"type":"object","properties":{"description":{"type":"string","description":"Description of the selectable option."},"label":{"type":"string","description":"The label for the selectable option."},"selected":{"type":"string","description":"When **true,** the option is selected."},"value":{"type":"string","description":"Specifies the value of the option. This is the value of the form field when this option is selected."}},"description":"Specifies an individual option setting when type is `Select`.","title":"docGenFormFieldOption"},"docGenFormFieldRowValue":{"type":"object","properties":{"docGenFormFieldList":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormField"},"description":"The sender fields in each row of the table.\n\nFor GET requests, the `label`, `type`, `required`, and `name` properties will be returned.\n\nFor POST requests, supply the `name` and `value` for each child object. These correspond to the values in each column."}},"description":"An object representing a row of a dynamic table.","title":"docGenFormFieldRowValue"},"docGenFormFieldValidation":{"type":"object","properties":{"errorMessage":{"type":"string","description":"The error message when validation fails."},"expression":{"type":"string","description":"The expression used to validate values."}},"description":"Describes how values are validated.","title":"docGenFormFieldValidation"},"docGenFormField":{"type":"object","properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormField"}},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"defaultValue":{"type":"string"},"description":{"type":"string","description":"A description of the field. Displayed with the label."},"filter":{"$ref":"#/components/schemas/DocGenFormFieldFilter"},"format":{"$ref":"#/components/schemas/docGenFormat"},"fullyQualifiedPath":{"type":"string","description":"Reserved for Docusign use. This value is returned in the `getEnvelopeDocGenFormFields` response but should not be included in `updateEnvelopeDocGenFormFields` requests."},"hidden":{"type":"boolean"},"label":{"type":"string","description":"A label displayed near the field."},"name":{"type":"string","description":"The name of the sender field.\n\nRequired for PUT requests."},"options":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormFieldOption"},"description":"When `type` is `Select`, this array describes the available options."},"order":{"type":"string","description":"Not currently used."},"predefinedValidation":{"type":"string","description":"Reserved for Docusign."},"readOnly":{"type":"boolean"},"required":{"type":"string","description":"When **true,** the field is required."},"rowValues":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormFieldRowValue"},"description":"For fields of type `TableRow`, this property represents the sender fields in the row.\n\nFor GET requests, this array contains a single `docGenFormFieldRowValue` object. That object contains a list of sender fields that will appear in each row.\n\nFor PUT requests, you must supply a `docGenFormFieldRowValue` object for each row in the table. This populates the data in the table."},"type":{"type":"string","description":"The kind of data the sender field holds. Valid values:\n\n- `TextBox`\n- `Date`\n- `Number`\n- `Select`\n- `TableRow`"},"validation":{"$ref":"#/components/schemas/docGenFormFieldValidation"},"value":{"type":"string","description":"The value of the sender field.\n\nFor PUT requests, you must supply either this property (for all fields except `TableRow` types) or `rowValues` (for `TableRow` fields)."}},"description":"The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT). When used with [DocumentGeneration: updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) (PUT), the `name` and `value` / `rowValues` properties are required and any other values are ignored.","title":"docGenFormField"},"page":{"type":"object","properties":{"dpi":{"type":"string","description":"The number of dots per inch used for the page image."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"height":{"type":"string","description":"The height of the page in pixels.\nMust be an integer."},"imageBytes":{"type":"string","description":"The number of image bytes."},"mimeType":{"type":"string","description":"The MIME type."},"pageId":{"type":"string","description":"The ID of the page."},"sequence":{"type":"string","description":"The sequence of the page in the document, or page number."},"width":{"type":"string","description":"The width of the page in pixels.\nMust be an integer."}},"description":"Description of a page of a document.","title":"page"},"envelopeDocument":{"type":"object","properties":{"addedRecipientIds":{"type":"array","items":{"type":"string"},"description":"If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only."},"agreementType":{"type":"string"},"agreementTypeSource":{"type":"string"},"attachmentTabId":{"type":"string","description":"If this document is an attachment to another document in the envelope, this is the ID of the attachment tab it is associated with on the other document."},"authoritativeCopy":{"type":"string","description":"When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"},"authoritativeCopyMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"availableDocumentTypes":{"type":"array","items":{"$ref":"#/components/schemas/signatureType"}},"containsPdfFormFields":{"type":"string","description":"When **true,** the document has editable form fields that are made available through a PDF format."},"display":{"type":"string","description":"This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n- `modal`\n\nThe document is shown as a supplement action strip\nand can be viewed, downloaded, or printed in a modal window.\nThis is the recommended value for supplemental documents.\n\n- `inline`\n\nThe document is shown in the normal signing window.\nThis value is not used with supplemental documents,\nbut is the default value for all other documents."},"displayMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"docGenDocumentStatus":{"type":"string"},"docGenErrors":{"type":"array","items":{"$ref":"#/components/schemas/docGenSyntaxError"}},"docGenFormFields":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormField"}},"documentBase64":{"type":"string","description":"The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."},"documentFields":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"An object containing information about the custom fields on the document."},"documentId":{"type":"string","description":"The ID of the document that the tab is placed on. This value must refer to the ID of an existing document."},"documentIdGuid":{"type":"string","description":"The GUID of the document."},"documentTemplateId":{"type":"string"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"hasDigitalSignature":{"type":"string"},"includeInDownload":{"type":"string","description":"When **true,**\nthe document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/).\nThe default value is **true.**"},"includeInDownloadMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"isAceGenDocument":{"type":"string"},"isDocGenDocument":{"type":"string"},"isEdited":{"type":"string"},"isExternallyAvailable":{"type":"string"},"isFlattened":{"type":"string"},"name":{"type":"string","description":"The document's file name.\n\nExample: `Q1-Report.docx`"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"order":{"type":"string","description":"The order in which to sort the results.\n\nValid values are:\n\n- `asc`: Ascending order.\n- `desc`: Descending order."},"pages":{"type":"array","items":{"$ref":"#/components/schemas/page"},"description":"An array of page objects that contain information about the pages in the document."},"signerMustAcknowledge":{"type":"string","description":"Sets how the signer interacts with the supplemental document.\nValid values:\n\n- `no_interaction`\n\nNo recipient action is required.\n\n- `view`\n\nThe recipient is required to view the document.\n\n- `accept`\n\nThe recipient is required to accept the document by selecting accept during signing, but is not required to view the document.\n\n- `view_accept`\n\nThe recipient is required to view and accept the document."},"signerMustAcknowledgeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sizeBytes":{"type":"string"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"type":{"type":"string","description":"The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"},"uri":{"type":"string","description":"The URI for retrieving the document."}},"description":"This object contains details about the envelope document.","title":"envelopeDocument"},"envelopeMetadata":{"type":"object","properties":{"allowAdvancedCorrect":{"type":"string","description":"Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature."},"allowCorrect":{"type":"string","description":"Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information."},"enableSignWithNotary":{"type":"string","description":"Specifies if Docusign eNotary service is enabled for the envelope."}},"title":"envelopeMetadata"},"filter":{"type":"object","properties":{"actionRequired":{"type":"string","description":"When **true,** the current user needs to take action on the item."},"expires":{"type":"string","description":"The number of days a sent envelope remains active before it expires."},"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`"},"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."},"isTemplate":{"type":"string","description":"When **true,** the item is a template."},"order":{"type":"string","description":"The order in which to sort the results.\n\nValid values are:\n\n- `asc`: Ascending order.\n- `desc`: Descending order."},"orderBy":{"type":"string","description":"The field used to sort the results.\n\nExample: `Created`"},"searchTarget":{"type":"string","description":"Reserved for Docusign."},"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."},"status":{"type":"string","description":"The status of the envelope. By default, all statuses are returned.\n\nFor details, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/)."},"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."}},"description":"Use this object to create a filtered view of the items in a folder.","title":"filter"},"recipientPhoneNumber":{"type":"object","properties":{"countryCode":{"type":"string","description":"The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`,\n\nDo not include the `+` symbol."},"countryCodeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"number":{"type":"string","description":"The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`."},"numberMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Describes the recipient phone number.","title":"recipientPhoneNumber"},"recipientAdditionalNotification":{"type":"object","properties":{"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"secondaryDeliveryMethod":{"type":"string","description":"The secondary delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"secondaryDeliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"secondaryDeliveryStatus":{"type":"string","description":"The status of the delivery. This property is read-only.\n\nOne of:\n\n- `autoresponded`\n- `optedout`\n- `limitreached`"}},"description":"Describes an additional notification method.","title":"recipientAdditionalNotification"},"consentDetails":{"type":"object","properties":{"consentKey":{"type":"string"},"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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"signerConsentStatus":{"type":"string"}},"title":"consentDetails"},"documentVisibility":{"type":"object","properties":{"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."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"recipientId":{"type":"string","description":"The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object."},"rights":{"type":"string","description":"Indicates whether the document is editable:\n\n- `editable`\n- `read_only`"},"visible":{"type":"string","description":"When **true,** the document is visible to the recipient."}},"description":"This object configures a recipient's read/write access to a document.","title":"documentVisibility"},"recipientProofFile":{"type":"object","properties":{"hasIdentityAttempts":{"type":"string"},"isInProofFile":{"type":"string","description":"Indicates whether a proof file is available for this recipient."}},"description":"The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/)","title":"recipientProofFile"},"recipientAttachment":{"type":"object","properties":{"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"attachmentType":{"type":"string","description":"Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"},"data":{"type":"string","description":"A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."},"label":{"type":"string","description":"An optional label for the attachment."},"name":{"type":"string","description":"The name of the attachment."},"remoteUrl":{"type":"string","description":"The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads."}},"title":"recipientAttachment"},"eventResult":{"type":"object","properties":{"eventTimestamp":{"type":"string","description":"Date/time of the event."},"failureDescription":{"type":"string","description":"Reason for failure, if the event failed."},"status":{"type":"string","description":"Event status."},"vendorFailureStatusCode":{"type":"string","description":"Failure status code, if the event failed."}},"description":"Information about the result of an event.","title":"eventResult"},"authenticationStatus":{"type":"object","properties":{"accessCodeResult":{"$ref":"#/components/schemas/eventResult"},"ageVerifyResult":{"$ref":"#/components/schemas/eventResult"},"anySocialIDResult":{"$ref":"#/components/schemas/eventResult"},"facebookResult":{"$ref":"#/components/schemas/eventResult"},"googleResult":{"$ref":"#/components/schemas/eventResult"},"identityVerificationResult":{"$ref":"#/components/schemas/eventResult"},"idLookupResult":{"$ref":"#/components/schemas/eventResult"},"idQuestionsResult":{"$ref":"#/components/schemas/eventResult"},"linkedinResult":{"$ref":"#/components/schemas/eventResult"},"liveIDResult":{"$ref":"#/components/schemas/eventResult"},"ofacResult":{"$ref":"#/components/schemas/eventResult"},"openIDResult":{"$ref":"#/components/schemas/eventResult"},"phoneAuthResult":{"$ref":"#/components/schemas/eventResult"},"salesforceResult":{"$ref":"#/components/schemas/eventResult"},"signatureProviderResult":{"$ref":"#/components/schemas/eventResult"},"smsAuthResult":{"$ref":"#/components/schemas/eventResult"},"sTANPinResult":{"$ref":"#/components/schemas/eventResult"},"twitterResult":{"$ref":"#/components/schemas/eventResult"},"yahooResult":{"$ref":"#/components/schemas/eventResult"}},"description":"A complex element that contains information about a user's authentication status.","title":"authenticationStatus"},"featureAvailableMetadata":{"type":"object","properties":{"availabilty":{"type":"string"},"featureName":{"type":"string"}},"title":"featureAvailableMetadata"},"agent":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"email":{"type":"string","description":"The email ID of the agent. Notification of the document to sign is sent to this email id.\n\nMaximum length: 100 characters."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name. Maximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"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."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"description":"Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.","title":"agent"},"delegationInfo":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"userAuthorizationId":{"type":"string"},"userId":{"type":"string"}},"title":"delegationInfo"},"offlineAttributes":{"type":"object","properties":{"accountEsignId":{"type":"string","description":"Reserved for Docusign."},"deviceModel":{"type":"string","description":"Reserved for Docusign."},"deviceName":{"type":"string","description":"Reserved for Docusign."},"gpsLatitude":{"type":"string","description":"Reserved for Docusign."},"gpsLongitude":{"type":"string","description":"Reserved for Docusign."},"offlineSigningHash":{"type":"string","description":"Reserved for Docusign."}},"description":"Reserved for Docusign.","title":"offlineAttributes"},"recipientSignatureInformation":{"type":"object","properties":{"fontStyle":{"type":"string","description":"The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`"},"signatureInitials":{"type":"string","description":"Specifies the user's signature in initials format."},"signatureName":{"type":"string","description":"Specifies the user's signature name."}},"description":"Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.","title":"recipientSignatureInformation"},"connectedData":{"type":"object","properties":{"propertyName":{"type":"string","description":"An identifier describing input data for a connected field."},"supportedOperation":{"type":"string","description":"The type of operation used to verify a connected field."},"supportedUri":{"type":"string","description":"The URI used to verify a connected field."},"typeName":{"type":"string","description":"The name of the verification type used in a connected field."},"typeSystemNamespace":{"type":"string","description":"The type of operation used during verification."}},"title":"connectedData"},"connectionInstance":{"type":"object","properties":{"connectionKey":{"type":"string","description":"A key used to identify the connection instance of an extension app."},"connectionValue":{"type":"string","description":"The GUID value that identifies the connection instance of an extension app."}},"title":"connectionInstance"},"extensionData":{"type":"object","properties":{"actionContract":{"type":"string","description":"The template that defines the action in an extension app."},"actionInputKey":{"type":"string","description":"A key that represents the input data required for verification. The value of this property determines the actual data type to be verified. The supported values are:\n\n- `countryCode`\n- `phoneNumber`\n- `street1`\n- `locality`\n- `subdivision`\n- `email`\n- `firstName`\n- `lastName`\n- `vin`\n- `ssn`\n- `countryOrRegion`\n- `fein`\n- `businessName`\n- `postalCode`\n- `accountNumber`\n- `accountType`\n- `routingNumber`\n- `dateOfBirth`\n- `stateOfRegistration`\n- `countryOfRegistration`"},"actionName":{"type":"string","description":"The name of an action used in an extension app."},"applicationId":{"type":"string","description":"The unique ID of an extension app."},"applicationName":{"type":"string","description":"The name of an extension app."},"connectedFieldsData":{"$ref":"#/components/schemas/connectedData"},"connectionInstances":{"type":"array","items":{"$ref":"#/components/schemas/connectionInstance"},"description":"An object containing data that identifies an extension app's connection to the connected field."},"extensionContract":{"type":"string","description":"The template that defines the extension in an extension app. This corresponds to the extension template value in the extension app's manifest file."},"extensionGroupId":{"type":"string","description":"The unique ID of the group of extensions within an extension app."},"extensionName":{"type":"string","description":"The name of the extension used in an extension app."},"extensionPolicy":{"type":"string","description":"An envelope or account-level configuration that determines a document's signing policy.\nSet this to property value to `mustVerifyToSign` to require that this text tab must be validated by an extension app before the envelope can be completed."},"publisherName":{"type":"string","description":"The name of the extension app publisher."},"requiredForExtension":{"type":"string","description":"A boolean value that indicates whether a field must pass verification before a signer can sign a document."}},"title":"extensionData"},"localePolicyTab":{"type":"object","properties":{"addressFormat":{"type":"string","description":"Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`"},"calendarType":{"type":"string","description":"Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`"},"cultureName":{"type":"string","description":"The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code."},"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`"},"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`\n`0`\n- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`\n`($1,234,567.89)`\n- `Minus_CSym_1_Comma_234_Comma_567_Period_89`\n`-$1,234,567.89`\n- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`\n`-$ 1.234.567,89`\n- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`\n`$ -1.234.567,89`\n- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`\n`-1.234.567,89 $`\n- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`\n`(1 234 567,89 $)`\n- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`\n`-1 234 567,89 $`\n- `CSym_Minus_1_Quote_234_Quote_567_Period_89`\n`$-1'234'567.89`\n- `Minus_CSym_1_Period_234_Period_567_Comma_89`\n`-$1.234.567,89`\n- `Minus_CSym_1_Comma_234_Comma_567`\n`-$1,234,567`\n- `Minus_CSym_12_Comma_34_Comma_567_Period_89`\n`-$12,34,567.89`\n- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`\n`($ 1234,567.89)`\n- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`\n`$ -12,34,567.89`\n- `CSym_Minus_12_Comma_34_Comma_567_Period_89`\n`$-1,234,567.89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`\n`$ -1 234 567,89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`\n`$ -1 234 567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`\n`-$ 1 234 567,89`\n- `Minus_1_Space_234_Space_567_Comma_89_CSym`\n`-1 234 567,89$`\n- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`\n`-1 234 567.89 $`\n- `OPar_CSym_1_Period_234_Period_567_CPar`\n`(1.234.567)`\n- `OPar_CSym_1_Comma_234_Comma_567_CPar`\n`($1,234,567)`\n- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`\n`-1,234,567.89 $`\n- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`\n`-$ 1,234,567.89`\n- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`\n`($ 1.234.567,89)`\n- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`\n`($ 1'234'567.89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`\n`($ 1 234 567,89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`\n`($ 1 234 567.89)`\n- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`\n`($12,34,567.89)`\n- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`\n`($ 12,34,567.89)`\n- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`\n`(1,234,567.89 $)`\n- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`\n`(1.234.567,89 $)`\n- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`\n`(1 234 567,89$)`\n- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`\n`(1 234 567.89 $)`\n- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`\n`($ 1,234,567.89)`\n- `Minus_CSym_1_Period_234_Period_567`\n`-$ 1.234.567`\n- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`\n`-$ 1'234'567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`\n`-$ 1 234 567.89`\n- `CSym_Minus_1_Comma_234_Comma_567`\n`$-1,234,567`\n- `CSym_Minus_1_Period_234_Period_567`\n`$-1.234.567`\n- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`\n`$ -1'234'567.89`\n- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`\n`$ -1,234,567.89`\n- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`\n`-$ 12,34,567.89`\n- `Minus_1_Period_234_Period_567_Space_CSym`\n`-123.456.789 $`\n- `CSym_Minus_1_Space_234_Space_567_Comma_89`\n`$-123 456 789,00`\n- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`\n`-123'456'789.00 $`\n- `CSym_1_Comma_234_Comma_567_Period_89_Minus`\n`$123,456,789.00-`\n- `CSym_Minus_1_Period_234_Period_567_Comma_89`\n`$-123.456.789,00`\n- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`\n`($123.456.789,00)`\n- `Minus_CSym_1234_Comma_567_Period_89`\n`-$123456,789.00`\n- `Minus_CSym_1_Space_234_Space_567_Comma_89`\n`-$123 456 789,00`"},"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- `Default`\n\nUses the current locale.\n- `CSym_1_Comma_234_Comma_567_Period_89`\n`$1,234,567.89`\n- `CSym_Space_1_Period_234_Period_567_Comma_89`\n`$ 1.234.567,89`\n- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`\n`1.234.567,89 $`\n- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`\n`1 234 567,89 $`\n- `CSym_Space_1_Quote_234_Quote_567_Period_89`\n`$ 1'234'567.89`\n- `CSym_1_Comma_234_Comma_567`\n`$1,234,567`\n- `CSym_Space_12_Comma_34_Comma_567_Period_89`\n`$ 12,34,567.89`\n- `CSym_12_Comma_34_Comma_567_Period_89`\n`$12,34,567.89`\n- `CSym_Space_1234_Comma_567_Period_89`\n`$ 1234,567.89`\n- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`\n`1 234 567.89 $`\n- `CSym_Space_1_Space_234_Space_567_Comma_89`\n`$ 1 234 567,89`\n- `CSym_Space_1_Space_234_Space_567_Period_89`\n`$ 1 234 567.89`\n- `Leading_1_Space_234_Space_567_Comma_89_CSym`\n`1 234 567,89$`\n- `CSym_1_Period_234_Period_567`\n`$1.234.567`\n- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`\n`1,234,567. $` (New Armenian)\n- `CSym_Space_1_Comma_234_Comma_567_Period_89`\n`$ 1,234,567.89` (Persian)\n- `CSym_1_Period_234_Period_567_Comma_89`\n`$123.456.789,00` (es-CO)\n- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`\n`123'456'789.00 $` (fr-ch)\n- `CSym_1234_Comma_567_Period_89`\n`$123456,789.00` (es-PR)\n- `Leading_1_Period_234_Period_567_Space_CSym`\n`123.456.789 $`\n- `CSym_1_Space_234_Space_567_Comma_89`\n`$123 456 789,00` (en-ZA, es-CR)"},"customDateFormat":{"type":"string"},"customTimeFormat":{"type":"string"},"dateFormat":{"type":"string","description":"Specifies the date format. Valid values:\n\n- `default`\nused the UI's\n- `longformat`\nuse the UI's long format\n- `dd_mm_yy`\ndd-MM-yy\n- `dd_mmm_yy`\ndd-MMM-yy\n- `dd_mm_yyyy`\ndd-MM-yyyy\n- `dd_mmm_yyyy`\ndd-MMM-yyyy\n- `ddmmmmyyyy`\ndd MMMM yyyy\n- `ddmmyyyy`\ndd/MM/yyyy\n- `ddmmyyyy_de`\ndd.MM.yyyy\n- `dmyyyy`\nd/M/yyyy\n- `d_m_yyyy`\nd-M-yyyy\n- `mmmd_yyyy`\nMMM d, yyyy\n- `mmm_dd_yyyy`\nMMM-dd-yyyy\n- `mmmmd_yyyy`\nMMMM d, yyyy\n- `mm_dd_yyyy`\nMM-dd-yyyy\n- `mdyyyy`\nM/d/yyyy\n- `yyyy_mmm_dd`\nyyyy-MMM-dd\n- `yyyy_mm_dd`\nyyyy-MM-dd\n- `yyyymmdd`\nyyyy/MM/dd\n- `yyyymd`\nyyyy/M/d\n- `custom`\nCustomer set own value\n- `mmddyyyy`\nMM/dd/yyyy\n- `mmddyy`\nMM/dd/yy\n- `yyyy_mmmm_d`\nyyyy MMMM d"},"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- `first1last1`\n\"WG\"\n- `last2`\n\"GA\"\n- `first2`\n\"WI\"\n- `last2_cjk`\nfirst two characters from last name in CJK characters."},"nameFormat":{"type":"string","description":"Describes how names are displayed. Valid values:\n\n- `first_middle_last`\nWilliam Henry Gates\n- `full`\nMr William Henry Gates III\n- `last_first`\nGates William\n- `lastfirst`\nGatesWilliam\n- `last_first_cjk`\nGates William only with CJK characters\n- `lastfirst_cjk`\nGatesWilliam only with CJK characters"},"timeFormat":{"type":"string","description":"Specifies the time format. Valid values:\n\n- `none`\nNone\n- `hh_mm`\nhh:mm\n- `hhmm`\nHH:mm\n- `hhmmss`\nHH:mm:ss\n- `hhmmsstt`\nHH:mm:ss tt\n- `hhmmtt`\nHH:mm tt\n- `hmm`\nh:mm\n- `hmmss`\nh:mm:ss\n- `hmmsstt`\nh:mm:ss tt\n- `hmmtt`\nh:mm tt\n- `custom`\nCustomer-set format"},"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`"},"useLongCurrencyFormat":{"type":"string","description":"When **true,** use the long currency format for the locale."}},"description":"Allows you to customize locale settings.","title":"localePolicyTab"},"pathExtendedElement":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"},"typeName":{"type":"string"}},"title":"pathExtendedElement"},"mergeField":{"type":"object","properties":{"allowSenderToEdit":{"type":"string","description":"When **true,** the sender can modify the value of the `mergeField` tab during the sending process."},"allowSenderToEditMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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`."},"configurationTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"path":{"type":"string","description":"Sets the object associated with the custom tab. Currently this is the Salesforce Object."},"pathExtended":{"type":"array","items":{"$ref":"#/components/schemas/pathExtendedElement"},"description":"Reserved for Docusign."},"pathExtendedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pathMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"row":{"type":"string","description":"Specifies the row number in a Salesforce table that the merge field value corresponds to."},"rowMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"writeBack":{"type":"string","description":"When **true,** data entered into the merge field during Signing will update the mapped Salesforce field."},"writeBackMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Contains information for transferring values between Salesforce data fields and Docusign tabs.","title":"mergeField"},"smartContractInformation":{"type":"object","properties":{"code":{"type":"string","description":"Reserved for Docusign."},"uri":{"type":"string","description":"Reserved for Docusign."}},"title":"smartContractInformation"},"approve":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"buttonText":{"type":"string","description":"Specifies the approval text that displays in the tab."},"buttonTextMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"customTabId":{"type":"string","description":"The Docusign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"**Note:** Approve tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n","title":"approve"},"checkbox":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"customTabId":{"type":"string","description":"The Docusign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"This property does not apply to `checkbox` tabs.\n\nTo require users to check\nat least one, or at most some number\nof checkboxes,\nassociate the checkbox tabs\nwith a [`tabGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups).\nThen set the following `tabGroup` properties:\n\n- [`maximumAllowed`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed)\n- [`minimumRequired`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired)\n- [`groupRule`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule) specifies how the other two properties are interpreted.\n\nYou can find an example\nat [Stack Overflow](https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277)."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"selected":{"type":"string","description":"When **true,** the checkbox is selected."},"selectedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"selectedOriginal":{"type":"string"},"selectedOriginalMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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 (-7, -6)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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 (-7, -6)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to select a yes/no (on/off) option.\n","title":"checkbox"},"comment":{"type":"object","properties":{"envelopeId":{"type":"string","description":"The Guid of the envelope the comment thread belongs to."},"hmac":{"type":"string","description":"Reserved for Docusign."},"id":{"type":"string","description":"The unique identifier for the comment."},"mentions":{"type":"array","items":{"type":"string"},"description":"An array of userIds that are mentioned directly in the body of a comment."},"read":{"type":"boolean","description":"When **true,** indicates that the comment was read."},"sentByEmail":{"type":"string","description":"The email address of the user who created the comment."},"sentByFullName":{"type":"string","description":"The full name of the user who created the comment."},"sentByImageId":{"type":"string","description":"Reserved for Docusign."},"sentByInitials":{"type":"string","description":"The initials of the user who created the comment."},"sentByRecipientId":{"type":"string","description":"The recipient ID of the user who created the comment."},"sentByUserId":{"type":"string","description":"The user ID of the user who created the comment."},"signingGroupId":{"type":"string","description":"The ID of the signing group that can view the comment or that created the comment."},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"subject":{"type":"string","description":"The subject of the envelope."},"tabId":{"type":"string","description":"The unique identifier for the tab that represents the comment thread."},"text":{"type":"string","description":"The content of the comment, as UTF-8 text.\n\nMaximum Length: 500 characters.\n\n**Note:** The maximum size allowed for the entire message body is 32 KB."},"threadId":{"type":"string","description":"The unique identifier for the comment thread."},"threadOriginatorId":{"type":"string","description":"The userId of the user who created the thread."},"timestamp":{"type":"string","description":"The time the comment was created."},"timeStampFormatted":{"type":"string","description":"The time the comment was created, formatted according to the format of the user who created the comment."},"visibleTo":{"type":"array","items":{"type":"string"},"description":"The user IDs of the users that the comment is visible to."}},"title":"comment"},"commentThread":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/comment"},"description":"An array of comment tabs that contain information about users' comments on documents."},"conditionalParentLabel":{"type":"string","description":"For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"threadId":{"type":"string","description":"The unique identifier for the comment thread."},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"title":"commentThread"},"commissionCounty":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/).\n","title":"commissionCounty"},"commissionExpiration":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/).\n","title":"commissionExpiration"},"commissionNumber":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n","title":"commissionNumber"},"commissionState":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n","title":"commissionState"},"company":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays the recipient's company name.\n","title":"company"},"dateSigned":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"timestampStandardized":{"type":"string"},"tooltip":{"type":"string","description":"**Note:** Date Signed tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays the date that the recipient signed the\ndocument.\n","title":"dateSigned"},"date":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n","title":"date"},"decline":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"buttonText":{"type":"string","description":" Specifies the decline text displayed in the tab."},"buttonTextMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"declineReason":{"type":"string","description":"The reason the recipient declined the document."},"declineReasonMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"**Note:** Decline tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n","title":"decline"},"draw":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"allowSignerUpload":{"type":"string","description":"When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.**"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"useBackgroundAsCanvas":{"type":"string"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to add a free-form drawing to the document.","title":"draw"},"emailAddress":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"customTabId":{"type":"string","description":"The Docusign-generated custom tab ID for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string","description":"The name of the tab. For example, `Sign Here` or `Initial Here`."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"**Note:** Email Address tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays the recipient's email as entered in the\nrecipient information.\n","title":"emailAddress"},"email":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n","title":"email"},"envelopeId":{"type":"object","properties":{"agreementAttribute":{"type":"string"},"agreementAttributeLocked":{"type":"string"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays the envelope ID.\n\n**Note:** The eSignature API uses the name `envelopeId` two ways:\n\n- As a _property_ of type `string` used to identify an envelope by its GUID.\n- As an _object_ used to represent an envelope tab that displays\nthe envelope's GUID.","title":"envelopeId"},"firstName":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$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","title":"firstName"},"extendPaymentLineItem":{"type":"object","properties":{"amountReference":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"priceId":{"type":"string"},"productId":{"type":"string"},"quantity":{"type":"string","format":"int32"},"type":{"type":"string"},"unitAmount":{"type":"string","format":"int32"}},"title":"extendPaymentLineItem"},"extendPaymentConfiguration":{"type":"object","properties":{"appId":{"type":"string"},"connectionInstanceId":{"type":"string"},"currency":{"type":"string"},"durationEnd":{"type":"string"},"durationStart":{"type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/extendPaymentLineItem"}},"paymentDueDays":{"type":"string","format":"int32"},"paymentMethods":{"type":"array","items":{"type":"string"}},"paymentMode":{"type":"string"},"tabRole":{"type":"string"}},"title":"extendPaymentConfiguration"},"paymentLineItem":{"type":"object","properties":{"amountReference":{"type":"string","description":"This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items."},"description":{"type":"string","description":"A sender-defined description of the line item."},"itemCode":{"type":"string","description":"This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item."},"name":{"type":"string","description":"This is a sender-defined\nproduct name, service name,\nor other designation for the line item."}},"description":"A line item describes details\nabout an individual line item\nin a payment request.\n\n","title":"paymentLineItem"},"paymentSignerValues":{"type":"object","properties":{"paymentOption":{"type":"string","description":"This property specifies how the signer's collected payment details will be used.\n\nValid values:\n\n- `authorize`: The payment details will be used to collect payment. This is the default value.\n- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.\n- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment."}},"title":"paymentSignerValues"},"money":{"type":"object","properties":{"amountInBaseUnit":{"type":"string","description":"The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent."},"currency":{"type":"string","description":"The three-letter\n[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment.\n\nFor example:\n\n- AUD Australian dollar\n- CAD Canadian dollar\n- EUR Euro\n- GBP Great Britain pound\n- USD United States dollar\n\nThis is a read-only property."},"displayAmount":{"type":"string","description":"The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property."}},"description":"Describes information\nabout the `total` of a payment.\n","title":"money"},"paymentDetails":{"type":"object","properties":{"allowedPaymentMethods":{"type":"array","items":{"type":"string"},"description":"An array of accepted payment methods:\n\n- `CreditCard`\n- `ApplePay`\n- `AndroidPay`\n- `BankAccount`\n\nFor example, if you only accept credit cards and ACH transfers, you would set this property to:\n\n`'[\"BankAccount\", \"CreditCard\"]'`\n\nDo not specify `BankAccount` (ACH) if you are also using in-person signing."},"chargeId":{"type":"string","description":"The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment."},"currencyCode":{"type":"string","description":"Specifies the three-letter\n[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment.\n\nSupported currencies are:\n\n- AUD: Australian dollar\n- CAD: Canadian dollar\n- EUR: Euro\n- GBP: Great Britain pound\n- USD: United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error."},"currencyCodeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"customerId":{"type":"string","description":"The customer ID."},"customMetadata":{"type":"string","description":"This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports.\n\nThe following example shows what the **Description** field of the transaction will look like:\n\n`<envelopeID>, <customMetadata>`"},"customMetadataRequired":{"type":"boolean","description":"A sender-defined field that specifies whether custom metadata is required for the transaction. When **true,** custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account."},"gatewayAccountId":{"type":"string","description":"A GUID that identifies the payment gateway\nconnected to the sender's Docusign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the Docusign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the Docusign Admin console."},"gatewayAccountIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"gatewayDisplayName":{"type":"string","description":"Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net, CyberSource, Zuora, Elavon."},"gatewayName":{"type":"string","description":"Name of the gateway connected to sender's Docusign account.\n\nPossible values are:\n\n- `Stripe`\n- `Braintree`\n- `AuthorizeDotNet`\n- `CyberSource`\n- `Zuora`\n- `Elavon`"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/paymentLineItem"},"description":"A payment formula can have\none or more line items\nthat provide detail about\nindividual items in a payment request.\n\nThe list of line items\nare returned as metadata\nto the payment gateway."},"paymentOption":{"type":"string","description":"This property specifies how the signer's collected payment details will be used.\n\nValid values:\n\n- `authorize`: The payment details will be used to collect payment. This is the default value.\n- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.\n- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment."},"paymentSourceId":{"type":"string","description":"The payment source ID."},"signerValues":{"$ref":"#/components/schemas/paymentSignerValues"},"status":{"type":"string","description":"This read-only property describes the status of a payment.\n\n- `new`\n\nThis is a new payment request.\nThe envelope has been created,\nbut no payment authorizations have been made.\n\n- `auth_complete`\n\nA recipient has entered their credit card information,\nbut the envelope has not been completed.\nThe card has not been charged.\n\n- `payment_complete`\n\nThe recipient's card has been charged.\n\n- `payment_capture_failed`\n\nFinal charge failed.\nThis can happen when too much time\npasses between authorizing the payment\nand completing the document.\n\n- `future_payment_saved`\n\nThe recipient's payment method has been saved to the sender's payment gateway."},"subGatewayName":{"type":"string"},"total":{"$ref":"#/components/schemas/money"}},"description":"When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]:     https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n","title":"paymentDetails"},"formulaTab":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extendPaymentConfiguration":{"$ref":"#/components/schemas/extendPaymentConfiguration"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html)\nin the Docusign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters"},"formulaMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"hiddenMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"isPaymentAmount":{"type":"string","description":"When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. "},"isPaymentAmountMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"paymentDetails":{"$ref":"#/components/schemas/paymentDetails"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roundDecimalPlaces":{"type":"string","description":"The number of decimal places to round to."},"roundDecimalPlacesMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$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/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]:     https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n","title":"formulaTab"},"fullName":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays the recipient's full name.\n","title":"fullName"},"initialHere":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"handDrawRequired":{"type":"string","description":"When set to `true`, requires a hand-drawn initial by the signer."},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"optional":{"type":"string","description":"When **true,** the recipient does not need to complete this tab to complete the signing process."},"optionalMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"scaleValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to initial the document. May\nbe optional.\n","title":"initialHere"},"lastName":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$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","title":"lastName"},"listItem":{"type":"object","properties":{"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."},"selectedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"text":{"type":"string","description":"Specifies the text that is shown in the dropdown list. "},"textMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value that is used when the list item is selected."},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"One of the selectable items\nin the `listItems` property\nof a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab.","title":"listItem"},"list":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"listSelectedValue":{"type":"string","description":"The value in the list that is selected by default."},"listSelectedValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"The value to use when the item is selected."},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/)\nobjects to specify the selectable options.\n","title":"list"},"notarize":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.","title":"notarize"},"notarySeal":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"scaleValue":{"type":"string","description":"Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."},"scaleValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/","title":"notarySeal"},"note":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"**Note:** Note tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays additional information, in the form of a\nnote, for the recipient.\n","title":"note"},"number":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html)\nin the Docusign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters"},"formulaMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"isPaymentAmount":{"type":"string","description":"When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. "},"isPaymentAmountMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Number tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\nSee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)\nto learn more about this tab type.","title":"number"},"numerical":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"documentId":{"type":"string","description":"Specifies the document ID number that the tab is placed on. This ID must refer to an existing document."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxNumericalValue":{"type":"string","description":"The maximum value that the numerical tab can take on.\nThe largest value allowed, and the default if not specified, is\n`999999999.99`"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"minNumericalValue":{"type":"string","description":"The minimum value that the numerical tab can take on.\nThe smallest value allowed, and the default if not specified, is\n`-999999999.99`"},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"numericalValue":{"type":"string","description":"The raw numerical value of the tab.\n\nFor example,\nif the locale policy is `en-US`\nand the `numericalValue` is `-1234.56`,\nthe `value` property will contain the string\n`\"($ 1,234.56)\"`."},"originalNumericalValue":{"type":"string","description":"The original value of the tab."},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string"},"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."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationType":{"type":"string","description":"Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`"},"value":{"type":"string","description":"The `numericalValue` of the tab\ndisplayed according to its locale policy.\n\nFor example,\nif the locale policy is `en-US`\nand the `numericalValue` is `-1234.56`,\nthis property will contain the string\n`\"($ 1,234.56)\"`."},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"Numerical tabs provide robust display and validation features,\nincluding formatting for different regions and currencies,\nand minimum and maximum value validation.\nSee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/)\nto learn more about this tab type.","title":"numerical"},"phoneNumber":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/","title":"phoneNumber"},"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."}},"title":"graphicsContext"},"polyLine":{"type":"object","properties":{"x1":{"type":"string"},"x2":{"type":"string"},"y1":{"type":"string"},"y2":{"type":"string"}},"title":"polyLine"},"polyLineOverlay":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"graphicsContext":{"$ref":"#/components/schemas/graphicsContext"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"overlayType":{"type":"string","description":"The type of overlay to use. The API currently supports only the `outline` overlay type."},"overlayTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"polyLines":{"type":"array","items":{"$ref":"#/components/schemas/polyLine"},"description":"An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines."},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** indicates that the tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.","title":"polyLineOverlay"},"radio":{"type":"object","properties":{"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"selected":{"type":"string","description":"When **true,** the radio button is selected."},"selectedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.\n","title":"radio"},"radioGroup":{"type":"object","properties":{"conditionalParentLabel":{"type":"string","description":"For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"groupName":{"type":"string","description":"The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."},"groupNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"radios":{"type":"array","items":{"$ref":"#/components/schemas/radio"},"description":"Specifies the locations and status for radio buttons that are grouped together."},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"source":{"type":"string"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"tooltipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)\nobjects  associated with the group. Only one radio button can\nbe selected in a group.\n","title":"radioGroup"},"senderCompany":{"type":"object","properties":{"agreementAttribute":{"type":"string"},"agreementAttributeLocked":{"type":"string"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"title":"senderCompany"},"senderName":{"type":"object","properties":{"agreementAttribute":{"type":"string"},"agreementAttributeLocked":{"type":"string"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"title":"senderName"},"ssn":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n","title":"ssn"},"tabGroup":{"type":"object","properties":{"agreementAttribute":{"type":"string"},"agreementAttributeLocked":{"type":"string"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"groupLabel":{"type":"string","description":"A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array."},"groupLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"groupRule":{"type":"string","description":"Specifies how `maximumAllowed` and `minimumRequired`\nare interpreted when selecting tabs in a `tabGroup`.\n\nPossible values are:\n\n- `SelectAtLeast`\n- `SelectAtMost`\n- `SelectExactly`\n- `SelectARange`"},"groupRuleMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maximumAllowed":{"type":"string","description":"The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation."},"maximumAllowedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"minimumRequired":{"type":"string","description":"The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation."},"minimumRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientId":{"type":"string","description":"The ID of the recipient to whom the tab group will be assigned. This value should match the `recipientId` defined in the recipient object."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabScope":{"type":"string","description":"The scope of the tab group. Possible values are:\n\n- `document`\n- `envelope` (default)"},"tabScopeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"title":"tabGroup"},"text":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes:\n\n- `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`)\n- `ContactEmail`: the contact’s email address\n- `ContactName`: the contact’s name\n- `ContractValue`: the monetary value of the contract\n- `EffectiveDate`: the contract’s effective date\n- `ExpirationDate`: the contract’s expiration date\n- `Party`: one of the parties to the agreement\n- `RenewalNoticePeriod`: the renewal notice period for the contract\n- `RenewalTerm`: the renewal term for the contract"},"agreementAttributeLocked":{"type":"string","description":"When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute."},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string","description":"A description of the tab that can match the original document caption or describe its intent. When a Web Form is generated from a template this value will be used as the caption of the field shown on the form."},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html)\nin the Docusign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters"},"formulaMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"isPaymentAmount":{"type":"string","description":"When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. "},"isPaymentAmountMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"The `shared` and `shareToRecipients` properties work together to define signing behavior. If `\"shared\": \"true\"`, it overrides `shareToRecipients`, and the tab is shared with all recipients. In mixed cases, the API prioritizes `\"shared\": \"true\"` for all recipients, or `\"shared\": \"false\"` for specified recipients."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"The value of the text tab.\n\nMaximum length: 4000 bytes."},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to enter any type of text.\n","title":"text"},"zip":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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`."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireAll":{"type":"string","description":"When **true** and shared is true, information must be entered in this field to complete the envelope."},"requireAllMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$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."},"requireInitialOnSharedChangeMetadata":{"$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."},"senderRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"shareToRecipients":{"type":"string","description":"Reserved for Docusign."},"shareToRecipientsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"useDash4":{"type":"string","description":"When **true,** ZIP+4 format is used."},"useDash4Metadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom of embedded)."},"validationMessageMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationPatternMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n","title":"zip"},"prefillTabs":{"type":"object","properties":{"checkboxTabs":{"type":"array","items":{"$ref":"#/components/schemas/checkbox"},"description":"A list of\n[Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set."},"dateTabs":{"type":"array","items":{"$ref":"#/components/schemas/date"},"description":"A list of\n[Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message."},"emailTabs":{"type":"array","items":{"$ref":"#/components/schemas/email"},"description":"A list of\n[Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response."},"numberTabs":{"type":"array","items":{"$ref":"#/components/schemas/number"},"description":"A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs)."},"radioGroupTabs":{"type":"array","items":{"$ref":"#/components/schemas/radioGroup"},"description":"A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set."},"senderCompanyTabs":{"type":"array","items":{"$ref":"#/components/schemas/senderCompany"}},"senderNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/senderName"}},"ssnTabs":{"type":"array","items":{"$ref":"#/components/schemas/ssn"},"description":"A list of\n[SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set."},"tabGroups":{"type":"array","items":{"$ref":"#/components/schemas/tabGroup"},"description":"An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array."},"textTabs":{"type":"array","items":{"$ref":"#/components/schemas/text"},"description":"A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)."},"zipTabs":{"type":"array","items":{"$ref":"#/components/schemas/zip"},"description":"A list of\n[Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set."}},"description":"Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]:      https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields\n[catblog]:  https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields","title":"prefillTabs"},"signerAttachment":{"type":"object","properties":{"agreementAttribute":{"type":"string"},"agreementAttributeLocked":{"type":"string"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"handDrawRequired":{"type":"string","description":"Reserved for Docusign."},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"optional":{"type":"string","description":"When **true,** the recipient does not need to complete this tab to complete the signing process."},"optionalMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"scaleValue":{"type":"string","description":"Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."},"scaleValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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 (+0, -24)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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 (+0, -24)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to attach supporting\ndocuments to an envelope.\n","title":"signerAttachment"},"stamp":{"type":"object","properties":{"adoptedDateTime":{"type":"string","description":"The UTC date and time when the user adopted the signature."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"customField":{"type":"string"},"dateStampProperties":{"$ref":"#/components/schemas/dateStampProperties"},"disallowUserResizeStamp":{"type":"string","description":"When **true,** users may not resize the stamp."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"externalID":{"type":"string","description":"Optionally specify an external identifier for the user's signature."},"imageBase64":{"type":"string"},"imageType":{"type":"string","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"phoneticName":{"type":"string","description":"The phonetic spelling of the `signatureName`."},"signatureName":{"type":"string","description":"Specifies the user's signature name."},"stampFormat":{"type":"string","description":"The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date."},"stampImageUri":{"type":"string","description":"The URI for retrieving the image of the user's stamp."},"stampSizeMM":{"type":"string","description":"The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."},"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."}},"title":"stamp"},"signHere":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"handDrawRequired":{"type":"string","description":"When set to `true`, requires a hand-drawn signature by the signer."},"height":{"type":"string","description":"Not applicable to Sign Here tab."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"isSealSignTab":{"type":"string","description":"When **true,** the tab contains a visual representation for an electronic seal in a document."},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"optional":{"type":"string","description":"When **true,** the recipient does not need to complete this tab to complete the signing process."},"optionalMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"scaleValue":{"type":"string","description":"Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size."},"scaleValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"stamp":{"$ref":"#/components/schemas/stamp"},"stampType":{"type":"string","description":"The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"},"stampTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"Not applicable to Sign Here tab."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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 (+1, -7)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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 (+1, -7)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that allows the recipient to sign a document. May be\noptional.\n","title":"signHere"},"smartSectionCollapsibleDisplaySettings":{"type":"object","properties":{"arrowClosed":{"type":"string","description":"Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the closed state.\n\nOne of the following:\n\n- `up`: In the closed state, the disclosure arrow points up.\n- `down`: In the closed state, the disclosure arrow points down.\n- `left`: In the closed state, the disclosure arrow points left.\n- `right`: In the closed state, the disclosure arrow points right."},"arrowColor":{"type":"string","description":"A CSS color value (such as `#DCF851`) that indicates the color of the arrow."},"arrowLocation":{"type":"string","description":"The location of the arrow relative to the collapsible section's label. Possible values are:\n\n- `right` (default)\n- `left`"},"arrowOpen":{"type":"string","description":"Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the open state.\n\nOne of the following:\n\n- `up`: In the open state, the disclosure arrow points up.\n- `down`: In the open state, the disclosure arrow points down.\n- `left`: In the open state, the disclosure arrow points left.\n- `right`: In the open state, the disclosure arrow points right."},"arrowSize":{"type":"string","description":"Indicates the size of the collapsible arrows. Possible values are:\n\n- `small`\n- `large` (default)"},"arrowStyle":{"type":"string","description":"The name of the CSS style to be used on collapsible arrow section."},"containerStyle":{"type":"string","description":"The name of the CSS style to be used for the collapsible container."},"labelStyle":{"type":"string","description":"The name of the CSS style to be used for the collapsible container's label."},"onlyArrowIsClickable":{"type":"boolean","description":"When **true,** only the arrow is clickable to expand or collapse the section.\nWhen **false** (the default), both the label and the arrow are clickable.\n\nIf no arrow is used, this setting is ignored."},"outerLabelAndArrowStyle":{"type":"string","description":"The name of the CSS style to be used for the collapsible container's outer label and arrow style."}},"title":"smartSectionCollapsibleDisplaySettings"},"smartSectionDisplaySettings":{"type":"object","properties":{"cellStyle":{"type":"string","description":"Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types."},"collapsibleSettings":{"$ref":"#/components/schemas/smartSectionCollapsibleDisplaySettings"},"display":{"type":"string","description":"Indicates the display type. Must be one of the following enum values:\n\n- **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page.\n- **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded.\n- **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed.\n- **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions.\n- **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked.\n- **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view."},"displayLabel":{"type":"string","description":"The label to add to this display section in the signing page."},"displayOrder":{"type":"integer","description":"The position on the page where the display section appears."},"displayPageNumber":{"type":"integer","description":"The number of the page on which the display section appears."},"hideLabelWhenOpened":{"type":"boolean","description":"When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`."},"inlineOuterStyle":{"type":"string","description":"Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`."},"labelWhenOpened":{"type":"string","description":"The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`."},"preLabel":{"type":"string","description":"Enables you to add descriptive text that appears before a collapsed section or continue button."},"scrollToTopWhenOpened":{"type":"boolean","description":"When **true** and the section is expanded,\nthe position of the section-close control\nscrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`."},"tableStyle":{"type":"string","description":"Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`."}},"description":"These properties define how a Smart Section displays. A Smart Section is a type of display section.","title":"smartSectionDisplaySettings"},"smartSectionAnchorPosition":{"type":"object","properties":{"pageNumber":{"type":"integer","description":"Specifies the page number on which the tab is located."},"xPosition":{"type":"number","format":"double","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."},"yPosition":{"type":"number","format":"double","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."}},"title":"smartSectionAnchorPosition"},"smartSection":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caseSensitive":{"type":"boolean","description":"When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML."},"conditionalParentLabel":{"type":"string","description":"For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"displaySettings":{"$ref":"#/components/schemas/smartSectionDisplaySettings"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"endAnchor":{"type":"string","description":"Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."},"endPosition":{"$ref":"#/components/schemas/smartSectionAnchorPosition"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"overlayType":{"type":"string","description":"The type of overlay to draw on the document. The following overlay types are supported:\n\n- `line`\n- `outline`"},"overlayTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"removeEndAnchor":{"type":"boolean","description":"When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying."},"removeStartAnchor":{"type":"boolean","description":"When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying."},"shared":{"type":"string","description":"When **true,** this custom tab is shared."},"sharedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"source":{"type":"string","description":"Reserved for Docusign."},"startAnchor":{"type":"string","description":"Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."},"startPosition":{"$ref":"#/components/schemas/smartSectionAnchorPosition"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"title":"smartSection"},"title":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"concealValueOnDocumentMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$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."},"disableAutoSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When **true,** the signer cannot change the data of the custom tab."},"lockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"maxLength":{"type":"string","description":"An optional value that describes the maximum length of the property when the property is a string."},"maxLengthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"originalValue":{"type":"string","description":"The initial value of the tab."},"originalValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the signer is required to fill out this tab."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"value":{"type":"string","description":"Specifies the value of the tab. "},"valueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)"},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"A tab that displays the recipient's title.\n","title":"title"},"view":{"type":"object","properties":{"agreementAttribute":{"type":"string","description":"N/A - do not use"},"agreementAttributeLocked":{"type":"string","description":"N/A - do not use"},"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, `Docu Sign` will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match.\n\nThe default value is **true.**"},"anchorAllowWhiteSpaceInCharactersMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorCaseSensitiveMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorHorizontalAlignmentMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorIgnoreIfNotPresent":{"type":"string","description":"When **true,** this tab is ignored if the `anchorString` is not found in the document."},"anchorIgnoreIfNotPresentMetadata":{"$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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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\nExample: 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\nExample: 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."},"anchorMatchWholeWordMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorString":{"type":"string","description":"Specifies the string to find in the document and use as the basis for tab placement."},"anchorStringMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabProcessorVersion":{"type":"string","description":"Reserved for Docusign."},"anchorTabProcessorVersionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorTabScope":{"type":"string"},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorUnitsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorXOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffsetMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"bold":{"type":"string","description":"When **true,** the information in the tab is bold."},"boldMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"buttonText":{"type":"string","description":"The text to display on the button."},"buttonTextMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"caption":{"type":"string"},"captionMetadata":{"$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."},"conditionalParentLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"conditionalParentValueMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"connectedObjectDetails":{"$ref":"#/components/schemas/connectedObjectDetails"},"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."},"customTabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"documentIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"extensionData":{"$ref":"#/components/schemas/extensionData"},"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"},"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"},"fontColorMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fontMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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"},"fontSizeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"formPageLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"formPageNumber":{"type":"string","description":"An integer specifying the order in which to present the guided form pages."},"formPageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"heightMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"italic":{"type":"string","description":"When **true,** the information in the tab is italic."},"italicMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"mergeFieldXml":{"type":"string","description":"Reserved for Docusign."},"pageNumber":{"type":"string","description":"The page number on which the tab is located. For supplemental documents, this value must be `1`."},"pageNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"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."},"recipientIdGuidMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"recipientIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"required":{"type":"string","description":"When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process."},"requiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requiredRead":{"type":"string","description":"When **true,** the recipient must read through the document."},"smartContractInformation":{"$ref":"#/components/schemas/smartContractInformation"},"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`)."},"statusMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabFullyQualifiedPath":{"type":"string"},"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."},"tabGroupLabelsMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabId":{"type":"string","description":"The unique identifier for the tab."},"tabIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabLabelMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"tabOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"tabTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateLockedMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"templateRequiredMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"tooltip":{"type":"string","description":"The text of a tooltip that appears when a user hovers over a form field or tab."},"toolTipMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"underline":{"type":"string","description":"When **true,** the information in the tab is underlined."},"underlineMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"warningDetails":{"$ref":"#/components/schemas/errorDetails"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."},"widthMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"xPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"yPositionMetadata":{"$ref":"#/components/schemas/propertyMetadata"}},"description":"This tab is used with the Approve tab to handle supplemental documents.","title":"view"},"tabs":{"type":"object","properties":{"approveTabs":{"type":"array","items":{"$ref":"#/components/schemas/approve"},"description":"A list of\n[Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set."},"checkboxTabs":{"type":"array","items":{"$ref":"#/components/schemas/checkbox"},"description":"A list of\n[Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set."},"commentThreadTabs":{"type":"array","items":{"$ref":"#/components/schemas/commentThread"},"description":"An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set."},"commissionCountyTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionCounty"},"description":"A list of\n[Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"commissionExpirationTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionExpiration"},"description":"A list of\n[Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"commissionNumberTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionNumber"},"description":"A list of\n[Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"commissionStateTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionState"},"description":"A list of\n[Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"companyTabs":{"type":"array","items":{"$ref":"#/components/schemas/company"},"description":"A list of\n[Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company).\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set."},"dateSignedTabs":{"type":"array","items":{"$ref":"#/components/schemas/dateSigned"},"description":"A list of\n[Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set."},"dateTabs":{"type":"array","items":{"$ref":"#/components/schemas/date"},"description":"A list of\n[Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message."},"declineTabs":{"type":"array","items":{"$ref":"#/components/schemas/decline"},"description":"A list of\n[Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set."},"drawTabs":{"type":"array","items":{"$ref":"#/components/schemas/draw"},"description":"A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."},"emailAddressTabs":{"type":"array","items":{"$ref":"#/components/schemas/emailAddress"},"description":"A list of\n[Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set."},"emailTabs":{"type":"array","items":{"$ref":"#/components/schemas/email"},"description":"A list of\n[Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response."},"envelopeIdTabs":{"type":"array","items":{"$ref":"#/components/schemas/envelopeId"},"description":"A list of\n[Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid).\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set."},"firstNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/firstName"},"description":"A list of\n[First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname).\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set."},"formulaTabs":{"type":"array","items":{"$ref":"#/components/schemas/formulaTab"},"description":"A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html).\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html)."},"fullNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/fullName"},"description":"A list of\n[Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Full Name tab displays the recipient's full name. This value can't be set."},"initialHereTabs":{"type":"array","items":{"$ref":"#/components/schemas/initialHere"},"description":"A list of\n[Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set."},"lastNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/lastName"},"description":"A list of\n[Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set."},"listTabs":{"type":"array","items":{"$ref":"#/components/schemas/list"},"description":"An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)."},"notarizeTabs":{"type":"array","items":{"$ref":"#/components/schemas/notarize"},"description":"A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page."},"notarySealTabs":{"type":"array","items":{"$ref":"#/components/schemas/notarySeal"},"description":"A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/)."},"noteTabs":{"type":"array","items":{"$ref":"#/components/schemas/note"},"description":"A list of\n[Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set."},"numberTabs":{"type":"array","items":{"$ref":"#/components/schemas/number"},"description":"A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs)."},"numericalTabs":{"type":"array","items":{"$ref":"#/components/schemas/numerical"},"description":"A list of numerical tabs.\n\nNumerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."},"phoneNumberTabs":{"type":"array","items":{"$ref":"#/components/schemas/phoneNumber"},"description":"A list of\n[Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/)."},"polyLineOverlayTabs":{"type":"array","items":{"$ref":"#/components/schemas/polyLineOverlay"},"description":"This type of tab enables the recipient to strike through document text. This value can't be set."},"prefillTabs":{"$ref":"#/components/schemas/prefillTabs"},"radioGroupTabs":{"type":"array","items":{"$ref":"#/components/schemas/radioGroup"},"description":"A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set."},"signerAttachmentTabs":{"type":"array","items":{"$ref":"#/components/schemas/signerAttachment"},"description":"A list of\n[Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set."},"signHereTabs":{"type":"array","items":{"$ref":"#/components/schemas/signHere"},"description":"A list of\n[Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set."},"smartSectionTabs":{"type":"array","items":{"$ref":"#/components/schemas/smartSection"},"description":"A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."},"ssnTabs":{"type":"array","items":{"$ref":"#/components/schemas/ssn"},"description":"A list of\n[SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set."},"tabGroups":{"type":"array","items":{"$ref":"#/components/schemas/tabGroup"},"description":"An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array."},"textTabs":{"type":"array","items":{"$ref":"#/components/schemas/text"},"description":"A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)."},"titleTabs":{"type":"array","items":{"$ref":"#/components/schemas/title"},"description":"A list of\n[Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Title tab displays the recipient's title. This value can't be set."},"viewTabs":{"type":"array","items":{"$ref":"#/components/schemas/view"},"description":"A list of\n[View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set."},"zipTabs":{"type":"array","items":{"$ref":"#/components/schemas/zip"},"description":"A list of\n[Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set."}},"description":"Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.","title":"tabs"},"authorizedSignatory":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"addAccessCodeToEmail":{"type":"string","description":"This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"}},"agentCanEditEmail":{"type":"string"},"agentCanEditName":{"type":"string"},"allowSystemOverrideForLockedRecipient":{"type":"string"},"autoNavigation":{"type":"string"},"autoRespondedReason":{"type":"string"},"bulkRecipientsUri":{"type":"string","description":"Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information."},"bulkSendV2Recipient":{"type":"string"},"canSignOffline":{"type":"string","description":"When set to **true**, specifies that the signer can perform the signing ceremony offline."},"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. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to  **true**, an error is generated on sending.ng. \n\nMaximum length: 100 characters. "},"completedCount":{"type":"string"},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"creationReason":{"type":"string"},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document."},"defaultRecipient":{"type":"string"},"delegatedBy":{"$ref":"#/components/schemas/delegationInfo"},"delegatedTo":{"type":"array","items":{"$ref":"#/components/schemas/delegationInfo"}},"deliveredDateTime":{"type":"string","description":"Reserved: For DocuSign use only."},"deliveryMethod":{"type":"string","description":"Reserved: For DocuSign use only."},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string"},"designatorIdGuid":{"type":"string"},"documentTemplateId":{"type":"string"},"documentVisibility":{"type":"array","items":{"$ref":"#/components/schemas/documentVisibility"}},"email":{"type":"string"},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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\nIf set to `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 that is launched by any partner.\n\nIt is important to remember 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 process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `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 fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved:"},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The user's first name. \nMaximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string"},"fullNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckConfigurationName":{"type":"string","description":"Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.\n\n*Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"inheritEmailNotificationConfiguration":{"type":"string","description":"When set to **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. "},"isBulkRecipient":{"type":"string"},"isBulkRecipientMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lastName":{"type":"string"},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string"},"lockedRecipientSmsEditable":{"type":"string"},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"notaryId":{"type":"string"},"notarySignerEmailSent":{"type":"string"},"note":{"type":"string","description":"Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.\n\nMaximum Length: 1000 characters."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"offlineAttributes":{"$ref":"#/components/schemas/offlineAttributes"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved:"},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"recipientFeatureMetadata":{"type":"array","items":{"$ref":"#/components/schemas/featureAvailableMetadata"}},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"recipientIdGuid":{"type":"string"},"recipientSignatureProviders":{"type":"array","items":{"$ref":"#/components/schemas/recipientSignatureProvider"}},"recipientSuppliesTabs":{"type":"string"},"recipientType":{"type":"string"},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireIdLookup":{"type":"string","description":"When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireSignerCertificate":{"type":"string"},"requireSignOnPaper":{"type":"string"},"requireUploadSignature":{"type":"string"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The date and time the envelope was sent."},"signatureInfo":{"$ref":"#/components/schemas/recipientSignatureInformation"},"signedDateTime":{"type":"string","description":"Reserved: For DocuSign use only. "},"signInEachLocation":{"type":"string","description":"When set to **true**, specifies that the signer must sign in all locations."},"signInEachLocationMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupId":{"type":"string","description":"When set to **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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"The display name for the signing group. \n\nMaximum Length: 100 characters. "},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":" Lists the social ID type that can be used for recipient authentication."},"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."},"statusCode":{"type":"string"},"suppressEmails":{"type":"string"},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. "},"templateRequired":{"type":"string","description":"When set to **true**, the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string"},"userId":{"type":"string"},"webFormRecipientViewId":{"type":"string"}},"title":"authorizedSignatory"},"carbonCopy":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"agentCanEditEmail":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."},"agentCanEditName":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"clientUserId":{"type":"string","description":"Not applicable for Carbon Copy recipients."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"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."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name. Maximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"linkedAccountConfigurationId":{"type":"string"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"suppressEmails":{"type":"string","description":"When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"description":"Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. ","title":"carbonCopy"},"certifiedDelivery":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"agentCanEditEmail":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."},"agentCanEditName":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"email":{"type":"string","description":"The recipient's email address."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name. Maximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"status":{"type":"string","description":"The status of the recipient. 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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"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."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"description":"Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.","title":"certifiedDelivery"},"editor":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"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."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name.\n\nMaximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"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."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"description":"A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.","title":"editor"},"notaryHost":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"email":{"type":"string","description":"The notary's email address.\n\nMaximum Length: 100 characters."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"hostRecipientId":{"type":"string","description":"The host recipient ID."},"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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string","description":"The notary's full legal name.\n\nMaximum Length: 100 characters."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"note":{"type":"string","description":"A note sent to the notary in the signing email.\nThis note is visible only to this notary.\n\nMaximum Length: 1000 characters."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"suppressEmails":{"type":"string","description":"When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"description":"This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n","title":"notaryHost"},"inPersonSigner":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"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."},"bulkSendV2Recipient":{"type":"string"},"canSignOffline":{"type":"string","description":"When **true,** specifies that the signer can perform the signing ceremony offline."},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason 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."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"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."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"hostEmailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"hostNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"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."},"inPersonSigningTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"notaryHost":{"$ref":"#/components/schemas/notaryHost"},"notaryId":{"type":"string"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"offlineAttributes":{"$ref":"#/components/schemas/offlineAttributes"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"},"recipientSuppliesTabs":{"type":"string","description":"When **true,** specifies that the recipient creates the tabs."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireSignOnPaper":{"type":"string","description":"When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign."},"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."},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"signatureInfo":{"$ref":"#/components/schemas/recipientSignatureInformation"},"signedDateTime":{"type":"string","description":"Reserved for Docusign."},"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."},"signerEmailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signerFirstName":{"type":"string","description":"The signer's first name."},"signerFirstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signerLastName":{"type":"string","description":"The signer's last name."},"signerLastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signerName":{"type":"string","description":"Required. The full legal name of a signer for the envelope. \n\nMaximum Length: 100 characters.\n\n\n"},"signerNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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)."},"signInEachLocationMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupId":{"type":"string","description":"Not applicable. You cannot use a signing group for an in-person signer."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Not applicable."},"signingGroupType":{"type":"string"},"signingGroupUsers":{"type":"array","items":{"$ref":"#/components/schemas/userInfo"},"description":"Not applicable."},"smsAuthentication":{"$ref":"#/components/schemas/recipientSMSAuthentication"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"suppressEmails":{"type":"string","description":"When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"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](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient).","title":"inPersonSigner"},"intermediary":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"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."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name. Maximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"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."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"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.","title":"intermediary"},"notaryRecipient":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"agentCanEditEmail":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."},"agentCanEditName":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"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."},"bulkRecipientsUri":{"type":"string","description":"Reserved for Docusign."},"bulkSendV2Recipient":{"type":"string"},"canNotaryCorrectEnvelope":{"type":"string"},"canSignOffline":{"type":"string","description":"When **true,** specifies that the signer can perform the signing ceremony offline."},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"creationReason":{"type":"string","description":"The reason why the item was created."},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"defaultRecipient":{"type":"string","description":"When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient."},"delegatedBy":{"$ref":"#/components/schemas/delegationInfo"},"delegatedTo":{"type":"array","items":{"$ref":"#/components/schemas/delegationInfo"}},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"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."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The user's first name. \nMaximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"isBulkRecipient":{"type":"string","description":"Reserved for Docusign."},"isBulkRecipientMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lastName":{"type":"string","description":"The user's last name.\nMaximum Length: 50 characters."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"liveOakStartURL":{"type":"string","description":"URL that directs the recipient to LiveOak to complete the remote online notarization process. This property is read-only."},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string","description":"The full legal name of the recipient. Maximum length: 100 characters.\n\nNote: You must always set a value for this property in requests, even if `firstName` and `lastName` are set."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"notaryId":{"type":"string","description":"Not applicable to Notary tab."},"notarySignerEmailSent":{"type":"string"},"notarySigners":{"type":"array","items":{"type":"string"},"description":"An array of strings that correspond to the `recipientId` of each signer in the notary group. This property is read-only."},"notarySourceType":{"type":"string","description":"Valid values:\n\n- `firstparty`: Set this value if using the [remote online notary](/docs/notary-api/how-to/send-signature-request-notary-group/) (RON) feature.\n- `thirdparty`: Set this value if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature."},"notaryThirdPartyPartner":{"type":"string","description":"Set this value to `onenotary` if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature."},"notaryType":{"type":"string","description":"Set this value to `remote` if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature."},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"offlineAttributes":{"$ref":"#/components/schemas/offlineAttributes"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"},"recipientSuppliesTabs":{"type":"string","description":"When **true,** specifies that the recipient creates the tabs."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireSignOnPaper":{"type":"string","description":"When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign."},"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."},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"signatureInfo":{"$ref":"#/components/schemas/recipientSignatureInformation"},"signedDateTime":{"type":"string","description":"Reserved for 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)."},"signInEachLocationMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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."},"statusCode":{"type":"string","description":"Reserved for Docusign."},"suppressEmails":{"type":"string","description":"When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"title":"notaryRecipient"},"notaryWitness":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"addAccessCodeToEmail":{"type":"string","description":"This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"}},"agentCanEditEmail":{"type":"string"},"agentCanEditName":{"type":"string"},"allowSystemOverrideForLockedRecipient":{"type":"string"},"autoNavigation":{"type":"string"},"autoRespondedReason":{"type":"string"},"bulkRecipientsUri":{"type":"string","description":"Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information."},"bulkSendV2Recipient":{"type":"string"},"canSignOffline":{"type":"string","description":"When set to **true**, specifies that the signer can perform the signing ceremony offline."},"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. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to  **true**, an error is generated on sending.ng. \n\nMaximum length: 100 characters. "},"completedCount":{"type":"string"},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"creationReason":{"type":"string"},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document."},"defaultRecipient":{"type":"string"},"delegatedBy":{"$ref":"#/components/schemas/delegationInfo"},"delegatedTo":{"type":"array","items":{"$ref":"#/components/schemas/delegationInfo"}},"deliveredDateTime":{"type":"string","description":"Reserved: For DocuSign use only."},"deliveryMethod":{"type":"string","description":"Reserved: For DocuSign use only."},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string"},"designatorIdGuid":{"type":"string"},"documentTemplateId":{"type":"string"},"documentVisibility":{"type":"array","items":{"$ref":"#/components/schemas/documentVisibility"}},"email":{"type":"string"},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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\nIf set to `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 that is launched by any partner.\n\nIt is important to remember 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 process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `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 fort the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved:"},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The user's first name. \nMaximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string"},"fullNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckConfigurationName":{"type":"string","description":"Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.\n\n*Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"inheritEmailNotificationConfiguration":{"type":"string","description":"When set to **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. "},"isBulkRecipient":{"type":"string"},"isBulkRecipientMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lastName":{"type":"string"},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string"},"lockedRecipientSmsEditable":{"type":"string"},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"notaryId":{"type":"string"},"notarySignerEmailSent":{"type":"string"},"note":{"type":"string","description":"Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.\n\nMaximum Length: 1000 characters."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"offlineAttributes":{"$ref":"#/components/schemas/offlineAttributes"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved:"},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"recipientFeatureMetadata":{"type":"array","items":{"$ref":"#/components/schemas/featureAvailableMetadata"}},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"recipientIdGuid":{"type":"string"},"recipientSignatureProviders":{"type":"array","items":{"$ref":"#/components/schemas/recipientSignatureProvider"}},"recipientSuppliesTabs":{"type":"string"},"recipientType":{"type":"string"},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireIdLookup":{"type":"string","description":"When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireSignerCertificate":{"type":"string"},"requireSignOnPaper":{"type":"string"},"requireUploadSignature":{"type":"string"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The date and time the envelope was sent."},"signatureInfo":{"$ref":"#/components/schemas/recipientSignatureInformation"},"signedDateTime":{"type":"string","description":"Reserved: For DocuSign use only. "},"signInEachLocation":{"type":"string","description":"When set to **true**, specifies that the signer must sign in all locations."},"signInEachLocationMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupId":{"type":"string","description":"When set to **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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"The display name for the signing group. \n\nMaximum Length: 100 characters. "},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":" Lists the social ID type that can be used for recipient authentication."},"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."},"statusCode":{"type":"string"},"suppressEmails":{"type":"string"},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. "},"templateRequired":{"type":"string","description":"When set to **true**, the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string"},"type":{"type":"string"},"userId":{"type":"string"},"webFormRecipientViewId":{"type":"string"},"witnessFor":{"type":"string"},"witnessForGuid":{"type":"string"}},"title":"notaryWitness"},"participant":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"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 string can be a maximum of 100 characters."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"email":{"type":"string"},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The user's first name. \nMaximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"lastName":{"type":"string","description":"The user's last name.\nMaximum Length: 50 characters."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string"},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"participateFor":{"type":"string"},"participateForGuid":{"type":"string"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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."},"statusCode":{"type":"string","description":"Reserved for Docusign."},"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."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"title":"participant"},"sealSign":{"type":"object","properties":{"accessCode":{"type":"string","description":"Not applicable."},"accessCodeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"addAccessCodeToEmail":{"type":"string","description":"Not applicable."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"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."},"bulkSendV2Recipient":{"type":"string"},"clientUserId":{"type":"string","description":"Not applicable."},"completedCount":{"type":"string","description":"Not applicable."},"customFields":{"type":"array","items":{"type":"string"},"description":"Not applicable."},"declinedDateTime":{"type":"string","description":"Not applicable."},"declinedReason":{"type":"string","description":"Not applicable."},"deliveredDateTime":{"type":"string","description":"Not applicable."},"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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"documentVisibility":{"type":"array","items":{"$ref":"#/components/schemas/documentVisibility"},"description":"Not applicable."},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"embeddedRecipientStartURL":{"type":"string","description":"Not applicable."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckConfigurationName":{"type":"string","description":"Not applicable."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"inheritEmailNotificationConfiguration":{"type":"string","description":"Not applicable."},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"name":{"type":"string","description":"Not applicable."},"note":{"type":"string","description":"Not applicable."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Not applicable."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"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."},"recipientSignatureProviders":{"type":"array","items":{"$ref":"#/components/schemas/recipientSignatureProvider"},"description":"(Required) Indicates which electronic seal to apply on documents when creating an envelope."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireIdLookup":{"type":"string","description":"Not applicable."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"(Optional, default: 1)\nSpecifies the routing order of the electronic seal in the envelope.\nThe routing order assigned to your electronic seal cannot be shared with another recipient.\nIt is recommended that you set a routing order for your electronic seals."},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"Not applicable."},"signedDateTime":{"type":"string","description":"Not applicable."},"smsAuthentication":{"$ref":"#/components/schemas/recipientSMSAuthentication"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"suppressEmails":{"type":"string","description":"Not applicable."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"Not applicable."},"userId":{"type":"string","description":"Not applicable."},"webFormRecipientViewId":{"type":"string"}},"description":"Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nExample:\n\n```text\n\"recipients\": {\n      \"seals\": [\n        {\n          \"recipientId\": \"1\",\n          \"routingOrder\" : 1,\n          \"recipientSignatureProviders\": [\n            {\n              \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"\n            }\n        ]\n      }\n    ]\n  },\n    .\n    .\n    .\n```\n\nFor more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html).","title":"sealSign"},"signer":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"agentCanEditEmail":{"type":"string","description":"Optional element. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."},"agentCanEditName":{"type":"string","description":"Optional. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"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."},"bulkRecipientsUri":{"type":"string","description":"Reserved for Docusign."},"bulkSendV2Recipient":{"type":"string"},"canSignOffline":{"type":"string","description":"When **true,** specifies that the signer can perform the signing ceremony offline."},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"creationReason":{"type":"string","description":"The reason why the item was created."},"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.\n\nEach recipient may be assigned a maximum of 3 custom fields, and each customField string can be a maximum of 100 characters."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"defaultRecipient":{"type":"string","description":"When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient."},"delegatedBy":{"$ref":"#/components/schemas/delegationInfo"},"delegatedTo":{"type":"array","items":{"$ref":"#/components/schemas/delegationInfo"}},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"email":{"type":"string","description":"The recipient's email address. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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 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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name. Maximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"isBulkRecipient":{"type":"string","description":"When **true,** this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.\n\nNote that when this is true the email and name for the recipient becomes [bulk@recipient.com](mailto:bulk@recipient.com) and \"Bulk Recipient\". These fields can not be changed for the bulk recipient."},"isBulkRecipientMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"notaryId":{"type":"string","description":"The `recipientId` of the notary for this signer."},"notarySignerEmailSent":{"type":"string"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"offlineAttributes":{"$ref":"#/components/schemas/offlineAttributes"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"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`."},"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."},"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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"},"recipientSuppliesTabs":{"type":"string","description":"When **true,** specifies that the recipient creates the tabs."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"requireSignerCertificate":{"type":"string","description":"Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. Valid values:\n\n- `docusign_express`: Requires a Docusign Express certificate.\n- `safe`: Requires a SAFE-BioPharma certificate.\n- `open_trust`: Requires an OpenTrust certificate.\n\n**Important:** There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information."},"requireSignOnPaper":{"type":"string","description":"When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign."},"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."},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"signatureInfo":{"$ref":"#/components/schemas/recipientSignatureInformation"},"signedDateTime":{"type":"string","description":"Reserved for 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)."},"signInEachLocationMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"status":{"type":"string","description":"Specifies the status of the recipient at the time of the request. This property is read-only. Possible values are:\n\n- `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status).\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing web site. This is not an email delivery of the documents in an envelope.\n- `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed.\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step.\n- `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used by the Docusign webapp (also known as the Docusign console) to inform senders about the auto-responded email."},"statusCode":{"type":"string","description":"Reserved for Docusign."},"suppressEmails":{"type":"string","description":"When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"}},"description":"A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.","title":"signer"},"witness":{"type":"object","properties":{"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."},"accessCodeMetadata":{"$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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"agentCanEditEmail":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."},"agentCanEditName":{"type":"string","description":"Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."},"allowSystemOverrideForLockedRecipient":{"type":"string","description":"When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"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."},"bulkRecipientsUri":{"type":"string","description":"Reserved for Docusign."},"bulkSendV2Recipient":{"type":"string"},"canSignOffline":{"type":"string","description":"When **true,** specifies that the signer can perform the signing ceremony offline."},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"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."},"consentDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/consentDetails"}},"creationReason":{"type":"string","description":"The reason why the recipient was created (for example, `sender`). This property is read-only."},"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."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"declinedReason":{"type":"string","description":"The reason the recipient declined the document. This property is read-only."},"defaultRecipient":{"type":"string","description":"When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient."},"delegatedBy":{"$ref":"#/components/schemas/delegationInfo"},"delegatedTo":{"type":"array","items":{"$ref":"#/components/schemas/delegationInfo"}},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. 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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"deliveryMethodMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"designatorId":{"type":"string","description":"Reserved for Docusign."},"designatorIdGuid":{"type":"string","description":"Reserved for Docusign."},"documentTemplateId":{"type":"string"},"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.**"},"email":{"type":"string","description":"The recipient's email address."},"emailMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"emailRecipientPostSigningURL":{"type":"string"},"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]]`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"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."},"faxNumber":{"type":"string","description":"Reserved for Docusign."},"faxNumberMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"firstName":{"type":"string","description":"The recipient's first name. Maximum Length: 50 characters."},"firstNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"fullName":{"type":"string","description":"Reserved for Docusign."},"fullNameMetadata":{"$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."},"idCheckConfigurationNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"idCheckInformationInput":{"$ref":"#/components/schemas/idCheckInformationInput"},"identityVerification":{"$ref":"#/components/schemas/recipientIdentityVerification"},"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."},"isBulkRecipient":{"type":"string","description":"Reserved for Docusign."},"isBulkRecipientMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lastName":{"type":"string","description":"The recipient's last name."},"lastNameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"lockedRecipientPhoneAuthEditable":{"type":"string","description":"Reserved for Docusign."},"lockedRecipientSmsEditable":{"type":"string","description":"Reserved for Docusign."},"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."},"nameMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"notaryId":{"type":"string"},"notarySignerEmailSent":{"type":"string"},"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."},"noteMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"offlineAttributes":{"$ref":"#/components/schemas/offlineAttributes"},"phoneAuthentication":{"$ref":"#/components/schemas/recipientPhoneAuthentication"},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"proofFile":{"$ref":"#/components/schemas/recipientProofFile"},"recipientAttachments":{"type":"array","items":{"$ref":"#/components/schemas/recipientAttachment"},"description":"Reserved for Docusign."},"recipientAuthenticationStatus":{"$ref":"#/components/schemas/authenticationStatus"},"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."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"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."},"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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"},"recipientSuppliesTabs":{"type":"string","description":"When **true,** specifies that the recipient creates the tabs."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"recipientTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireIdLookupMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"requireSignOnPaper":{"type":"string","description":"When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign."},"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."},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"routingOrderMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"signatureInfo":{"$ref":"#/components/schemas/recipientSignatureInformation"},"signedDateTime":{"type":"string","description":"Reserved for 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)."},"signInEachLocationMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"signingGroupIdMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."},"signingGroupType":{"type":"string"},"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"},"socialAuthentications":{"type":"array","items":{"$ref":"#/components/schemas/socialAuthentication"},"description":"Deprecated."},"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`."},"statusCode":{"type":"string","description":"The code associated with the recipient's status. This property is read-only."},"suppressEmails":{"type":"string","description":"When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"totalTabCount":{"type":"string","description":"The total number of tabs in the documents. This property is read-only."},"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."},"webFormRecipientViewId":{"type":"string"},"witnessFor":{"type":"string","description":"The `recipientId` of the person or party for whom the recipient is a witness."},"witnessForGuid":{"type":"string","description":"Not used. Use the `witnessFor` property instead."}},"description":"A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.","title":"witness"},"recipients":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/agent"},"description":"A list of agent recipients assigned to the documents."},"authorizedSignatories":{"type":"array","items":{"$ref":"#/components/schemas/authorizedSignatory"}},"carbonCopies":{"type":"array","items":{"$ref":"#/components/schemas/carbonCopy"},"description":"A list of carbon copy recipients assigned to the documents."},"certifiedDeliveries":{"type":"array","items":{"$ref":"#/components/schemas/certifiedDelivery"},"description":"A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."},"currentRoutingOrder":{"type":"string","description":"The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."},"editors":{"type":"array","items":{"$ref":"#/components/schemas/editor"},"description":"A list of users who can edit the envelope."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"inPersonSigners":{"type":"array","items":{"$ref":"#/components/schemas/inPersonSigner"},"description":"Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."},"intermediaries":{"type":"array","items":{"$ref":"#/components/schemas/intermediary"},"description":"Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."},"notaries":{"type":"array","items":{"$ref":"#/components/schemas/notaryRecipient"},"description":"A list of notary recipients on the envelope."},"notaryWitnesses":{"type":"array","items":{"$ref":"#/components/schemas/notaryWitness"}},"participants":{"type":"array","items":{"$ref":"#/components/schemas/participant"}},"recipientCount":{"type":"string","description":"The number of recipients in the envelope."},"seals":{"type":"array","items":{"$ref":"#/components/schemas/sealSign"},"description":"A list of electronic seals to apply to documents."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/signer"},"description":"A list of signers on the envelope."},"witnesses":{"type":"array","items":{"$ref":"#/components/schemas/witness"},"description":"A list of signers who act as witnesses on the envelope."}},"description":"Specifies the envelope recipients.","title":"recipients"},"folderItem_v2":{"type":"object","properties":{"completedDateTime":{"type":"string","description":"If the item is an envelope, this is the UTC DateTime when the envelope was completed."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"envelopeId":{"type":"string","description":"If the item is an envelope, this is the ID of the envelope."},"envelopeUri":{"type":"string","description":"If the item is an envelope, this is the URI for retrieving it."},"expireDateTime":{"type":"string","description":"The date and time the envelope is set to expire."},"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."},"is21CFRPart11":{"type":"string","description":"When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"ownerName":{"type":"string","description":"The name of the user who owns the folder."},"recipients":{"$ref":"#/components/schemas/recipients"},"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."},"senderEmail":{"type":"string","description":"The sender's email address."},"senderName":{"type":"string","description":"The sender's name."},"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."},"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."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "},"templateUri":{"type":"string","description":"The URI for retrieving the template."}},"description":"Information about folder item results.","title":"folderItem_v2"},"folder":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"filter":{"$ref":"#/components/schemas/filter"},"folderId":{"type":"string","description":"The ID of the folder."},"folderItems":{"type":"array","items":{"$ref":"#/components/schemas/folderItem_v2"},"description":"A list of envelopes and templates that the folder contains."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"},"description":"A collection of folder objects returned in a response."},"hasAccess":{"type":"string","description":"When **true,** the current user has access to the folder."},"hasSubFolders":{"type":"string","description":"When **true,** the folder has subfolders."},"itemCount":{"type":"string","description":"The number of items in the folder."},"name":{"type":"string","description":"The name of the folder."},"owner":{"$ref":"#/components/schemas/userInfo"},"parentFolderId":{"type":"string","description":"The ID of the parent folder, or the special value `root` for the root folder."},"parentFolderUri":{"type":"string","description":"The URI of the parent folder."},"subFolderCount":{"type":"string","description":"The number of subfolders."},"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)"},"uri":{"type":"string","description":"The URI for the folder."}},"description":"This object contains details about a folder.","title":"folder"},"lockInformation":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"lockDurationInSeconds":{"type":"string","description":"The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds."},"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."},"lockedByUser":{"$ref":"#/components/schemas/userInfo"},"lockedUntilDateTime":{"type":"string","description":"The date and time that the lock expires."},"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."},"lockType":{"type":"string","description":"The type of lock. Currently `edit` is the only supported type."},"useScratchPad":{"type":"string","description":"When **true,** a scratchpad is used to edit information."}},"title":"lockInformation"},"notification":{"type":"object","properties":{"expirations":{"$ref":"#/components/schemas/expirations"},"reminders":{"$ref":"#/components/schemas/reminders"},"useAccountDefaults":{"type":"string","description":"When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"}},"description":"A complex element that specifies the notification settings for the envelope.","title":"notification"},"powerFormRecipient":{"type":"object","properties":{"accessCode":{"type":"string","description":"(Optional) The access code that the recipient must enter to access the PowerForm.\n\nMaximum Length: 50 characters. The code must also conform to the account's access code format setting.\n\nIf blank but the signer accessCode property is set in the envelope, then that value is used.\n\nIf blank and the signer accessCode property is not set, then the access code is not required."},"accessCodeLocked":{"type":"string","description":"When **true,** the `accessCode` property is locked and cannot be edited."},"accessCodeRequired":{"type":"string","description":"When **true,** the recipient must enter the `accessCode` to access the PowerForm."},"email":{"type":"string","description":"The email address of the recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank."},"emailLocked":{"type":"string","description":"When **true,** the recipient's email address is locked and cannot be edited."},"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."},"idCheckRequired":{"type":"string","description":"Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope.\n- `never`: Authentication checks are not performed on any envelopes.\n- `optional:` Authentication is configurable per envelope."},"name":{"type":"string","description":"The name of the PowerForm recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank."},"recipientType":{"type":"string","description":"The recipient type, as specified by the following values:\n\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."},"roleName":{"type":"string","description":"The role associated with the recipient (for example, `Member`).\n\nThis property is required when you are working with template recipients and PowerForm recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"templateRequiresIdLookup":{"type":"string","description":"When **true,** the template used to create the PowerForm requires ID lookup for the recipient."},"userNameLocked":{"type":"string","description":"When **true,** the `userName` property for the recipient is locked and cannot be edited."}},"description":"**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.","title":"powerFormRecipient"},"powerForm":{"type":"object","properties":{"createdBy":{"type":"string","description":"The ID of the user who created the PowerForm."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"emailBody":{"type":"string","description":"The body of the email message sent to the recipients.\n\nMaximum length: 10000 characters."},"emailSubject":{"type":"string","description":"The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."},"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/envelope"}},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"instructions":{"type":"string","description":"The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters."},"isActive":{"type":"string","description":"When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\nWhen **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL.\n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender."},"lastUsed":{"type":"string","description":"The UTC DateTime when the PowerForm was last used."},"limitUseInterval":{"type":"string","description":"The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property."},"limitUseIntervalEnabled":{"type":"string","description":"When **true,** the `limitUseInterval` is enabled."},"limitUseIntervalUnits":{"type":"string","description":"The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`."},"maxUseEnabled":{"type":"string","description":"When **true,** you can set a maximum number of uses for the PowerForm."},"name":{"type":"string","description":"The name of the PowerForm."},"powerFormId":{"type":"string","description":"The ID of the PowerForm."},"powerFormUrl":{"type":"string","description":"The URL for the PowerForm."},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/powerFormRecipient"},"description":"An array of recipient objects that provides details about the recipients of the envelope."},"senderName":{"type":"string","description":"The sender's name."},"senderUserId":{"type":"string","description":"The ID of the sender."},"signingMode":{"type":"string","description":"The signing mode to use. Valid values are:\n\n- `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document.\n- `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check).\n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`."},"templateId":{"type":"string","description":"The ID of the template used to create the PowerForm."},"templateName":{"type":"string","description":"The name of the template used to create the PowerForm."},"timesUsed":{"type":"string","description":"The number of times the PowerForm has been used."},"uri":{"type":"string","description":"The URI for the PowerForm."},"usesRemaining":{"type":"string","description":"The number of times the PowerForm can still be used."}},"description":"Contains details about a PowerForm.","title":"powerForm"},"envelopeDelayRule":{"type":"object","properties":{"delay":{"type":"string","description":"A string timespan representing the duration of the sending delay. The timespan is in the format `d.hh:mm:ss` where `d` is the number of days, `hh` is the number of hours (measured on a 24-hour clock), `mm` is minutes, and `ss` is seconds. The maximum delay is 30 days."},"resumeDate":{"type":"string","description":"An ISO 8601 formatted datetime string indicating the date and time that the envelope will be sent. The specified datetime must occur in the future. It must not exceed 30 days from the time that the request is made."}},"description":"A user-specified object that describes the envelope delay.\n\nTo indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used.","title":"envelopeDelayRule"},"scheduledSending":{"type":"object","properties":{"bulkListId":{"type":"string","description":"The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation."},"resumeDate":{"type":"string","description":"The timestamp of when the envelope is scheduled to be sent in ISO 8601 format.\n\nThis property is read-only."},"rules":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDelayRule"},"description":"User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified."},"status":{"type":"string","description":"Status of the scheduled sending job. Valid values:\n\n- `pending`: The envelope has not yet been sent and the scheduled sending delay has not been initiated.\n- `started`: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient.\n- `completed`: The delay has elapsed and the envelope has been sent to the first recipient.\n\nThis property is read-only."}},"description":"A complex element that specifies the scheduled sending settings for the envelope.","title":"scheduledSending"},"delayedRouting":{"type":"object","properties":{"resumeDate":{"type":"string","description":"The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is `null` if the workflow step has not been initiated.\n\nThis property is read-only."},"rules":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDelayRule"},"description":"User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified."},"status":{"type":"string","description":"Status of the delayed routing step. Valid values:\n\n- `pending`: The workflow step has not been reached and the delay has not been initiated.\n- `started`: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients.\n- `completed`: The delay has elapsed and the envelope has been sent to the workflow step's recipients.\n\nThis property is read-only."}},"description":"A complex element that specifies the delayed routing settings for the workflow step.","title":"delayedRouting"},"conditionalRecipientRuleFilter":{"type":"object","properties":{"operator":{"type":"string","description":"How the tab value is compared to the `value` property. Valid values:\n\n- `equals`\n- `greaterThan`\n- `greaterThanEquals`\n- `lessThan`\n- `lessThanEquals`\n- `filled`\n- `selected`"},"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`."},"scope":{"type":"string","description":"The scope under which the condition is evaluated. Valid values:\n\n- `tabs`"},"tabId":{"type":"string","description":"The unique identifier for the 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."},"tabType":{"type":"string","description":"Indicates the type of tab (for example, `signHere` or `initialHere`)."},"value":{"type":"string","description":"A set value to which the tab's actual value is compared."}},"title":"conditionalRecipientRuleFilter"},"conditionalRecipientRuleCondition":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/conditionalRecipientRuleFilter"}},"order":{"type":"string","description":"An integer that specifies the order in which rules are processed.\nLower values are processed before higher values."},"recipientLabel":{"type":"string","description":"An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/)."}},"title":"conditionalRecipientRuleCondition"},"recipientOption":{"type":"object","properties":{"email":{"type":"string","description":"The email ID of the agent. This property is required. Maximum length: 100 characters."},"name":{"type":"string","description":"The full legal name of the recipient. Maximum length: 100 characters."},"recipientLabel":{"type":"string","description":"An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/)."},"roleName":{"type":"string","description":"Specifies the signing group role of the recipient. This property is required."},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."}},"description":"Describes a recipient who is a member of a conditional group.","title":"recipientOption"},"recipientGroup":{"type":"object","properties":{"groupMessage":{"type":"string","description":"The group message, typically a description of the group."},"groupName":{"type":"string","description":"The name of the group."},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/recipientOption"},"description":"An array of recipient objects that provides details about the recipients of the envelope."}},"description":"Describes a group of recipients.","title":"recipientGroup"},"conditionalRecipientRule":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/conditionalRecipientRuleCondition"},"description":"An array of conditions that define when the recipients will be used."},"order":{"type":"string","description":"An integer that specifies the order in which rules are processed.\nLower values are processed before higher values."},"recipientGroup":{"$ref":"#/components/schemas/recipientGroup"},"recipientId":{"type":"string","description":"The ID of the recipient to whom the condition will be applied. This value should match the `recipientId` defined in the recipient object."}},"description":"A rule that defines a set of recipients and the conditions under which they will be used for the envelope.","title":"conditionalRecipientRule"},"recipientRules":{"type":"object","properties":{"conditionalRecipients":{"type":"array","items":{"$ref":"#/components/schemas/conditionalRecipientRule"}}},"title":"recipientRules"},"recipientRouting":{"type":"object","properties":{"rules":{"$ref":"#/components/schemas/recipientRules"}},"description":"Describes the recipient routing rules.","title":"recipientRouting"},"workflowStep":{"type":"object","properties":{"action":{"type":"string","description":"Indicates the action to perform. Valid values:\n\n- `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached."},"completedDate":{"type":"string","description":"The timestamp of when the workflow step transitioned to `completed` status.\n\nThis property is read-only."},"delayedRouting":{"$ref":"#/components/schemas/delayedRouting"},"itemId":{"type":"string","description":"The unique ID of the item being triggered."},"recipientRouting":{"$ref":"#/components/schemas/recipientRouting"},"status":{"type":"string","description":"The status of the step. Valid values:\n\n- `inactive`\n- `in_progress`\n- `paused`\n- `pending`\n- `completed`\n\nThis property is read-only."},"triggeredDate":{"type":"string","description":"The timestamp of when the workflow step transitioned to `in_progress` status.\n\nThis property is read-only."},"triggerOnItem":{"type":"string","description":"The type of item that triggers this workflow step. Valid values:\n\n- `routing_order`"},"workflowStepId":{"type":"string","description":"A unique identifier for this workflow step.\n\nThis property is read-only."}},"description":"Describes a single step in a workflow.","title":"workflowStep"},"workflow":{"type":"object","properties":{"currentWorkflowStepId":{"type":"string","description":"The `workflowStepId` of the current step.\nThis is not an index into the `workflowSteps` array in this object.\nSee the `workflowStep` object."},"overwriteUpdateMode":{"type":"string"},"resumeDate":{"type":"string","description":"The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the `resumeDate` property on `scheduledSending` and the `resumeDate` property on the current `workflowStep`.\n\nThis property is read-only."},"scheduledSending":{"$ref":"#/components/schemas/scheduledSending"},"workflowStatus":{"type":"string","description":"The status of the workflow:\n\n- `paused` if the workflow is paused\n- `in_progress` if the workflow is in progress"},"workflowSteps":{"type":"array","items":{"$ref":"#/components/schemas/workflowStep"},"description":"An array of workflow steps."}},"description":"Describes the workflow for an envelope.","title":"workflow"},"envelope":{"type":"object","properties":{"accessControlListBase64":{"type":"string","description":"Reserved for Docusign."},"allowComments":{"type":"string","description":"When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document."},"allowMarkup":{"type":"string","description":"When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level."},"allowReassign":{"type":"string","description":"When **true,** the recipient can redirect an envelope to a more appropriate recipient."},"allowViewHistory":{"type":"string","description":"When **true,** recipients can view the history of the envelope."},"anySigner":{"type":"string","description":"Deprecated. This feature has been replaced by signing groups."},"asynchronous":{"type":"string","description":"When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the\nConnect notification."},"attachmentsUri":{"type":"string","description":"Contains a URL for retrieving the attachments that are associated with the envelope."},"authoritativeCopy":{"type":"string","description":"When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"},"authoritativeCopyDefault":{"type":"string","description":"The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"brandId":{"type":"string","description":"The ID of the brand."},"brandLock":{"type":"string","description":"When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."},"burnDefaultTabData":{"type":"string"},"certificateUri":{"type":"string","description":"The URI for retrieving certificate information."},"completedDateTime":{"type":"string","description":"Specifies the date and time this item was completed."},"copyRecipientData":{"type":"string"},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"customFields":{"$ref":"#/components/schemas/customFields"},"customFieldsUri":{"type":"string","description":"The URI for retrieving custom fields."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"deletedDateTime":{"type":"string","description":"Reserved for Docusign."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. This property is read-only."},"disableResponsiveDocument":{"type":"string","description":"When **true,** responsive documents are disabled for the envelope."},"documentBase64":{"type":"string","description":"Reserved for Docusign."},"documentsCombinedUri":{"type":"string","description":"The URI for retrieving all of the documents associated with the envelope as a single PDF file."},"documentsUri":{"type":"string","description":"The URI for retrieving all of the documents associated with the envelope as separate files."},"emailBlurb":{"type":"string","description":"This is the same as the email body. If specified it is included in email body for all envelope recipients."},"emailSettings":{"$ref":"#/components/schemas/emailSettings"},"emailSubject":{"type":"string","description":"The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."},"enableWetSign":{"type":"string","description":"When **true,** the signer is allowed to print the document and sign it on paper."},"enforceSignerVisibility":{"type":"string","description":"When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings](https://admindemo.docusign.com/authenticate?goTo=sending) will be enforced for the envelope. See [Fields and Properties](https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html) for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.\n\n**Note:** To use this functionality, [document visibility](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/) must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/en/contactSupport#) or your account manager to find out whether document visibility is available for your production account plan."},"envelopeAttachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"},"description":"An array of attachment objects that provide information about the attachments that are associated with the envelope."},"envelopeClassification":{"type":"string"},"envelopeCustomMetadata":{"$ref":"#/components/schemas/envelopeCustomMetadata"},"envelopeDocuments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDocument"},"description":"An array containing information about the documents that are included in the envelope."},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"envelopeIdStamping":{"type":"string","description":"When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."},"envelopeLocation":{"type":"string","description":"Reserved for Docusign."},"envelopeMetadata":{"$ref":"#/components/schemas/envelopeMetadata"},"envelopeUri":{"type":"string","description":"The URI for retrieving the envelope or envelopes."},"expireAfter":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"expireDateTime":{"type":"string","description":"The date and time that the envelope is set to expire. This value is determined by the `InitialSentDateTime` of the envelope and the `expireAfter` property of the `notification` object. (Note that the `expireAfter` property of the envelope itself is not used.)"},"expireEnabled":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"externalEnvelopeId":{"type":"string","description":"May contain an external identifier for the envelope."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"},"description":"A list of folder objects."},"hasComments":{"type":"string","description":"When **true,** indicates that users have added comments to the envelope."},"hasFormDataChanged":{"type":"string","description":"When **true,** indicates that the data collected through form fields on a document has changed."},"hasWavFile":{"type":"string","description":"When **true,** indicates that a .wav file used for voice authentication is included in the envelope."},"holder":{"type":"string","description":"Reserved for Docusign."},"initialSentDateTime":{"type":"string","description":"The date and time the envelope was initially sent."},"is21CFRPart11":{"type":"string","description":"When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."},"isDynamicEnvelope":{"type":"string","description":"When **true,** indicates that the envelope is a dynamic envelope."},"isSignatureProviderEnvelope":{"type":"string","description":"When **true,** indicates that the envelope is a signature-provided envelope."},"isTicketRelatedEnvelope":{"type":"string"},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"location":{"type":"string","description":"Reserved for Docusign."},"lockInformation":{"$ref":"#/components/schemas/lockInformation"},"messageLock":{"type":"string","description":"When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.\n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.\n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."},"notification":{"$ref":"#/components/schemas/notification"},"notificationUri":{"type":"string","description":"The URI for retrieving notifications."},"powerForm":{"$ref":"#/components/schemas/powerForm"},"purgeCompletedDate":{"type":"string","description":"The date that a purge was completed."},"purgeRequestDate":{"type":"string","description":"The date that a purge was requested."},"purgeState":{"type":"string","description":"Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)"},"recipients":{"$ref":"#/components/schemas/recipients"},"recipientsLock":{"type":"string","description":"When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."},"recipientsUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the recipients."},"sender":{"$ref":"#/components/schemas/userInfo"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"signerCanSignOnMobile":{"type":"string","description":"When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting."},"signingLocation":{"type":"string","description":"Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online."},"status":{"type":"string","description":"Indicates the envelope status. See [Envelope status code descriptions](/docs/esign-rest-api/esign101/concepts/envelopes/status-codes/#envelope-status-code-descriptions) for a list of valid values."},"statusChangedDateTime":{"type":"string","description":"The date and time when the status last changed."},"templatesUri":{"type":"string","description":"The URI for retrieving the templates."},"transactionId":{"type":"string","description":" Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."},"useDisclosure":{"type":"string","description":"When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients.\n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."},"uSigState":{"type":"string","description":"A property that is only used internally by Docusign."},"voidedDateTime":{"type":"string","description":"The date and time the envelope or template was voided."},"voidedReason":{"type":"string","description":"The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters."},"watermarkLanguage":{"type":"string"},"workflow":{"$ref":"#/components/schemas/workflow"}},"title":"envelope"},"envelopeTransactionStatus":{"type":"object","properties":{"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n- `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n- `created`: The envelope is created as a draft. It can be modified and sent later.\n- `declined`: The envelope has been declined by the recipients.\n- `delivered`: The envelope has been delivered to the recipients.\n- `sent`: The envelope will be sent to the recipients after the envelope is created.\n- `signed`: The envelope has been signed by the recipients.\n- `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope."},"transactionId":{"type":"string","description":" Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."}},"title":"envelopeTransactionStatus"},"envelopesInformation":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Reserved for Docusign."},"endPosition":{"type":"string","description":"The last index position in the result set."},"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/envelope"},"description":"Array of envelope information."},"envelopeSearchSource":{"type":"string"},"envelopeTransactionStatuses":{"type":"array","items":{"$ref":"#/components/schemas/envelopeTransactionStatus"},"description":"Array of envelope statuses and transaction IDs in the result set."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"},"description":"A list of folder objects."},"lastQueriedDateTime":{"type":"string","description":"The last time that a query was performed."},"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."},"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."},"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`."}},"description":"Result set for the Envelopes: listStatusChanges method","title":"envelopesInformation"},"bulkSendBatchSummary":{"type":"object","properties":{"action":{"type":"string"},"actionStatus":{"type":"string"},"batchId":{"type":"string","description":"The batch ID."},"batchName":{"type":"string","description":"The name of the batch."},"batchSize":{"type":"string","description":"The number of envelopes in the batch."},"batchUri":{"type":"string","description":"The batch details URI."},"failed":{"type":"string","description":"Number of envelopes that failed to send."},"queued":{"type":"string","description":"Number of envelopes peding processing."},"sent":{"type":"string","description":"Number of envelopes that have been sent."},"submittedDate":{"type":"string","description":"The time stamp of when the batch was created in ISO 8601 format."}},"description":"Summary status of a single batch.","title":"bulkSendBatchSummary"},"bulkSendBatchSummaries":{"type":"object","properties":{"batchSizeLimit":{"type":"string","description":"The maximum number of envelopes the account is permitted to submit in a given batch."},"bulkBatchSummaries":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendBatchSummary"},"description":"An array of batch summaries."},"bulkProcessQueueLimit":{"type":"string"},"bulkProcessTotalQueued":{"type":"string"},"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"queueLimit":{"type":"string","description":"Maximum number of envelopes an account is permitted to have in the queue at any one time."},"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."},"totalQueued":{"type":"string","description":"The number of envelopes currently pending processing for the entire account."},"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`."}},"description":"A list of bulk send batch summaries. ","title":"bulkSendBatchSummaries"},"bulkSendErrorStatus":{"type":"object","properties":{"created":{"type":"string","description":"The timestamp of when the error occurred in ISO 8601 format."},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorMessage":{"type":"string","description":"The error message generated during processing, if any."},"recipientEmails":{"type":"array","items":{"type":"string"},"description":"An array of email addresses for the failed bulk envelope.\n\nRecipient email/info of the failed bulk envelope."}},"description":"A single bulk send error report.","title":"bulkSendErrorStatus"},"bulkSendEnvelopesInfo":{"type":"object","properties":{"authoritativeCopy":{"type":"string","description":"When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"},"completed":{"type":"string"},"correct":{"type":"string"},"created":{"type":"string","description":"The UTC DateTime when the workspace user authorization was created."},"declined":{"type":"string"},"deleted":{"type":"string"},"delivered":{"type":"string"},"digitalSignaturesPending":{"type":"string"},"sent":{"type":"string","description":"The number of entries with a status of `sent`."},"signed":{"type":"string"},"timedOut":{"type":"string"},"transferCompleted":{"type":"string"},"voided":{"type":"string"}},"title":"bulkSendEnvelopesInfo"},"bulkSendBatchStatus":{"type":"object","properties":{"action":{"type":"string"},"actionStatus":{"type":"string"},"batchId":{"type":"string","description":"The batch ID."},"batchName":{"type":"string","description":"The batch name."},"batchSize":{"type":"string","description":"The number of of bulk envelopes submitted in the current batch"},"bulkErrors":{"type":"array","items":{"$ref":"#/components/schemas/bulkSendErrorStatus"},"description":"An array of error statuses."},"envelopeIdOrTemplateId":{"type":"string","description":"The ID of the draft envelope or template that was used to create the batch."},"envelopesInfo":{"$ref":"#/components/schemas/bulkSendEnvelopesInfo"},"envelopesUri":{"type":"string","description":"The URI to get all envelopes sent in the batch."},"failed":{"type":"string","description":"The number of envelopes that failed to process or send."},"mailingListId":{"type":"string","description":"The ID of the mailing list used to create the batch."},"mailingListName":{"type":"string"},"ownerUserId":{"type":"string"},"queued":{"type":"string","description":"The number of envelopes waiting in pending queue"},"resendsRemaining":{"type":"string"},"senderUserId":{"type":"string","description":"The ID of the sender."},"sent":{"type":"string","description":"The number of envelopes sent successfully."},"submittedDate":{"type":"string","description":"The timestamp of when the batch was submitted in ISO 8601 format."}},"description":"Result of `getBulkSendBatchStatus`","title":"bulkSendBatchStatus"},"bulkSendBatchActionRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to apply. Valid values:\n\n- `Resend`\n- `Correct`\n- `Void`\n\nThis property is required and case-sensitive. The value must correspond to the `bulkAction` query parameter."},"notification":{"$ref":"#/components/schemas/notification"},"voidReason":{"type":"string","description":"A string explaining why the envelope is voided. This value is shown in a message to the recipients.\n\nThis property is required if `action` is `Void`."}},"title":"bulkSendBatchActionRequest"},"bulkSendBatchRequest":{"type":"object","properties":{"batchName":{"type":"string","description":"The new name of the bulk send batch.\n\nThis property is required. The maximum length of the string is 500 characters."}},"title":"bulkSendBatchRequest"},"externalDocServiceErrorDetails":{"type":"object","properties":{"authenticationUrl":{"type":"string","description":"Reserved for Docusign."},"errorCode":{"type":"string","description":"A code associated with the error condition."},"message":{"type":"string"}},"title":"externalDocServiceErrorDetails"},"externalFile":{"type":"object","properties":{"date":{"type":"string","description":"The UTC date and time that the file or folder was last modified."},"hasCompositeTemplate":{"type":"string"},"id":{"type":"string","description":"The storage provider's ID for the file or folder."},"img":{"type":"string","description":"The file extension for a file.\n\n**Note:** If the item is a folder, this value is null."},"name":{"type":"string","description":"The full name of a file."},"ownerName":{"type":"string"},"size":{"type":"string","description":"The size of the file. The file size limit varies based on the cloud storage provider."},"supported":{"type":"string","description":"When **true,** Docusign supports the file type for upload."},"type":{"type":"string","description":"The type of cloud storage item. Valid values are:\n\n- `file`\n- `folder`"},"uri":{"type":"string","description":"The URI for the file or folder."}},"description":"This object contains information about a file or folder in cloud storage.","title":"externalFile"},"externalFolder":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"errorDetails":{"$ref":"#/components/schemas/externalDocServiceErrorDetails"},"id":{"type":"string","description":"A unique ID for the Salesforce object."},"items":{"type":"array","items":{"$ref":"#/components/schemas/externalFile"},"description":"If the tab is a list, this represents the values that are possible for the tab."},"name":{"type":"string"},"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."},"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`."},"skyDriveSkipToken":{"type":"string","description":"A OneDrive-only pagination token used to retrieve the next page of folders and files.\n\nDocusign’s OneDrive integration uses the Microsoft Graph API, which paginates results with a skip token instead of `start_position` and `end_position`. When a response includes a skip token, pass it in `sky_drive_skip_token` to request the next page. This property applies only to OneDrive connections and is ignored for other providers (Box, Dropbox, etc.)."},"startPosition":{"type":"string","description":"The starting index position of the current result set."},"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`."}},"title":"externalFolder"},"cloudStorageProvider":{"type":"object","properties":{"authenticationUrl":{"type":"string","description":"The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. "},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"redirectUrl":{"type":"string","description":"The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains."},"service":{"type":"string","description":"The service name for the cloud storage provider."},"serviceId":{"type":"string","description":"The DocuSign generated ID for the cloud storage provider"}},"description":"Contains details about a specific cloud storage provider.","title":"cloudStorageProvider"},"cloudStorageProviders":{"type":"object","properties":{"storageProviders":{"type":"array","items":{"$ref":"#/components/schemas/cloudStorageProvider"},"description":"An Array containing the storage providers associated with the user."}},"title":"cloudStorageProviders"},"connectEventData":{"type":"object","properties":{"format":{"type":"string","description":"Reserved for Docusign."},"includeData":{"type":"array","items":{"type":"string"},"description":"A string array of the data to be included.\nThe default is the empty array `[]`.\n\n- `attachments`: Include attachments associated with the envelope.\n- `custom_fields`: Include the custom fields associated with the envelope.\n- `documents`: Include the documents associated with the envelope.\n- `extensions`: Include information about the email settings associated with the envelope.\n- `folders`: Include the folder where the envelope exists.\n- `payment_tabs`: Include the payment tabs associated with the envelope.\n- `powerform`: Include the PowerForms associated with the envelope.\n- `prefill_tabs`: Include the [pre-filled tabs](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs/) associated with the envelope.\n- `recipients`: Include the recipients associated with the envelope.\n- `tabs`: Include the tabs associated with the envelope."},"version":{"type":"string","description":"Set this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default."}},"description":"This object lets you choose the data format of your Connect response.","title":"connectEventData"},"connectOAuthConfig":{"type":"object","properties":{"authorizationServerUrl":{"type":"string","description":"The token URL for your authorization server or OAuth service.\n\nThis property is required."},"clientId":{"type":"string","description":"The client ID assigned to your app by your authorization server or OAuth service.\n\nThis property is required."},"clientSecret":{"type":"string","description":"The secret value provided by your authorization server.\n\nThis property is required."},"customParameters":{"type":"object","additionalProperties":{"type":"string"}},"scope":{"type":"string","description":"The scopes that your app will request from the authorization server.\n\nThis property is optional.\n\n**Note:** If you are using Azure, this value is the application ID URI of the secified resource affixed with the `.default`. For example: `api://{{clientId}}/.default`"}},"description":"A complex object describing a Connect OAuth configuration.","title":"connectOAuthConfig"},"connectSalesforceField":{"type":"object","properties":{"dsAttribute":{"type":"string"},"dsLink":{"type":"string","description":"A URL that links to the information in the Docusign field."},"dsNode":{"type":"string"},"id":{"type":"string","description":"A unique ID for the Salesforce object."},"sfField":{"type":"string"},"sfFieldName":{"type":"string","description":"The name of the Salesforce field."},"sfFolder":{"type":"string","description":"The name of the Salesforce folder."},"sfLockedValue":{"type":"string"}},"description":"This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account.","title":"connectSalesforceField"},"connectSalesforceObject":{"type":"object","properties":{"active":{"type":"string","description":"When **true,** the `connectSalesforceObject` is active."},"description":{"type":"string","description":"A description of the `connectSalesforceObject`."},"id":{"type":"string","description":"The ID of the `connectSalesforceObject`."},"insert":{"type":"string"},"onCompleteOnly":{"type":"string","description":"When **true,** Salesforce is updated only when the envelope is complete."},"selectFields":{"type":"array","items":{"$ref":"#/components/schemas/connectSalesforceField"},"description":"The Docusign and Salesforce fields that you want to use to match a Salesforce object with Docusign information. This information tells Connect when to send updates to Salesforce."},"sfObject":{"type":"string","description":"The Salesforce.com object type, such as `case`, `contact`, or `opportunity`."},"sfObjectName":{"type":"string","description":"A name for the Salesforce object.\n\n**Note:** You can enter any name for the object. It does not have to match the `sfObject` property."},"updateFields":{"type":"array","items":{"$ref":"#/components/schemas/connectSalesforceField"},"description":"The Docusign and Salesforce fields that you want to update.\n\n**Note:** You can choose to update SalesForce (with information from Docusign) only, update Docusign only, or both."}},"description":"A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).","title":"connectSalesforceObject"},"connectCustomConfiguration":{"type":"object","properties":{"allowEnvelopePublish":{"type":"string","description":"Set this value to **true** to enable the webhook. The default property is **false.**"},"allowSalesforcePublish":{"type":"string","description":"When **true,** Docusign sends data to the designated Salesforce account through Connect. The default value is **true.**\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"allUsers":{"type":"string","description":"When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.**\n\n**Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"allUsersExcept":{"type":"string","description":"This flag enables you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.**\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"configurationType":{"type":"string","description":"The type of the configuration. Valid values:\n\n- `custom`: Creates an account-level configuration\n- `customrecipient`: Creates a Recipient Connect configuration\n- `salesforce`\n- `eOriginal`\n\nThis property is required."},"connectId":{"type":"string","description":"The Docusign-generated ID for the Connect configuration.\n\nThis property is read-only."},"deliveryMode":{"type":"string","description":"The delivery mode of the configuration. Valid values:\n\n- `SIM`\n- `Aggregate`\n\nThis property is required."},"disabledBy":{"type":"string"},"enableLog":{"type":"string","description":"When **true,** Connect logging is turned on. Docusign recommends that you enable this functionality to help troubleshoot any issues.\n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console.\n\nThis property is required."},"enableOAuthPerConfiguration":{"type":"string"},"envelopeEvents":{"type":"array","items":{"type":"string"},"description":"A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.\n\nWhen using any of\n[the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/),\nyou must include either the `envelopeEvents` property\nor the `recipientEvents` property.\nIf you are instead using the\n[JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/),\nuse the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property.\n\nThe [possible event statuses](/platform/webhooks/connect/event-triggers/) are:\n\n- `Sent`\n- `Delivered`\n- `Completed`\n- `Declined`\n- `Voided`\n\n**Note:** These values are case-sensitive.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"eventData":{"$ref":"#/components/schemas/connectEventData"},"events":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) are:\n\n- `envelope-created`\n- `envelope-sent`\n- `envelope-resent`\n- `envelope-delivered`\n- `envelope-completed`\n- `envelope-declined`\n- `envelope-voided`\n- `recipient-authenticationfailed`\n- `recipient-autoresponded`\n- `recipient-declined`\n- `recipient-delivered`\n- `recipient-completed`\n- `recipient-sent`\n- `recipient-resent`\n- `template-created`\n- `template-modified`\n- `template-deleted`\n- `envelope-corrected`\n- `envelope-purge`\n- `envelope-deleted`\n- `envelope-discard`\n- `recipient-reassign`\n- `recipient-delegate`\n- `recipient-finish-later`\n- `click-agreed`\n- `click-declined`\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"externalFolderId":{"type":"string","description":"The ID of an external folder.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"externalFolderLabel":{"type":"string","description":"The label for an external folder.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"groupIds":{"type":"array","items":{"type":"string"}},"includeCertificateOfCompletion":{"type":"string","description":"When **true,** the Connect Service includes the Certificate of Completion with completed envelopes.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"includeCertSoapHeader":{"type":"string"},"includeDocumentFields":{"type":"string","description":"When **true,** the document fields associated with the envelope's documents are included in the notification messages. Document fields are optional custom name-value pairs added to documents using the API.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"includeDocuments":{"type":"string","description":"Reserved for Docusign."},"includeEnvelopeVoidReason":{"type":"string","description":"When **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"includeHMAC":{"type":"string","description":"When **true,** Connect will use HMAC to verify the request.\n\nThis property is required."},"includeOAuth":{"type":"string"},"includeSenderAccountasCustomField":{"type":"string","description":"When **true,** Connect will include the sender account as custom field in the data.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"includeTimeZoneInformation":{"type":"string","description":"When **true,** Connect will include the envelope time zone information.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"integratorManaged":{"type":"string"},"name":{"type":"string","description":"The name of the Connect configuration.\n\nThis property is required."},"oAuthConfiguration":{"$ref":"#/components/schemas/connectOAuthConfig"},"password":{"type":"string","description":"The password for the Connect configuration.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"pausePublish":{"type":"string"},"recipientEvents":{"type":"array","items":{"type":"string"},"description":"An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the `url` property.\n\nWhen using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/), use the `events` property.\n\nThe [possible event statuses](/platform/webhooks/connect/event-triggers/) are:\n\n- `Sent`\n- `AutoResponded`\n- `Delivered`\n- `Completed`\n- `Declined`\n- `AuthenticationFailed`\n\n**Note:** These values are case-sensitive.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"requireMutualTls":{"type":"string","description":"When **true,** [Mutual TLS](/platform/webhooks/mutual-tls/) authentication is enabled.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"requiresAcknowledgement":{"type":"string","description":"When **true,** event delivery acknowledgements are enabled for your Connect configuration.\n\nDocusign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead, they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, Docusign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\nThis property is required."},"salesforceApiVersion":{"type":"string","description":"The version of the Salesforce API that you are using.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"salesforceAuthcode":{"type":"string"},"salesforceCallBackUrl":{"type":"string"},"salesforceCodeVerifier":{"type":"string"},"salesforceDocumentsAsContentFiles":{"type":"string","description":"When **true,** Docusign can use documents in your Salesforce account for sending and signing.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"senderOverride":{"type":"string"},"senderSelectableItems":{"type":"array","items":{"type":"string"},"description":"This property sets the items that are available for selection when adding or editing Connect objects.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"sfObjects":{"type":"array","items":{"$ref":"#/components/schemas/connectSalesforceObject"},"description":"An array of Salesforce objects.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"signMessageWithX509Certificate":{"type":"string","description":"When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol.\n\nThis property is required."},"soapNamespace":{"type":"string","description":"The namespace of the SOAP interface.\n\n**Note:** If `useSoapInterface` is set to **true,** you must set this value.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"urlToPublishTo":{"type":"string","description":"The web address of the listener or retrieving service endpoint. It must be an HTTPS URL.\n\nThis property is required."},"userIds":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\nBy default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.**\n\n**Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"userName":{"type":"string","description":"The name of the user.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."},"useSoapInterface":{"type":"string","description":"When **true,** the notifications are sent to your endpoint as SOAP requests.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint."}},"description":"The `connectCustomConfiguration` object describes a Connect configuration for your account.","title":"connectCustomConfiguration"},"Uncategorized_ConnectHMAC_CreateConnectSecret_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_ConnectHMAC_CreateConnectSecret_Response_201"},"Connect_deleteconnectconfig_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Connect_deleteconnectconfig_Response_200"},"Uncategorized_ConnectOAuthConfig_DeleteConnectOAuthConfig_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_ConnectOAuthConfig_DeleteConnectOAuthConfig_Response_200"},"Uncategorized_ConnectHMAC_DeleteConnectSecret_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_ConnectHMAC_DeleteConnectSecret_Response_200"},"connectConfigResults":{"type":"object","properties":{"configurations":{"type":"array","items":{"$ref":"#/components/schemas/connectCustomConfiguration"},"description":"An array of Docusign Connect configurations."},"totalRecords":{"type":"string","description":"The number of results."}},"description":"This object contains the results of a ConnectConfigurations::GET method.","title":"connectConfigResults"},"connectUserInfo":{"type":"object","properties":{"email":{"type":"string"},"isIncluded":{"type":"string"},"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."},"userName":{"type":"string","description":"The name of the user."}},"title":"connectUserInfo"},"integratedConnectUserInfoList":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."},"users":{"type":"array","items":{"$ref":"#/components/schemas/connectUserInfo"},"description":"User management information."}},"title":"integratedConnectUserInfoList"},"Uncategorized_ConnectHMAC_GetConnectSecret_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_ConnectHMAC_GetConnectSecret_Response_200"},"integratedUserInfoList":{"type":"object","properties":{"allUsersSelected":{"type":"string"},"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."},"users":{"type":"array","items":{"$ref":"#/components/schemas/userInfo"},"description":"User management information."}},"title":"integratedUserInfoList"},"Connect_ConnectLog_DeleteConnectLog_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Connect_ConnectLog_DeleteConnectLog_Response_200"},"connectDeleteFailureResult":{"type":"object","properties":{},"title":"connectDeleteFailureResult"},"Connect_ConnectLog_DeleteConnectLogs_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Connect_ConnectLog_DeleteConnectLogs_Response_200"},"connectDebugLog":{"type":"object","properties":{"connectConfig":{"type":"string","description":"The name of the Connect configuration."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"eventDateTime":{"type":"string","description":"The UTC date and time of the event."},"eventDescription":{"type":"string","description":"A description of the event."},"payload":{"type":"string","description":"Log output."}},"title":"connectDebugLog"},"connectLog":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID associated with the envelope."},"configUrl":{"type":"string","description":"The web address of the listener or Retrieving Service end point for Connect."},"connectDebugLog":{"type":"array","items":{"$ref":"#/components/schemas/connectDebugLog"},"description":"A complex element containing information about the Connect configuration, error details, date/time, description and payload.\nThis information is included in the response only when the `additional_info` query is set to **true.**\nThis additional information is only available when retrieving general logs with [ConnectEvents:get](/docs/esign-rest-api/reference/connect/connectevents/get/), but not when retrieving failure logs with [ConnectEvents:listFailures](/docs/esign-rest-api/reference/connect/connectevents/listfailures/)."},"connectId":{"type":"string","description":"The ID of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post."},"created":{"type":"string","description":"The UTC DateTime when the Connect post was created."},"email":{"type":"string","description":"The email address of the envelope sender."},"envelopeId":{"type":"string","description":"The ID of the envelope that failed to post."},"error":{"type":"string","description":"The error that caused the Connect post to fail."},"failureId":{"type":"string","description":"The failure log ID for the failure."},"failureUri":{"type":"string","description":"The URI for the Connect post failure."},"lastTry":{"type":"string","description":"The UTC DateTime of the last attempt to post."},"logId":{"type":"string","description":"The Connect log ID for the entry."},"logUri":{"type":"string","description":"The URI for the Connect log entry."},"retryCount":{"type":"string","description":"The number of times the Connect post has been retried."},"retryUri":{"type":"string","description":"A URI that you can use to retry to publish the Connect post."},"status":{"type":"string","description":"The envelope status for the Connect post. Possible values are:\n\n- `Any`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Template`\n- `Processing`\n\nFor details about these statuses, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/)."},"subject":{"type":"string","description":"The subject of the envelope."},"userName":{"type":"string","description":"The name of the sender of the envelope."}},"description":"Contains information about a Connect log entry.","title":"connectLog"},"connectLogs":{"type":"object","properties":{"failures":{"type":"array","items":{"$ref":"#/components/schemas/connectLog"},"description":"An array of containing failure information from the Connect failure log."},"logs":{"type":"array","items":{"$ref":"#/components/schemas/connectLog"},"description":"A list of Connect general logs."},"totalRecords":{"type":"string","description":"The count of records in the log list."},"type":{"type":"string","description":"The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"}},"title":"connectLogs"},"connectFailureResult":{"type":"object","properties":{"configId":{"type":"string","description":"Reserved for Docusign."},"configUrl":{"type":"string","description":"Reserved for Docusign."},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"status":{"type":"string","description":"The connection status."},"statusMessage":{"type":"string","description":"A human-readable message describing the connection status."}},"description":"This object contains details about a Connect failure result.","title":"connectFailureResult"},"connectFailureResults":{"type":"object","properties":{"retryQueue":{"type":"array","items":{"$ref":"#/components/schemas/connectFailureResult"},"description":"Details about a Connect failure result."}},"title":"connectFailureResults"},"connectFailureFilter":{"type":"object","properties":{"envelopeIds":{"type":"array","items":{"type":"string"},"description":"An array of envelope GUIDs.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"synchronous":{"type":"string","description":"Must be **false.** Setting this property to any other value will result in errors."}},"description":"A list of failed envelope IDs to retry.","title":"connectFailureFilter"},"tabMetadata":{"type":"object","properties":{"anchor":{"type":"string","description":"An optional string that is used to auto-match tabs to strings located in the documents of an envelope."},"anchorCaseSensitive":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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 next to each other in the document, a single anchor tab is placed for both of them.\n\nExample: 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\nExample: 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."},"anchorHorizontalAlignment":{"type":"string","description":"This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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."},"anchorIgnoreIfNotPresent":{"type":"string","description":"When `true`, this tab is ignored if the `anchorString` is not found in the document."},"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](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) 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$~>&lt;|^+=\n\nFor 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\nExample: 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 next to each other in the document, a single anchor tab is placed for both of them.\n\nExample: 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\nExample: 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."},"anchorUnits":{"type":"string","description":"Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`"},"anchorXOffset":{"type":"string","description":"Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString."},"anchorYOffset":{"type":"string","description":"Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString."},"bold":{"type":"string","description":"When `true`, the information in the tab is bold."},"collaborative":{"type":"string","description":"When `true`, the tab can be edited by any recipient during signing."},"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."},"createdByDisplayName":{"type":"string","description":"The user name of the DocuSign user who created this object."},"createdByUserId":{"type":"string","description":"The userId of the DocuSign user who created this object."},"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."},"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 auto-sizing is 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."},"editable":{"type":"string","description":"When `true`, the custom tab is editable. Otherwise the custom tab cannot be modified."},"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- OcrA (OCR-A)\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana"},"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"},"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"},"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"includedInEmail":{"type":"string","description":"When `true`, the tab is included in emails related to the envelope on which it exists. This applies to only specific tabs."},"initialValue":{"type":"string","description":"The original value of the tab."},"italic":{"type":"string","description":"When `true`, the information in the tab is italic."},"items":{"type":"array","items":{"type":"string"},"description":"If the tab is a list, this represents the values that are possible for the tab."},"lastModified":{"type":"string","description":"The UTC DateTime this object was last modified. This is in ISO8601 format."},"lastModifiedByDisplayName":{"type":"string","description":"The User Name of the DocuSign user who last modified this object."},"lastModifiedByUserId":{"type":"string","description":"The userId of the DocuSign user who last modified this object."},"localePolicy":{"$ref":"#/components/schemas/localePolicyTab"},"locked":{"type":"string","description":"When `true`, the signer cannot change the data of the custom tab."},"maximumLength":{"type":"string","description":"The maximum number of entry characters supported by the custom tab."},"maxNumericalValue":{"type":"string"},"mergeField":{"$ref":"#/components/schemas/mergeField"},"minNumericalValue":{"type":"string"},"name":{"type":"string"},"numericalValue":{"type":"string"},"paymentItemCode":{"type":"string","description":"If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters."},"paymentItemDescription":{"type":"string","description":"If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters."},"paymentItemName":{"type":"string","description":"If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`"},"requireAll":{"type":"string","description":"When `true` and `shared` is `true`, information must be entered in this field to complete the envelope."},"required":{"type":"string","description":"When `true`, the signer is required to fill out this tab."},"requireInitialOnSharedChange":{"type":"string","description":"Optional element for field markup. When `true`, the signer is required to initial when they modify a shared field."},"scaleValue":{"type":"string","description":"Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."},"selected":{"type":"string","description":"When `true`, the radio button is selected."},"shared":{"type":"string","description":"When `true`, the tab is shared with all users on the account."},"signatureProviderId":{"type":"string","description":"Reserved for Docusign."},"stampType":{"type":"string","description":"The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"},"stampTypeMetadata":{"$ref":"#/components/schemas/propertyMetadata"},"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."},"type":{"type":"string","description":"The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"},"underline":{"type":"string","description":"When `true`, the information in the tab is underlined."},"validationMessage":{"type":"string","description":"The message displayed if the custom tab fails input validation (either custom or embedded)."},"validationPattern":{"type":"string","description":"A regular expression used to validate input for the tab."},"validationType":{"type":"string","description":"Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`"},"width":{"type":"string","description":"The width of the tab in pixels.\nMust be an integer."}},"title":"tabMetadata"},"CustomTabs_Tab_DeleteCustomTab_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"CustomTabs_Tab_DeleteCustomTab_Response_200"},"tabMetadataList":{"type":"object","properties":{"tabs":{"type":"array","items":{"$ref":"#/components/schemas/tabMetadata"},"description":"A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients."}},"title":"tabMetadataList"},"Diagnostics_APIRequestLog_DeleteRequestLogs_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Diagnostics_APIRequestLog_DeleteRequestLogs_Response_200"},"diagnosticsSettingsInformation":{"type":"object","properties":{"apiRequestLogging":{"type":"string","description":"When **true,** enables API request logging for the user."},"apiRequestLogMaxEntries":{"type":"string","description":"Specifies the maximum number of API requests to log."},"apiRequestLogRemainingEntries":{"type":"string","description":"Indicates the remaining number of API requests that can be logged."}},"title":"diagnosticsSettingsInformation"},"apiRequestLog":{"type":"object","properties":{"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"description":{"type":"string","description":"The API endpoint that was called."},"requestLogId":{"type":"string","description":"The ID of the log entry."},"status":{"type":"string","description":"The status of the API request."}},"description":"Contains API request log information.","title":"apiRequestLog"},"apiRequestLogsResult":{"type":"object","properties":{"apiRequestLogs":{"type":"array","items":{"$ref":"#/components/schemas/apiRequestLog"},"description":"Reserved for Docusign."}},"description":"Contains information about multiple API request logs.","title":"apiRequestLogsResult"},"resourceInformation":{"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"}}},"title":"resourceInformation"},"serviceVersion":{"type":"object","properties":{"version":{"type":"string","description":"The version of the rest API."},"versionUrl":{"type":"string"}},"title":"serviceVersion"},"serviceInformation":{"type":"object","properties":{"buildBranch":{"type":"string","description":"Reserved for Docusign."},"buildBranchDeployedDateTime":{"type":"string","description":"Reserved for Docusign."},"buildSHA":{"type":"string","description":"Reserved for Docusign."},"buildVersion":{"type":"string","description":"Reserved for Docusign."},"linkedSites":{"type":"array","items":{"type":"string"}},"serviceVersions":{"type":"array","items":{"$ref":"#/components/schemas/serviceVersion"}}},"title":"serviceInformation"},"bccEmailArchive":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account that owns the BCC email archive configuration."},"bccEmailArchiveId":{"type":"string","description":"The ID of the BCC email archive configuration."},"created":{"type":"string","description":"The UTC DateTime when the BCC email archive configuration was created."},"createdBy":{"$ref":"#/components/schemas/userInfo"},"email":{"type":"string","description":"The BCC email address to use for archiving Docusign messages.\n\nExample: [customer_bcc@example.com](mailto:customer_bcc@example.com)"},"emailNotificationId":{"type":"string","description":"The GUID of the activation email message sent to the BCC email address."},"modified":{"type":"string","description":"The UTC DateTime when the BCC email archive configuration was last modified."},"modifiedBy":{"$ref":"#/components/schemas/userInfo"},"status":{"type":"string","description":"The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving."},"uri":{"type":"string","description":"The helper URI for retrieving the BCC email archive."}},"description":"This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).","title":"bccEmailArchive"},"Uncategorized_BCCEmailArchive_DeleteBCCEmailArchive_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_BCCEmailArchive_DeleteBCCEmailArchive_Response_200"},"bccEmailArchiveHistory":{"type":"object","properties":{"accountId":{"type":"string","description":"The ID of the account that owns the BCC email archive configuration."},"action":{"type":"string","description":"The action taken on the BCC email archive configuration.\n\nExamples:\n\n- `CREATED`: The BCC email archive configuration has been created.\n- `UPDATED`: The BCC email address has been activated by clicking on the activation link in the activation email message.\n- `CLOSED`: The BCC email address has been marked as closed is no longer used for archiving."},"email":{"type":"string","description":"The BCC email address used to archive the emails that Docusign generates.\n\nExample: [customer_bcc@example.com](mailto:customer_bcc@example.com)"},"modified":{"type":"string","description":"The UTC DateTime when the BCC email address was last modified."},"modifiedBy":{"$ref":"#/components/schemas/userInfo"},"status":{"type":"string","description":"The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving."}},"description":"Contains details about the history of the BCC email archive configuration.","title":"bccEmailArchiveHistory"},"bccEmailArchiveHistoryList":{"type":"object","properties":{"bccEmailArchiveHistory":{"type":"array","items":{"$ref":"#/components/schemas/bccEmailArchiveHistory"},"description":"A list of changes to the BCC email archive configuration."},"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."}},"title":"bccEmailArchiveHistoryList"},"bccEmailArchiveList":{"type":"object","properties":{"bccEmailArchives":{"type":"array","items":{"$ref":"#/components/schemas/bccEmailArchive"},"description":"A list of BCC email archive configurations."},"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."}},"description":"Contains a list of BCC email archive configurations.","title":"bccEmailArchiveList"},"chunkedUploadPart":{"type":"object","properties":{"sequence":{"type":"string","description":"The order of the part in the chunked upload."},"size":{"type":"string","description":"The size of the part in bytes.\n\nDocusign recommends that a chunked upload part is no larger than a few MB in size."}},"description":"An object that contains information about the chunked upload part.","title":"chunkedUploadPart"},"chunkedUploadResponse":{"type":"object","properties":{"checksum":{"type":"string","description":"A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused."},"chunkedUploadId":{"type":"string","description":"The ID of the chunked upload."},"chunkedUploadParts":{"type":"array","items":{"$ref":"#/components/schemas/chunkedUploadPart"},"description":"A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload."},"chunkedUploadUri":{"type":"string","description":"The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests."},"committed":{"type":"string","description":"When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests."},"expirationDateTime":{"type":"string","description":"The UTC time at which the chunked upload expires and is no longer addressable.\n\n**Note:** You must fully upload and use a chunked upload within 20 minutes of initializing it."},"maxChunkedUploadParts":{"type":"string","description":"The maximum number of parts allowed for a chunked upload. This value is configurable per Docusign environment, account, or integrator. The default value is 128. The maximum possible value is 256."},"maxTotalSize":{"type":"string","description":"The maximum total size allowed for a chunked upload. This value is configured per Docusign environment, account, or integrator. The default value is 50 MB."},"totalSize":{"type":"string","description":"The total size of the parts of the chunked upload.\n\n**Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents."}},"description":"This response object is returned after you upload a chunked upload.","title":"chunkedUploadResponse"},"chunkedUploadRequest":{"type":"object","properties":{"chunkedUploadId":{"type":"string","description":"The ID of the chunked upload.\n\n**Note:** This property is ignored in requests, and overridden with an auto-generated value in responses."},"data":{"type":"string","description":"A base64-encoded representation of the content that is used to upload the file.\n\nMaximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size."}},"description":"This is the request object for uploading a chunked upload.","title":"chunkedUploadRequest"},"documentHtmlCollapsibleDisplaySettings":{"type":"object","properties":{"arrowClosed":{"type":"string","description":"Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the closed state.\n\nOne of the following:\n\n- `up`: In the closed state, the disclosure arrow points up.\n- `down`: In the closed state, the disclosure arrow points down.\n- `left`: In the closed state, the disclosure arrow points left.\n- `right`: In the closed state, the disclosure arrow points right."},"arrowColor":{"type":"string","description":"A CSS color value (such as `#DCF851`) that indicates the color of the arrow."},"arrowLocation":{"type":"string","description":"The location of the arrow relative to the collapsible section's label. Possible values are:\n\n- `right` (default)\n- `left`"},"arrowOpen":{"type":"string","description":"Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the open state.\n\nOne of the following:\n\n- `up`: In the open state, the disclosure arrow points up.\n- `down`: In the open state, the disclosure arrow points down.\n- `left`: In the open state, the disclosure arrow points left.\n- `right`: In the open state, the disclosure arrow points right."},"arrowSize":{"type":"string","description":"Indicates the size of the collapsible arrows. Possible values are:\n\n- `small`\n- `large` (default)"},"arrowStyle":{"type":"string","description":"The name of the CSS style to be used on collapsible arrow section."},"containerStyle":{"type":"string","description":"The name of the CSS style to be used for the collapsible container."},"labelStyle":{"type":"string","description":"The name of the CSS style to be used for the collapsible container's label."},"onlyArrowIsClickable":{"type":"boolean","description":"When **true,** only the arrow is clickable to expand or collapse the section.\nWhen **false** (the default), both the label and the arrow are clickable.\n\nIf no arrow is used, this setting is ignored."},"outerLabelAndArrowStyle":{"type":"string","description":"The name of the CSS style to be used for the collapsible container's outer label and arrow style."}},"description":"Display settings for collapsible section.","title":"documentHtmlCollapsibleDisplaySettings"},"documentHtmlDisplaySettings":{"type":"object","properties":{"cellStyle":{"type":"string","description":"Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types."},"collapsibleSettings":{"$ref":"#/components/schemas/documentHtmlCollapsibleDisplaySettings"},"display":{"type":"string","description":"Sets the display and behavior properties. Possible values are:\n\n- `inline`:\nLeaves the HTML where it is in the document.\nThis property lets you add a label or present on a separate page.\n\n- `collapsible`:\nThe HTML in this section may be expanded or collapsed.\nInitially this section is expanded.\n\n- `collapsed`:\nThe HTML in this section may be expanded or collapsed.\nInitially this section is collapsed.\n\n- `continue_button`:\nCreates a stop point in the document to draw the reader's\nattention before proceeding to the next section.\n\n- `responsive_table`:\nTurns this section into a responsive table.\nNote that this is only used on HTML tables that fall within the anchor start and end positions.\n\n- `responsive_table_single_column`:\nTurns this section into a responsive single-column table.\nNote this is only used on HTML tables that fall within the anchor start and end positions.\nThe table will be converted to one single column where each current column will become a row, then stacked.\n\n- `print_only`:\nDo not show this portion of the HTML in the responsive signing view."},"displayLabel":{"type":"string","description":"The label to add to this display section in the signing page."},"displayOrder":{"type":"integer","description":"The position on the page where the display section appears."},"displayPageNumber":{"type":"integer","description":"The number of the page on which the display section appears."},"hideLabelWhenOpened":{"type":"boolean","description":"When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`."},"inlineOuterStyle":{"type":"string","description":"Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`."},"labelWhenOpened":{"type":"string","description":"The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`."},"preLabel":{"type":"string","description":"Enables you to add descriptive text that appears before a collapsed section or continue button."},"scrollToTopWhenOpened":{"type":"boolean","description":"When **true** and the section is expanded,\nthe position of the section-close control\nscrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`."},"tableStyle":{"type":"string","description":"Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`."}},"description":"This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`.","title":"documentHtmlDisplaySettings"},"documentHtmlDisplayAnchor":{"type":"object","properties":{"caseSensitive":{"type":"boolean","description":"When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content."},"displaySettings":{"$ref":"#/components/schemas/documentHtmlDisplaySettings"},"endAnchor":{"type":"string","description":"Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."},"removeEndAnchor":{"type":"boolean","description":"When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying."},"removeStartAnchor":{"type":"boolean","description":"When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying."},"startAnchor":{"type":"string","description":"Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."}},"title":"documentHtmlDisplayAnchor"},"documentHtmlDefinition":{"type":"object","properties":{"displayAnchorPrefix":{"type":"string","description":"Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance."},"displayAnchors":{"type":"array","items":{"$ref":"#/components/schemas/documentHtmlDisplayAnchor"},"description":"An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view.\n\nA start anchor, end anchor, or both are required.\nIf the anchors are not found, the display anchor will be ignored.\n\nFor a list of the available types, see the\n[`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display)\nof the\n[`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)"},"displayOrder":{"type":"string","description":"The position on the page where the display section appears."},"displayPageNumber":{"type":"string","description":"The number of the page on which the display section appears."},"documentGuid":{"type":"string","description":"The GUID of the document."},"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."},"headerLabel":{"type":"string","description":"Header text or an HTML tag to place above the responsive HTML block."},"maxScreenWidth":{"type":"string","description":"If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead.\n\nThis setting can also be configured at the account level."},"removeEmptyTags":{"type":"string","description":"Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes)."},"showMobileOptimizedToggle":{"type":"string","description":"When **true** (the default), the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. When **false,** the toggle will not be displayed.\n\nthe **Mobile-Friendly** toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing."},"source":{"type":"string","description":"Specifies the type of responsive signing that will be used with the document.\n\nIf the value of this property is valid HTML,\nand the [smart sections feature](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html) is enabled,\nthe HTML code is used to display the signing page:\n\n```text\nsource: \"<html> ... <body><p>hello world</p></body></html>\"\n```\n\nIf the value of this property is the string `document`,\nthe HTML signing page is generated from the provided document.\n\n```text\nsource: \"document\"\n```\n\n**Related topics**\n\n- [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/)\n- [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)\n- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)"}},"description":"Holds the properties that define how to generate the responsive-formatted HTML for the document.\nSee [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)\nin the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).","title":"documentHtmlDefinition"},"matchBox":{"type":"object","properties":{"height":{"type":"string","description":"The height of the tab in pixels.\nMust be an integer."},"pageNumber":{"type":"string","description":"Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents."},"width":{"type":"string","description":"The width 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."},"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."}},"title":"matchBox"},"document":{"type":"object","properties":{"applyAnchorTabs":{"type":"string","description":"Reserved for Docusign."},"assignTabsToRecipientId":{"type":"string"},"authoritativeCopy":{"type":"boolean","description":"When **true,** this document is considered an authoritative copy.\n\nIf this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property.\n\nWhen **false,** this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property."},"display":{"type":"string","description":"This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n- `modal`\n\nThe document is shown as a supplement action strip\nand can be viewed, downloaded, or printed in a modal window.\nThis is the recommended value for supplemental documents.\n\n- `inline`\n\nThe document is shown in the normal signing window.\nThis value is not used with supplemental documents,\nbut is the default value for all other documents."},"docGenDocumentStatus":{"type":"string"},"docGenFormFields":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormField"}},"documentBase64":{"type":"string","description":"The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."},"documentFields":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements:\n\n- `name`: A string that can be a maximum of 50 characters.\n- `value`: A string that can be a maximum of 200 characters.\n\nIf you are using XML, the name/value pair is contained in a `nameValue` element."},"documentId":{"type":"string","description":"Specifies the document ID of this document. This value is used by tabs to determine which document they appear in."},"documentTemplateId":{"type":"string"},"encryptedWithKeyManager":{"type":"string","description":"When **true,** the document has been encrypted by the sender for use with the Docusign Key Manager Security Appliance."},"fileExtension":{"type":"string","description":"The file extension type of the document. Non-PDF documents are converted to PDF.\n\nIf the document is not a PDF, `fileExtension` is required.\n\nIf you try to upload a non-PDF document without a `fileExtension`, you will receive an \"unable to load document\" error message."},"fileFormatHint":{"type":"string"},"htmlDefinition":{"$ref":"#/components/schemas/documentHtmlDefinition"},"includeInDownload":{"type":"string","description":"When **true,**\nthe document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/).\nThe default value is **true.**"},"isDocGenDocument":{"type":"string"},"matchBoxes":{"type":"array","items":{"$ref":"#/components/schemas/matchBox"},"description":"Matchboxes define areas in a document for document matching when you are creating envelopes.\nThey are only used when you upload and edit a template."},"name":{"type":"string","description":"The name of the document."},"order":{"type":"string","description":"A string value consisting of an integer index of the document's position within the list of documents attached to the envelope."},"pages":{"type":"string","description":"The number of pages in the document. This property is read-only."},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"pdfFormFieldOption":{"type":"string"},"remoteUrl":{"type":"string","description":"The file ID from the cloud storage service where\nthe document is located. This information is\nreturned using\n[CloudStorage: listFolders](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders/) or\n[CloudStorage: list](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/list/)."},"signerMustAcknowledge":{"type":"string","description":"Sets how the signer interacts with the supplemental document.\nValid values:\n\n- `no_interaction`\n\nNo recipient action is required.\n\n- `view`\n\nThe recipient is required to view the document.\n\n- `accept`\n\nThe recipient is required to accept the document by selecting accept during signing, but is not required to view the document.\n\n- `view_accept`\n\nThe recipient is required to view and accept the document.\n\n**Note:** The `view` value is used for both View and Accept and Read and Accept. Visit the [Supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/) page for more information."},"signerMustAcknowledgeUseAccountDefault":{"type":"boolean","description":"When **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa)."},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients."},"templateRequired":{"type":"string","description":"When **true,** the sender may not remove the recipient. Used only when working with template recipients."},"transformPdfFields":{"type":"string","description":"When **true,** PDF form field data is transformed into document tab values when the PDF form field name matches the Docusign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF."},"uri":{"type":"string","description":"A URI containing the user ID."}},"description":"A document object.","title":"document"},"inlineTemplate":{"type":"object","properties":{"customFields":{"$ref":"#/components/schemas/customFields"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"},"description":"A complex element that contains details about the documents associated with the envelope."},"envelope":{"$ref":"#/components/schemas/envelope"},"recipients":{"$ref":"#/components/schemas/recipients"},"sequence":{"type":"string","description":"Specifies the order in which templates are overlaid."}},"title":"inlineTemplate"},"serverTemplate":{"type":"object","properties":{"sequence":{"type":"string","description":"Specifies the order in which templates are overlaid."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "}},"title":"serverTemplate"},"compositeTemplate":{"type":"object","properties":{"compositeTemplateId":{"type":"string","description":"The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document."},"document":{"$ref":"#/components/schemas/document"},"inlineTemplates":{"type":"array","items":{"$ref":"#/components/schemas/inlineTemplate"},"description":" Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value."},"pdfMetaDataTemplateSequence":{"type":"string","description":"A number representing the sequence in which to apply the template that contains the PDF metadata.\n\nExample: `4`"},"serverTemplates":{"type":"array","items":{"$ref":"#/components/schemas/serverTemplate"},"description":"Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value."}},"description":"This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/","title":"compositeTemplate"},"envelopeEvent":{"type":"object","properties":{"envelopeEventStatusCode":{"type":"string","description":"An envelope status for which your webhook should be called. Valid values:\n\n- `Sent`\n- `Delivered`\n- `Completed`\n- `Declined`\n- `Voided`"},"includeDocuments":{"type":"string","description":"When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."}},"description":"For which envelope events should your webhook be called?","title":"envelopeEvent"},"recipientEvent":{"type":"object","properties":{"includeDocuments":{"type":"string","description":"When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."},"recipientEventStatusCode":{"type":"string","description":"Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded."}},"title":"recipientEvent"},"eventNotification":{"type":"object","properties":{"deliveryMode":{"type":"string"},"envelopeEvents":{"type":"array","items":{"$ref":"#/components/schemas/envelopeEvent"},"description":"A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both."},"eventData":{"$ref":"#/components/schemas/connectEventData"},"events":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/). If you are instead using any of [the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/json-sim-event-reference/) are:\n\n- `envelope-created`\n- `envelope-sent`\n- `envelope-resent`\n- `envelope-delivered`\n- `envelope-completed`\n- `envelope-declined`\n- `envelope-voided`\n- `recipient-authenticationfailed`\n- `recipient-autoresponded`\n- `recipient-declined`\n- `recipient-delivered`\n- `recipient-completed`\n- `recipient-sent`\n- `recipient-resent`\n- `template-created`\n- `template-modified`\n- `template-deleted`\n- `envelope-corrected`\n- `envelope-purge`\n- `envelope-deleted`\n- `envelope-discard`\n- `recipient-reassign`\n- `recipient-delegate`\n- `recipient-finish-later`\n- `click-agreed`\n- `click-declined`"},"includeCertificateOfCompletion":{"type":"string","description":"When **true,** the Connect Service includes the Certificate of Completion with completed envelopes."},"includeCertificateWithSoap":{"type":"string","description":"When **true,**\nthe Connect service will digitally sign\nthe data.\nThe signature will be included in the message."},"includeDocumentFields":{"type":"string","description":"When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API."},"includeDocuments":{"type":"string","description":"When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."},"includeEnvelopeVoidReason":{"type":"string","description":"When **true,** this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message."},"includeHMAC":{"type":"string","description":"When **true,** HMAC headers will be included with the webhook notifications.\n\n**Note:** [HMAC must enabled](/platform/webhooks/connect/hmac/) at the account level with [one or more HMAC secrets](/platform/webhooks/connect/setting-up-hmac/)."},"includeOAuth":{"type":"string"},"includeSenderAccountAsCustomField":{"type":"string","description":"When **true,** Connect will include the sender account as Custom Field in the data."},"includeTimeZone":{"type":"string","description":"When **true,** the envelope's time zone information is included in the webhook messages."},"integratorManaged":{"type":"string","description":"When **true**, enables partners and integrators use their HMAC keys for their clients’ event messages. If enabled, Connect will use the partner’s or integrator’s HMAC key's while sending event notifications. You can use this parameter for account-level and envelope-level configurations.\n\nWhile enabled, this setting this will cause the **x-docusign-accountid** value to match the partner or integrator’s account ID. When **false**, or when not set, the **x-docusign-accountid** returns the Account ID of the user who created the envelope."},"loggingEnabled":{"type":"string","description":"When **true,** the webhook messages are logged. They can be viewed on the Docusign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](/docs/esign-rest-api/reference/connect/connectevents/)."},"recipientEvents":{"type":"array","items":{"$ref":"#/components/schemas/recipientEvent"},"description":"A list of recipient event statuses that will trigger Connect to send updates to   the endpoint specified in the url property.\n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both."},"requireAcknowledgment":{"type":"string","description":"When **true,** the Docusign Connect service checks that the message was received and retries on failures."},"signMessageWithX509Cert":{"type":"string","description":"When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol."},"soapNameSpace":{"type":"string","description":"The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true."},"url":{"type":"string","description":"The endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.\n\nThe maximum length of this property is 4096 bytes."},"useSoapInterface":{"type":"string","description":"When **true,** this tells the Connect service that the user's endpoint has implemented a SOAP interface."}},"description":"Use this object to configure a [Docusign Connect webhook](/platform/webhooks/connect/).","title":"eventNotification"},"envelopeGenAndSendProperties":{"type":"object","properties":{"applyAnchorTabs":{"type":"string"},"archiveDocumentType":{"type":"string"},"assignTabsToRecipientId":{"type":"string"},"authoritativeCopy":{"type":"string","description":"Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled."},"base64DataJson":{"type":"string"},"base64GenerateTemplateDocument":{"type":"string"},"dataJson":{"type":"string"},"display":{"type":"string"},"docGenDocumentStatus":{"type":"string"},"docGenFormFields":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormField"}},"documentBase64":{"type":"string"},"documentFields":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"}},"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."},"documentName":{"type":"string"},"documentSequence":{"type":"string"},"documentTemplateId":{"type":"string"},"encryptedWithKeyManager":{"type":"string"},"fileExtension":{"type":"string"},"fileFormatHint":{"type":"string"},"generateDocumentTemplateKind":{"type":"string"},"generateDocumentTemplateSource":{"type":"string"},"generateTemplateDocumentId":{"type":"string"},"htmlDefinition":{"$ref":"#/components/schemas/documentHtmlDefinition"},"includeInDownload":{"type":"string"},"isDocGenDocument":{"type":"string"},"matchBoxes":{"type":"array","items":{"$ref":"#/components/schemas/matchBox"}},"name":{"type":"string"},"order":{"type":"string"},"pages":{"type":"string"},"password":{"type":"string"},"pdfFormFieldOption":{"type":"string"},"remoteUrl":{"type":"string"},"signerMustAcknowledge":{"type":"string"},"signerMustAcknowledgeUseAccountDefault":{"type":"boolean"},"tabs":{"$ref":"#/components/schemas/tabs"},"templateLocked":{"type":"string","description":"When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. "},"templateRequired":{"type":"string","description":"When set to **true**, the sender may not remove the recipient. Used only when working with template recipients."},"transformPdfFields":{"type":"string"},"uri":{"type":"string"}},"title":"envelopeGenAndSendProperties"},"recipientTokenClientURLs":{"type":"object","properties":{"onAccessCodeFailed":{"type":"string"},"onCancel":{"type":"string"},"onDecline":{"type":"string"},"onException":{"type":"string"},"onFaxPending":{"type":"string"},"onIdCheckFailed":{"type":"string"},"onSessionTimeout":{"type":"string"},"onSigningComplete":{"type":"string"},"onTTLExpired":{"type":"string"},"onViewingComplete":{"type":"string"}},"title":"recipientTokenClientURLs"},"recipientViewRequest":{"type":"object","properties":{"assertionId":{"type":"string","description":"A unique identifier of the authentication event executed by the client application."},"authenticationInstant":{"type":"string","description":"A sender-generated value that indicates the date and time that the signer was authenticated."},"authenticationMethod":{"type":"string","description":"Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer.\n\nChoose a value from this list:\n\n- Biometric\n- Email\n- HTTPBasicAuth\n- Kerberos\n- KnowledgeBasedAuth\n- None\n- PaperDocuments\n- Password\n- RSASecureID\n- SingleSignOn_CASiteminder\n- SingleSignOn_InfoCard\n- SingleSignOn_MicrosoftActiveDirectory\n- SingleSignOn_Other\n- SingleSignOn_Passport\n- SingleSignOn_SAML\n- Smartcard\n- SSLMutualAuth\n- X509Certificate\n\nThis information is included in the Certificate of Completion."},"clientURLs":{"$ref":"#/components/schemas/recipientTokenClientURLs"},"clientUserId":{"type":"string","description":"A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.\n\nUse your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.\n\nMaximum length: 100 characters."},"displayFormat":{"type":"string","description":"This value determines whether the display will show an embedded or focused view experience. If set to `focused`, the display will use the focused view experience. If set to `default`, or if not set, the display will use the embedded experience."},"email":{"type":"string","description":"(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient."},"frameAncestors":{"type":"array","items":{"type":"string"},"description":"An array of ancestors that can embed the frame. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/).\n\nIn the demo environment, include your site URL and `https://apps-d.docusign.com`. You can use `http://localhost` for local development and testing. Example: `[\"https://my.site.com\", \"https://apps-d.docusign.com\"]`\n\nIn the production environment, include your site URL and `https://apps.docusign.com`. HTTPS must be enabled on your site. Example: `[\"https://my.site.com\", \"https://apps.docusign.com\"]`"},"messageOrigins":{"type":"array","items":{"type":"string"},"description":"The originating domain for the signature request message. This property is required when [using focus view](/docs/esign-rest-api/how-to/request-signature-focused-view/).\n\nIn the demo environment, the value must be `https://apps-d.docusign.com`. In production, the value must be `https://apps.docusign.com`."},"pingFrequency":{"type":"string","description":"Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl.  The default is 300 seconds. Valid values are 60-1200 seconds."},"pingUrl":{"type":"string","description":"The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"returnUrl":{"type":"string","description":"(Required) The URL to which the user should be redirected\nafter the signing session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\nWhen Docusign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n- `access_code_failed`: Recipient used incorrect access code.\n- `cancel`: Recipient canceled the signing operation,\npossibly by using the **Finish Later** option.\n- `decline`: Recipient declined to sign.\n- `exception`: A system error occurred during the signing process.\n- `fax_pending`: Recipient has a fax pending.\n- `id_check_failed`: Recipient failed an ID check.\n- `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option.\n- `signing_complete`: The recipient completed the signing ceremony.\n- `ttl_expired`: The Time To Live token for the envelope has expired.\nAfter being successfully invoked, these tokens expire\nafter five minutes.\n- `viewing_complete`: The recipient completed viewing an envelope\nthat is in a read-only/terminal state,\nsuch as completed, declined, or voided."},"securityDomain":{"type":"string","description":"The domain in which the user authenticated."},"userId":{"type":"string","description":"The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient.\n\nIf `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope.\n\nIf a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user."},"userName":{"type":"string","description":"The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient."},"xFrameOptions":{"type":"string","description":"Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property."},"xFrameOptionsAllowFromUrl":{"type":"string","description":"When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property."}},"description":"The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/)\nand\n[EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods.","title":"recipientViewRequest"},"templateRole":{"type":"object","properties":{"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."},"additionalNotifications":{"type":"array","items":{"$ref":"#/components/schemas/recipientAdditionalNotification"},"description":"An array of additional notification objects."},"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](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint.\n\nMaximum length: 100 characters."},"defaultRecipient":{"type":"string","description":"When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient."},"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](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/)\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)"},"email":{"type":"string","description":"The email address of the person associated with a role name. It is the email address of the person specified in the `name` property.\n\nFor an in-person signer, this is the email address of the host."},"emailNotification":{"$ref":"#/components/schemas/recipientEmailNotification"},"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]]`"},"inPersonSignerName":{"type":"string","description":"The full legal name of the in-person signer.\n\nMaximum Length: 100 characters."},"name":{"type":"string","description":"Specifies the recipient's name.\n\nFor an in-person signer, this is the name of the host."},"phoneNumber":{"$ref":"#/components/schemas/recipientPhoneNumber"},"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.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)"},"roleName":{"type":"string","description":"Optional element. Specifies the role name associated with the recipient.\n\nThis property is required when you are working with template recipients."},"routingOrder":{"type":"string","description":"Specifies the routing order of the recipient in the envelope. "},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"signingGroupName":{"type":"string","description":"The display name for the signing group. \n\nMaximum Length: 100 characters. "},"signingGroupType":{"type":"string"},"signingGroupUsers":{"type":"array","items":{"$ref":"#/components/schemas/userInfo"},"description":"A complex type that contains information about users in the signing group."},"tabs":{"$ref":"#/components/schemas/tabs"}},"description":"Information about a specific role.","title":"templateRole"},"envelopeGenAndSend":{"type":"object","properties":{"accessControlListBase64":{"type":"string"},"accessibility":{"type":"string"},"allowComments":{"type":"string"},"allowMarkup":{"type":"string","description":"When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this"},"allowReassign":{"type":"string","description":"When set to **true**, the recipient can redirect an envelope to a more appropriate recipient."},"allowRecipientRecursion":{"type":"string"},"allowViewHistory":{"type":"string"},"anySigner":{"type":"string"},"archiveAction":{"type":"string"},"asynchronous":{"type":"string","description":"When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"}},"attachmentsUri":{"type":"string"},"authoritativeCopy":{"type":"string","description":"Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled."},"authoritativeCopyDefault":{"type":"string"},"autoNavigation":{"type":"string"},"brandId":{"type":"string"},"brandLock":{"type":"string"},"burnDefaultTabData":{"type":"string"},"certificateUri":{"type":"string","description":"Retrieves a URI for an endpoint that allows you to easily retrieve certificate information."},"completedDateTime":{"type":"string","description":"Specifies the date and time this item was completed."},"compositeTemplates":{"type":"array","items":{"$ref":"#/components/schemas/compositeTemplate"}},"copyRecipientData":{"type":"string"},"createdDateTime":{"type":"string","description":"Indicates the date and time the item was created."},"customFields":{"$ref":"#/components/schemas/customFields"},"customFieldsUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the custom fields."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document."},"deletedDateTime":{"type":"string","description":"Specifies the data and time the item was deleted."},"deliveredDateTime":{"type":"string","description":"Reserved: For DocuSign use only."},"disableResponsiveDocument":{"type":"string"},"documentBase64":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"},"description":"Complex element contains the details on the documents in the envelope."},"documentsCombinedUri":{"type":"string"},"documentsUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the documents."},"emailBlurb":{"type":"string"},"emailSettings":{"$ref":"#/components/schemas/emailSettings"},"emailSubject":{"type":"string","description":"Specifies the subject of the email that is sent to all recipients.\n\nSee [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject."},"enableWetSign":{"type":"string","description":"When set to **true**, the signer is allowed to print the document and sign it on paper."},"enforceSignerVisibility":{"type":"string","description":"When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.\n\nYour account must have Document Visibility enabled to use this."},"envelopeAttachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"}},"envelopeClassification":{"type":"string"},"envelopeCustomMetadata":{"$ref":"#/components/schemas/envelopeCustomMetadata"},"envelopeDocuments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDocument"}},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"envelopeIdStamping":{"type":"string","description":"When set to **true**, Envelope ID Stamping is enabled."},"envelopeLocation":{"type":"string"},"envelopeMetadata":{"$ref":"#/components/schemas/envelopeMetadata"},"envelopeUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes."},"eventNotification":{"$ref":"#/components/schemas/eventNotification"},"eventNotifications":{"type":"array","items":{"$ref":"#/components/schemas/eventNotification"}},"expireAfter":{"type":"string"},"expireDateTime":{"type":"string"},"expireEnabled":{"type":"string"},"externalEnvelopeId":{"type":"string"},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"}},"generateDataSource":{"type":"string"},"generateProperties":{"type":"array","items":{"$ref":"#/components/schemas/envelopeGenAndSendProperties"}},"generateSchemaId":{"type":"string"},"hasComments":{"type":"string"},"hasFormDataChanged":{"type":"string"},"hasWavFile":{"type":"string"},"holder":{"type":"string"},"imageHandling":{"type":"string"},"initialSentDateTime":{"type":"string"},"is21CFRPart11":{"type":"string","description":"When set to **true**, indicates that this module is enabled on the account."},"isDynamicEnvelope":{"type":"string"},"isSignatureProviderEnvelope":{"type":"string"},"isTicketRelatedEnvelope":{"type":"string"},"lastModifiedDateTime":{"type":"string","description":"The date and time the item was last modified."},"location":{"type":"string"},"lockInformation":{"$ref":"#/components/schemas/lockInformation"},"messageLock":{"type":"string","description":"When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."},"notification":{"$ref":"#/components/schemas/notification"},"notificationUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the notifications."},"password":{"type":"string"},"powerForm":{"$ref":"#/components/schemas/powerForm"},"purgeCompletedDate":{"type":"string"},"purgeRequestDate":{"type":"string"},"purgeState":{"type":"string"},"recipients":{"$ref":"#/components/schemas/recipients"},"recipientsLock":{"type":"string","description":"When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope."},"recipientsUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the recipients."},"recipientViewRequest":{"$ref":"#/components/schemas/recipientViewRequest"},"saveDocumentsToArchive":{"type":"string"},"sender":{"$ref":"#/components/schemas/userInfo"},"sentDateTime":{"type":"string","description":"The date and time the envelope was sent."},"signerCanSignOnMobile":{"type":"string"},"signingLocation":{"type":"string","description":"Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online."},"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."},"statusChangedDateTime":{"type":"string","description":"The data and time the status changed."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "},"templateRoles":{"type":"array","items":{"$ref":"#/components/schemas/templateRole"}},"templatesUri":{"type":"string","description":"Contains a URI for an endpoint which you can use to retrieve the templates."},"transactionId":{"type":"string","description":" Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."},"useDisclosure":{"type":"string","description":"When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."},"uSigState":{"type":"string"},"voidedDateTime":{"type":"string","description":"The date and time the envelope or template was voided."},"voidedReason":{"type":"string","description":"The reason the envelope or template was voided."},"watermarkLanguage":{"type":"string"},"workflow":{"$ref":"#/components/schemas/workflow"}},"title":"envelopeGenAndSend"},"bulkEnvelope":{"type":"object","properties":{"bulkRecipientRow":{"type":"string","description":"The row of the recipient in the CSV file used to create the bulk recipient list."},"bulkStatus":{"type":"string","description":"Indicates the status of the bulk send operation. Returned values can be:\n* queued\n* processing\n* sent\n* failed"},"email":{"type":"string","description":"The email address of the recipient assigned to this envelope transaction."},"envelopeId":{"type":"string","description":"GUID of the bulk envelope."},"envelopeUri":{"type":"string","description":"The URI for retrieving the envelope or envelopes."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"name":{"type":"string","description":"The name of the recipient assigned to this envelope transaction."},"submittedDateTime":{"type":"string","description":"The date and time on which the bulk envelope was created."},"transactionId":{"type":"string","description":"Identifier for the envelope transaction. The ID is a sender-generated value and is valid in the Docusign system for 7 days. Docusign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transaction ID to determine an envelope's status (queued, processing, sent, or failed) in cases where the Internet connection is lost before envelope status is returned."}},"title":"bulkEnvelope"},"bulkEnvelopeStatus":{"type":"object","properties":{"batchId":{"type":"string","description":"Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches."},"batchSize":{"type":"string","description":"The number of items returned in this response."},"bulkEnvelopes":{"type":"array","items":{"$ref":"#/components/schemas/bulkEnvelope"},"description":"A list of bulk envelope objects."},"bulkEnvelopesBatchUri":{"type":"string","description":"URI at which you can retrieve the batch envelopes."},"endPosition":{"type":"string","description":"The last index position in the result set."},"failed":{"type":"string","description":"The number of entries with a status of failed. "},"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."},"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."},"queued":{"type":"string","description":"The number of entries with a status of queued. "},"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`."},"sent":{"type":"string","description":"The number of entries with a status of sent."},"startPosition":{"type":"string","description":"The starting index position of the current result set."},"submittedDate":{"type":"string","description":"The date on which the bulk envelope was created."},"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`."}},"title":"bulkEnvelopeStatus"},"envelopeArchiveSummary":{"type":"object","properties":{"bulkEnvelopeStatus":{"$ref":"#/components/schemas/bulkEnvelopeStatus"},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"recipientSigningUri":{"type":"string"},"recipientSigningUriError":{"type":"string"},"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."},"statusDateTime":{"type":"string"},"uri":{"type":"string"}},"title":"envelopeArchiveSummary"},"generatedDocument":{"type":"object","properties":{"documentAsBase64":{"type":"string"},"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."},"documentName":{"type":"string"},"fileExtension":{"type":"string"}},"title":"generatedDocument"},"generatedDocumentsResult":{"type":"object","properties":{"generatedDocuments":{"type":"array","items":{"$ref":"#/components/schemas/generatedDocument"}}},"title":"generatedDocumentsResult"},"envelopeSummary":{"type":"object","properties":{"bulkEnvelopeStatus":{"$ref":"#/components/schemas/bulkEnvelopeStatus"},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"recipientSigningUri":{"type":"string"},"recipientSigningUriError":{"type":"string"},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n- `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n- `created`: The envelope is created as a draft. It can be modified and sent later.\n- `declined`: The envelope has been declined by the recipients.\n- `delivered`: The envelope has been delivered to the recipients.\n- `sent`: The envelope will be sent to the recipients after the envelope is created.\n- `signed`: The envelope has been signed by the recipients.\n- `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope."},"statusDateTime":{"type":"string","description":"The DateTime that the envelope changed status (i.e. was created or sent.)"},"uri":{"type":"string","description":"A URI containing the user ID."}},"description":" This object describes an envelope.","title":"envelopeSummary"},"docGenConditionalOperationBase":{"type":"object","properties":{},"title":"docGenConditionalOperationBase"},"docGenConditionalRule":{"type":"object","properties":{"conditionalOperations":{"type":"array","items":{"$ref":"#/components/schemas/docGenConditionalOperationBase"}},"conditionalRuleEffect":{"type":"string"},"conditionalRuleEffectFields":{"type":"array","items":{"type":"string"}},"conditionalRuleOperator":{"type":"string"}},"title":"docGenConditionalRule"},"docGenFormFields":{"type":"object","properties":{"docGenConditionalRules":{"type":"array","items":{"$ref":"#/components/schemas/docGenConditionalRule"}},"docGenDocumentStatus":{"type":"string","description":"The status of the document. This is a read-only property, and not used in [updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/).\nValid values:\n\n- `mergesucceeded`\n- `created`\n- `hassyntaxerror`"},"docGenErrors":{"type":"array","items":{"$ref":"#/components/schemas/docGenSyntaxError"},"description":"A list of `docGenSyntaxError` objects."},"docGenFormFieldList":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormField"},"description":"A list of `docGenFormField` objects."},"documentId":{"type":"string","description":"The GUID of the document."}},"description":"A collection of document generation fields.","title":"docGenFormFields"},"docGenFormFieldResponse":{"type":"object","properties":{"docGenFormFields":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormFields"},"description":"A list of `docGenFormFields` objects."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"}},"description":"An object for document generation responses.","title":"docGenFormFieldResponse"},"docGenFormFieldRequest":{"type":"object","properties":{"docGenFormFields":{"type":"array","items":{"$ref":"#/components/schemas/docGenFormFields"},"description":"A list of `docGenFormFields` objects."}},"description":"This object maps the document generation fields to their values.","title":"docGenFormFieldRequest"},"documentHtmlDefinitions":{"type":"object","properties":{"htmlDefinitions":{"type":"array","items":{"type":"string"},"description":"Holds the properties that define how to generate the responsive-formatted HTML for the document."}},"title":"documentHtmlDefinitions"},"envelopeAttachmentsRequest":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"},"description":"An object that contains information about the attachment."}},"title":"envelopeAttachmentsRequest"},"envelopeAttachment":{"type":"object","properties":{"accessControl":{"type":"string","description":"Valid values are `sender` and `senderAndAllRecipients`."},"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"attachmentType":{"type":"string","description":"Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"label":{"type":"string"},"name":{"type":"string"}},"title":"envelopeAttachment"},"envelopeAttachmentsResult":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeAttachment"},"description":"An array of attachment objects that contain information about the attachments."}},"title":"envelopeAttachmentsResult"},"customFieldsEnvelope":{"type":"object","properties":{"listCustomFields":{"type":"array","items":{"$ref":"#/components/schemas/listCustomField"},"description":"An array of list custom fields."},"textCustomFields":{"type":"array","items":{"$ref":"#/components/schemas/textCustomField"},"description":"An array of text custom fields."}},"title":"customFieldsEnvelope"},"documentFieldsInformation":{"type":"object","properties":{"documentFields":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements:\n\n- `name`: A string that can be a maximum of 50 characters.\n- `value`: A string that can be a maximum of 200 characters.\n\nIf you are using XML, the name/value pair is contained in a `nameValue` element."}},"title":"documentFieldsInformation"},"documentHtmlDefinitionOriginal":{"type":"object","properties":{"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."},"documentIdGuid":{"type":"string","description":"The GUID of the document."},"htmlDefinition":{"$ref":"#/components/schemas/documentHtmlDefinition"}},"title":"documentHtmlDefinitionOriginal"},"documentHtmlDefinitionOriginals":{"type":"object","properties":{"htmlDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/documentHtmlDefinitionOriginal"},"description":"Holds the properties that define how to generate the responsive-formatted HTML for the document."}},"title":"documentHtmlDefinitionOriginals"},"envelopeDefinition":{"type":"object","properties":{"accessControlListBase64":{"type":"string","description":"Reserved for Docusign."},"accessibility":{"type":"string","description":"Sets the document reading zones for screen reader applications.  This element can only be used if Document Accessibility is enabled for the account. \n\n###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here."},"allowComments":{"type":"string","description":"When **true,** comments are allowed on the envelope."},"allowMarkup":{"type":"string","description":"When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level."},"allowReassign":{"type":"string","description":"When **true,** the recipient can redirect an envelope to a more appropriate recipient."},"allowRecipientRecursion":{"type":"string","description":"When **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order."},"allowViewHistory":{"type":"string","description":"When **true,** users can view the history of the envelope."},"anySigner":{"type":"string","description":"Deprecated. This feature has been replaced by signing groups."},"asynchronous":{"type":"string","description":"When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the\nConnect notification."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"},"description":"An array of attachment objects containing details about any envelope attachments."},"attachmentsUri":{"type":"string","description":"The URI for retrieving the envelope attachments."},"authoritativeCopy":{"type":"string","description":"When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"},"authoritativeCopyDefault":{"type":"string","description":"The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"brandId":{"type":"string","description":"The ID of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account.\n\n**Note:** When creating an envelope using a branded template, include this value to ensure that the brand is applied."},"brandLock":{"type":"string","description":"When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."},"burnDefaultTabData":{"type":"string"},"certificateUri":{"type":"string","description":"The URI for retrieving certificate information."},"completedDateTime":{"type":"string","description":"The date and time that the envelope was completed."},"compositeTemplates":{"type":"array","items":{"$ref":"#/components/schemas/compositeTemplate"},"description":"A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope."},"copyRecipientData":{"type":"string","description":"This value is only applicable when copying an existing envelope. Provide the ID of the envelope to clone in `envelopeId`.\n\nWhen **true,** the recipient field values of the existing envelope are included. Only values from data entry fields, like checkboxes and radio buttons, will be copied. Fields that require an action, like signatures and initials, will not be included."},"createdDateTime":{"type":"string","description":"The date and time that the envelope was created."},"customFields":{"$ref":"#/components/schemas/customFields"},"customFieldsUri":{"type":"string","description":"The URI for retrieving custom fields."},"declinedDateTime":{"type":"string","description":"The date and time that the recipient declined the envelope."},"deletedDateTime":{"type":"string","description":"The date and time that the envelope was deleted."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. This property is read-only."},"disableResponsiveDocument":{"type":"string","description":"When **true,** the responsive document feature is turned off for the envelope."},"documentBase64":{"type":"string","description":"The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"},"description":"A complex element that contains details about the documents associated with the envelope."},"documentsCombinedUri":{"type":"string","description":"The URI for retrieving all of the documents associated with the envelope as a single PDF file."},"documentsUri":{"type":"string","description":"The URI for retrieving all of the documents associated with the envelope as separate files."},"emailBlurb":{"type":"string","description":"This optional element holds the body of the email message that is sent to all envelope recipients.\n\nMaximum Length: 10000 characters."},"emailSettings":{"$ref":"#/components/schemas/emailSettings"},"emailSubject":{"type":"string","description":"The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."},"enableWetSign":{"type":"string","description":"When **true,** the signer is allowed to print the document and sign it on paper."},"enforceSignerVisibility":{"type":"string","description":"When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings](https://admindemo.docusign.com/authenticate?goTo=sending) will be enforced for the envelope. See [Fields and Properties](https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html) for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.\n\n**Note:** To use this functionality, [document visibility](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/) must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/en/contactSupport#) or your account manager to find out whether document visibility is available for your production account plan."},"envelopeAttachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"},"description":"An array of attachment objects that provide information about the attachments that are associated with the envelope."},"envelopeClassification":{"type":"string"},"envelopeCustomMetadata":{"$ref":"#/components/schemas/envelopeCustomMetadata"},"envelopeDocuments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDocument"},"description":"An array containing information about the documents that are included in the envelope."},"envelopeId":{"type":"string","description":"The envelope ID.\n\nWhen used as a request body in [Envelopes: create](/docs/esign-rest-api/reference/envelopes/envelopes/create/), this is the ID of the envelope to clone."},"envelopeIdStamping":{"type":"string","description":"When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."},"envelopeLocation":{"type":"string","description":"Reserved for Docusign."},"envelopeMetadata":{"$ref":"#/components/schemas/envelopeMetadata"},"envelopeUri":{"type":"string","description":"The URI for retrieving the envelope or envelopes."},"eventNotification":{"$ref":"#/components/schemas/eventNotification"},"eventNotifications":{"type":"array","items":{"$ref":"#/components/schemas/eventNotification"}},"expireAfter":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"expireDateTime":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"expireEnabled":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"externalEnvelopeId":{"type":"string","description":"May contain an external identifier for the envelope."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"},"description":"An array of folders that the envelope belongs to."},"hasComments":{"type":"string","description":"When **true,** indicates that users have added comments to the envelope."},"hasFormDataChanged":{"type":"string","description":"When **true,** indicates that the form data associated with the envelope has changed since it was sent. When **false,** this property does not appear in the response."},"hasWavFile":{"type":"string","description":"When **true,** indicates that a wave file (voice recording) is part of the envelope."},"holder":{"type":"string","description":"Reserved for Docusign."},"initialSentDateTime":{"type":"string","description":"The date and time that the envelope was first sent."},"is21CFRPart11":{"type":"string","description":"When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."},"isDynamicEnvelope":{"type":"string","description":"When **true,** indicates that the envelope is a dynamic envelope."},"isSignatureProviderEnvelope":{"type":"string","description":"When **true,** indicates that the envelope is a signature-provided envelope."},"isTicketRelatedEnvelope":{"type":"string"},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"location":{"type":"string","description":"Reserved for Docusign."},"lockInformation":{"$ref":"#/components/schemas/lockInformation"},"messageLock":{"type":"string","description":"When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.\n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.\n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."},"notification":{"$ref":"#/components/schemas/notification"},"notificationUri":{"type":"string","description":"The URI for retrieving notifications."},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"powerForm":{"$ref":"#/components/schemas/powerForm"},"purgeCompletedDate":{"type":"string","description":"The date that a purge was completed."},"purgeRequestDate":{"type":"string","description":"The date that a purge was requested."},"purgeState":{"type":"string","description":"Initiates a purge request. Valid values are:\n\n- `documents_queued`: Places envelope documents in the purge queue.\n- `documents_and_metadata_queued`: Places envelope documents\nand metadata in the purge queue.\n- `documents_and_metadata_and_redact_queued`: Places envelope documents\nand metadata in the purge queue and redacts personal information.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)"},"recipients":{"$ref":"#/components/schemas/recipients"},"recipientsLock":{"type":"string","description":"When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."},"recipientsUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the recipients."},"recipientViewRequest":{"$ref":"#/components/schemas/recipientViewRequest"},"sender":{"$ref":"#/components/schemas/userInfo"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"signerCanSignOnMobile":{"type":"string","description":"When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting."},"signingLocation":{"type":"string","description":"Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online."},"status":{"type":"string","description":"Indicates the envelope status. Valid values when creating an envelope are:\n\n- `created`: The envelope is created as a draft. It can be modified and sent later.\n- `sent`: The envelope will be sent to the recipients after the envelope is created.\n\nYou can query these additional statuses once the recipients have interacted with the envelope.\n\n- `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n- `declined`: The envelope has been declined by the recipients.\n- `delivered`: The envelope has been delivered to the recipients.\n- `signed`: The envelope has been signed by the recipients.\n- `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope."},"statusChangedDateTime":{"type":"string","description":"The data and time that the status changed."},"templateId":{"type":"string","description":"The ID of the template. If a value is not provided, Docusign generates a value."},"templateRoles":{"type":"array","items":{"$ref":"#/components/schemas/templateRole"},"description":"This object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements:\n\n- `email`: The recipient's email address.\n- `name`: The recipient's name.\n- `roleName`: The template roleName associated with the recipient.\n- `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true,** an error is generated on sending.\n- `defaultRecipient`: Optional, When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.\n- `routingOrder`: This specifies the routing order of the recipient in the envelope.\n- `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters.\n- `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters.\n- `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients.\n- `tabs`: This property enables the tab values to be specified for matching to tabs in the template."},"templatesUri":{"type":"string","description":"The URI for retrieving any templates associated with the envelope."},"transactionId":{"type":"string","description":"Used to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. Docusign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned."},"useDisclosure":{"type":"string","description":"When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients.\n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."},"uSigState":{"type":"string"},"voidedDateTime":{"type":"string","description":"The date and time the envelope or template was voided."},"voidedReason":{"type":"string","description":"The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters."},"watermarkLanguage":{"type":"string","description":"Gets or sets the watermark language used only for voided or copied envelopes. This feature does not affect the watermark for envelopes that are not complete. The list of supported languages is the same as the languages Docusign supports for signing."},"workflow":{"$ref":"#/components/schemas/workflow"}},"description":"Envelope object definition.","title":"envelopeDefinition"},"envelopeDocumentsResult":{"type":"object","properties":{"envelopeDocuments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDocument"},"description":"An array containing information about the documents that are included in the envelope."},"envelopeId":{"type":"string","description":"The envelope ID."}},"title":"envelopeDocumentsResult"},"documentVisibilityList":{"type":"object","properties":{"documentVisibility":{"type":"array","items":{"$ref":"#/components/schemas/documentVisibility"},"description":"An array of `documentVisibility` objects that specifies which documents are visible to which recipients."}},"description":"A list of `documentVisibility` objects that specify whether documents are visible to recipients.","title":"documentVisibilityList"},"formDataItem":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"listSelectedValue":{"type":"string","description":"The selected value in a list."},"name":{"type":"string","description":"The name of the form field."},"numericalValue":{"type":"string"},"originalNumericalValue":{"type":"string"},"originalValue":{"type":"string","description":"The initial value associated with the form field."},"value":{"type":"string","description":"The current value associated with the form field."}},"title":"formDataItem"},"prefillFormData":{"type":"object","properties":{"formData":{"type":"array","items":{"$ref":"#/components/schemas/formDataItem"}},"senderEmail":{"type":"string","description":"The sender's email address."},"senderName":{"type":"string","description":"The sender's name."},"senderUserId":{"type":"string","description":"The ID of the sender."}},"title":"prefillFormData"},"recipientFormData":{"type":"object","properties":{"DeclinedTime":{"type":"string","description":"The date and time the recipient declined the envelope."},"DeliveredTime":{"type":"string","description":"The date and time the recipient viewed the documents in the envelope in the Docusign signing UI."},"email":{"type":"string","description":"The recipient's email address."},"formData":{"type":"array","items":{"$ref":"#/components/schemas/formDataItem"},"description":"An array of form data objects."},"name":{"type":"string","description":"The name of the recipient."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"SentTime":{"type":"string","description":"The date and time the envelope was sent to the recipient."},"SignedTime":{"type":"string","description":"The date and time the recipient signed the documents."}},"title":"recipientFormData"},"envelopeFormData":{"type":"object","properties":{"emailSubject":{"type":"string","description":"The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"formData":{"type":"array","items":{"$ref":"#/components/schemas/formDataItem"},"description":"An array of `formDataItem` objects."},"prefillFormData":{"$ref":"#/components/schemas/prefillFormData"},"recipientFormData":{"type":"array","items":{"$ref":"#/components/schemas/recipientFormData"},"description":"An array of form data for each recipient of the envelope."},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"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."}},"description":"Describes the form data of the envelope.","title":"envelopeFormData"},"lockRequest":{"type":"object","properties":{"lockDurationInSeconds":{"type":"string","description":"The configured value is not used; the timeout is hardcoded to 600 seconds. To use a different timeout, implement a custom timer and explicitly control locking and unlocking."},"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."},"lockType":{"type":"string","description":"The type of lock. Currently `edit` is the only supported type."},"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."},"useScratchPad":{"type":"string","description":"When **true,** a scratchpad is used to edit information."}},"description":"This request object contains information about the lock that you want to create or update.","title":"lockRequest"},"connectHistoricalEnvelopeRepublish":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/connectCustomConfiguration"},"envelopes":{"type":"array","items":{"type":"string"},"description":"An array of envelope IDs as comma-separated strings. This property is required.\n\nFor example: `[\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\",\"9586h293-xxxx-xxxx-xxxx-m923b8opre71\",\"2347w948-xxxx-xxxx-xxxx-t096b8krno89\"]`"}},"description":"The request body for the `createHistoricalEnvelopePublishTransaction` endpoint.","title":"connectHistoricalEnvelopeRepublish"},"envelopePublishTransactionErrorRollup":{"type":"object","properties":{"count":{"type":"string","description":"The maximum number of results to return."},"errorType":{"type":"string"}},"title":"envelopePublishTransactionErrorRollup"},"envelopePublishTransaction":{"type":"object","properties":{"applyConnectSettings":{"type":"string"},"envelopeCount":{"type":"string"},"envelopeLevelErrorRollups":{"type":"array","items":{"$ref":"#/components/schemas/envelopePublishTransactionErrorRollup"}},"envelopePublishTransactionId":{"type":"string","description":"The ID of the publish transaction."},"errorCount":{"type":"string"},"fileLevelErrors":{"type":"array","items":{"type":"string"}},"noActionRequiredEnvelopeCount":{"type":"string"},"processedEnvelopeCount":{"type":"string"},"processingStatus":{"type":"string","description":"The status of the transaction. Valid values:\n\n- `unprocessed`\n- `processing`\n- `complete`\n- `fatal_error`"},"resultsUri":{"type":"string"},"submissionDate":{"type":"string"},"submittedByUserInfo":{"$ref":"#/components/schemas/userInfo"},"submittedForPublishingEnvelopeCount":{"type":"string"}},"title":"envelopePublishTransaction"},"recipientPreviewRequest":{"type":"object","properties":{"assertionId":{"type":"string","description":"A unique identifier of the authentication event executed by the client application."},"authenticationInstant":{"type":"string","description":"A sender-generated value that indicates the date and time that the signer was authenticated."},"authenticationMethod":{"type":"string","description":"Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer.\n\nChoose a value from this list:\n\n- Biometric\n- Email\n- HTTPBasicAuth\n- Kerberos\n- KnowledgeBasedAuth\n- None\n- PaperDocuments\n- Password\n- RSASecureID\n- SingleSignOn_CASiteminder\n- SingleSignOn_InfoCard\n- SingleSignOn_MicrosoftActiveDirectory\n- SingleSignOn_Other\n- SingleSignOn_Passport\n- SingleSignOn_SAML\n- Smartcard\n- SSLMutualAuth\n- X509Certificate\n\nThis information is included in the Certificate of Completion."},"clientURLs":{"$ref":"#/components/schemas/recipientTokenClientURLs"},"pingFrequency":{"type":"string","description":"Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds."},"pingUrl":{"type":"string","description":"The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"returnUrl":{"type":"string","description":"The URL to which the user will be redirected in an exit scenario. For example, if the link has expired, the user will be redirected to the URL provided here. This value must be an absolute URL.\n\nThis property is required."},"securityDomain":{"type":"string","description":"The domain in which the user authenticated."},"xFrameOptions":{"type":"string","description":"Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property."},"xFrameOptionsAllowFromUrl":{"type":"string","description":"When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property."}},"description":"This request object contains the information necessary to create a recipient preview.","title":"recipientPreviewRequest"},"viewUrl":{"type":"object","properties":{"url":{"type":"string","description":"URL for the template edit view."}},"title":"viewUrl"},"idEvidenceResourceToken":{"type":"object","properties":{"proofBaseURI":{"type":"string"},"resourceToken":{"type":"string"}},"title":"idEvidenceResourceToken"},"recipientUpdateResponse":{"type":"object","properties":{"combined":{"type":"string","description":"When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When **true,** it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."},"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."},"tabs":{"$ref":"#/components/schemas/tabs"}},"description":"The recipient details that are returned after you update the recipient.","title":"recipientUpdateResponse"},"recipientsUpdateSummary":{"type":"object","properties":{"recipientUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/recipientUpdateResponse"},"description":"An array of `recipientUpdateResults` objects that contain details about the recipients."}},"description":"This is the response that the API returns after you update recipients.","title":"recipientsUpdateSummary"},"Envelopes_Pages_DeletePage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Envelopes_Pages_DeletePage_Response_200"},"pageImages":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"pages":{"type":"array","items":{"$ref":"#/components/schemas/page"},"description":"An array of page objects."},"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."},"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`."}},"title":"pageImages"},"userSignature":{"type":"object","properties":{"adoptedDateTime":{"type":"string","description":"The date and time the user adopted their signature."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"customField":{"type":"string"},"dateStampProperties":{"$ref":"#/components/schemas/dateStampProperties"},"disallowUserResizeStamp":{"type":"string","description":"When **true,** users may not resize the stamp."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"externalID":{"type":"string","description":"Optionally specify an external identifier for the user's signature."},"imageBase64":{"type":"string","description":"A Base64-encoded representation of the signature image."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"},"initials150ImageId":{"type":"string","description":"The ID of the user's initials image."},"initialsImageUri":{"type":"string","description":"The URI for retrieving the image of the user's initials."},"isDefault":{"type":"string","description":"Boolean that specifies whether the signature is the default signature for the user."},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"nrdsId":{"type":"string","description":"The National Association of Realtors (NAR) membership ID for a user who is a realtor."},"nrdsLastName":{"type":"string","description":"The realtor's last name."},"nrdsStatus":{"type":"string","description":"The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`"},"phoneticName":{"type":"string","description":"The phonetic spelling of the `signatureName`."},"signature150ImageId":{"type":"string","description":"The ID of the user's signature image."},"signatureFont":{"type":"string","description":"The font type for the signature, if the signature is not drawn. The supported font types are:\n\n\"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\"\n"},"signatureId":{"type":"string","description":"Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."},"signatureImageUri":{"type":"string","description":"An endpoint URI that you can use to retrieve the user's signature image."},"signatureInitials":{"type":"string","description":" The initials associated with the signature."},"signatureName":{"type":"string","description":"Specifies the user's signature name."},"signatureRights":{"type":"string","description":"The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`"},"signatureType":{"type":"string","description":"Specifies the type of signature."},"stampFormat":{"type":"string","description":"The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date."},"stampImageUri":{"type":"string","description":"The URI for retrieving the image of the user's stamp."},"stampSizeMM":{"type":"string","description":"The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."},"stampType":{"type":"string","description":"The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"},"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."}},"title":"userSignature"},"envelopeAuditEvent":{"type":"object","properties":{"eventFields":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"}}},"title":"envelopeAuditEvent"},"paymentAuditEvent":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID associated with the envelope."},"action":{"type":"string"},"actorDisplayName":{"type":"string"},"eventDescription":{"type":"string"},"eventType":{"type":"string"},"responsibleActor":{"type":"string"},"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."},"timestamp":{"type":"string"}},"title":"paymentAuditEvent"},"envelopeAuditEventResponse":{"type":"object","properties":{"auditEvents":{"type":"array","items":{"$ref":"#/components/schemas/envelopeAuditEvent"},"description":"Reserved for Docusign."},"paymentEvents":{"type":"array","items":{"$ref":"#/components/schemas/paymentAuditEvent"}}},"title":"envelopeAuditEventResponse"},"envelopeIdsRequest":{"type":"object","properties":{"envelopeIds":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of envelope IDs to include in the results."},"transactionIds":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days."}},"description":"Lists of envelope and transaction IDs to use in the results.\n\nIf you use this request body with Envelopes: listStatus,\nyou must set one or both of the following query parameters\nto the special value `request_body`:\n\n- `envelope_ids=request_body`\n- `transaction_ids=request_body`\n","title":"envelopeIdsRequest"},"pageRequest":{"type":"object","properties":{"password":{"type":"string","description":"The password used to lock this eSignature template if this envelope was created from a template (provided in clear text).\n[Template passwords](https://support.docusign.com/s/document-item?language=en_US&bundleId=xry1643227563338&topicId=xwo1578456395432.html&_LANG=enus) protect against editing, sharing, copying, or downloading a template. You can set a password on any template you create."},"rotate":{"type":"string","description":"Sets the direction the page image is rotated. The possible settings are: left or right"}},"title":"pageRequest"},"Envelopes_Pages_PutPageImage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Envelopes_Pages_PutPageImage_Response_200"},"envelopeUpdateSummary":{"type":"object","properties":{"bulkEnvelopeStatus":{"$ref":"#/components/schemas/bulkEnvelopeStatus"},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"listCustomFieldUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/listCustomField"}},"lockInformation":{"$ref":"#/components/schemas/lockInformation"},"purgeState":{"type":"string","description":"Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)"},"recipientUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/recipientUpdateResponse"},"description":"An array of `recipientUpdateResults` objects that contain details about the recipients."},"tabUpdateResults":{"$ref":"#/components/schemas/tabs"},"textCustomFieldUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/textCustomField"}}},"title":"envelopeUpdateSummary"},"envelopeNotificationRequest":{"type":"object","properties":{"expirations":{"$ref":"#/components/schemas/expirations"},"reminders":{"$ref":"#/components/schemas/reminders"},"useAccountDefaults":{"type":"string","description":"When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"}},"description":"A complex element that specifies the notification settings for the envelope.","title":"envelopeNotificationRequest"},"Envelopes_Recipients_PutRecipientInitialsImage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Envelopes_Recipients_PutRecipientInitialsImage_Response_200"},"Envelopes_Recipients_PutRecipientSignatureImage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Envelopes_Recipients_PutRecipientSignatureImage_Response_200"},"envelopesShareRequest":{"type":"object","properties":{"agentUser":{"$ref":"#/components/schemas/authorizationUser"},"customMessage":{"type":"string"},"permission":{"type":"string"},"shareId":{"type":"string"}},"title":"envelopesShareRequest"},"envelopesSharesRequest":{"type":"object","properties":{"shares":{"type":"array","items":{"$ref":"#/components/schemas/envelopesShareRequest"},"description":"An array of objects that contain information on the accounts to whom the envelope will be shared. Each object in the array holds the information for one account. Required."}},"title":"envelopesSharesRequest"},"envelopesShareResponse":{"type":"object","properties":{"agentUser":{"$ref":"#/components/schemas/authorizationUser"},"createdTimestamp":{"type":"string"},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"modifiedTimestamp":{"type":"string"},"permission":{"type":"string"},"senderInfo":{"$ref":"#/components/schemas/authorizationUser"},"shareId":{"type":"string"},"subject":{"type":"string"}},"title":"envelopesShareResponse"},"envelopesSharesResponse":{"type":"object","properties":{"shares":{"type":"array","items":{"$ref":"#/components/schemas/envelopesShareResponse"}}},"title":"envelopesSharesResponse"},"Uncategorized_EnvelopesShares_DeleteEnvelopesShare_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopesShares_DeleteEnvelopesShare_Response_200"},"Uncategorized_EnvelopesShares_DeleteEnvelopesShares_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopesShares_DeleteEnvelopesShares_Response_200"},"envelopesSharePermissionRequest":{"type":"object","properties":{"customMessage":{"type":"string"},"permission":{"type":"string"}},"title":"envelopesSharePermissionRequest"},"documentTemplate":{"type":"object","properties":{"documentEndPage":{"type":"string"},"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."},"documentStartPage":{"type":"string"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, Docusign generates an error and the call fails."}},"title":"documentTemplate"},"documentTemplateList":{"type":"object","properties":{"documentTemplates":{"type":"array","items":{"$ref":"#/components/schemas/documentTemplate"}}},"title":"documentTemplateList"},"Envelopes_Templates_DeleteDocumentTemplates_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Envelopes_Templates_DeleteDocumentTemplates_Response_200"},"templateMatch":{"type":"object","properties":{"documentEndPage":{"type":"string"},"documentStartPage":{"type":"string"},"matchPercentage":{"type":"string"}},"title":"templateMatch"},"templateSummary":{"type":"object","properties":{"applied":{"type":"string","description":"Reserved for Docusign."},"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."},"documentName":{"type":"string","description":"The name of the document."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"name":{"type":"string","description":"The name of the template."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "},"templateMatch":{"$ref":"#/components/schemas/templateMatch"},"uri":{"type":"string","description":"A URI containing the user ID."}},"description":"Summary of a template request.","title":"templateSummary"},"templateInformation":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/templateSummary"},"description":"An array of `templateSummary` objects that contain information about templates."}},"title":"templateInformation"},"envelopeTransferRuleRequest":{"type":"object","properties":{"carbonCopyOriginalOwner":{"type":"string","description":"When `true`, the original owner is added as a carbon copy recipient after envelope transfer. The default value is `false`."},"enabled":{"type":"string","description":"When `true`, the envelope transfer rule is active."},"envelopeTransferRuleId":{"type":"string","description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created."},"eventType":{"type":"string","description":"The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `beforeSent`\n- `completed`"},"fromGroups":{"type":"array","items":{"$ref":"#/components/schemas/group"},"description":"Information about the group that triggers the transfer."},"fromUsers":{"type":"array","items":{"$ref":"#/components/schemas/userInformation"},"description":"Information about the user who triggers the transfer."},"modifiedDate":{"type":"string","description":"The UTC DateTime when the envelope transfer rule was last modified. This property is read-only."},"modifiedUser":{"$ref":"#/components/schemas/userInformation"},"toFolder":{"$ref":"#/components/schemas/folder"},"toUser":{"$ref":"#/components/schemas/userInformation"}},"description":"This object contains details about the envelope transfer rule that you want to create.","title":"envelopeTransferRuleRequest"},"envelopeTransferRule":{"type":"object","properties":{"carbonCopyOriginalOwner":{"type":"string","description":"When `true`, the original owner is added as a carbon copy recipient after envelope transfer. The default value is `false`."},"enabled":{"type":"string","description":"When `true`, the envelope transfer rule is active."},"envelopeTransferRuleId":{"type":"string","description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created."},"eventType":{"type":"string","description":"The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `beforeSent`\n- `completed`"},"fromGroup":{"$ref":"#/components/schemas/group"},"fromUser":{"$ref":"#/components/schemas/userInformation"},"modifiedDate":{"type":"string","description":"The UTC DateTime when the envelope transfer rule was last modified. This property is read-only."},"modifiedUser":{"$ref":"#/components/schemas/userInformation"},"toFolder":{"$ref":"#/components/schemas/folder"},"toUser":{"$ref":"#/components/schemas/userInformation"}},"description":"This object contains details about an envelope transfer rule.","title":"envelopeTransferRule"},"envelopeTransferRuleInformation":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"envelopeTransferRules":{"type":"array","items":{"$ref":"#/components/schemas/envelopeTransferRule"},"description":"Contains information about a specific envelope transfer rule."},"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."},"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."},"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`."}},"title":"envelopeTransferRuleInformation"},"Uncategorized_EnvelopeTransferRules_DeleteEnvelopeTransferRules_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopeTransferRules_DeleteEnvelopeTransferRules_Response_200"},"consoleViewRequest":{"type":"object","properties":{"envelopeId":{"type":"string","description":"The ID of an envelope. If the envelope has been sent, the endpoint returns a URL for a view of the documents. If the envelope has not yet been sent, the endpoint returns a URL for the sender view.\n\nThis property is optional. If no value is provided, the endpoint returns a URL for the front page of the demo UI."},"returnUrl":{"type":"string","description":"The URL to which the user should be redirected. This is only used when the `envelopeId` is specified as a draft envelope. In this case, the endpoint returns a URL for the sender view. When the user exits the sender view, they will be redirected to the `returnUrl` value. If no value is provided, there is no option to leave the sender view.\n\nIn other cases, the user is not redirected out of the console view."}},"description":"The request object for the [EnvelopeViews: createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) method.","title":"consoleViewRequest"},"envelopeViewDocumentSettings":{"type":"object","properties":{"showEditDocuments":{"type":"string","description":"When `false,` prevents the app user from adding, replacing, or deleting documents. The default value is `true`.\n\n**Note:** An existing document in the envelope can also be deleted by deleting all of the document’s pages via the document’s thumbnail images. To prohibit this, see the `ShowEditPages` attribute."},"showEditDocumentVisibility":{"type":"string","description":"When `false`, prevents the user from modifying document visibility settings. The default value is `true`."},"showEditPages":{"type":"string","description":"When `false`, prevents the user from deleting or rotating individual document pages via the document’s thumbnail images. The default value is `true`."},"showSaveAsDocumentCustomField":{"type":"string","description":"Reserved for Docusign."}},"title":"envelopeViewDocumentSettings"},"envelopeViewEnvelopeCustomFieldSettings":{"type":"object","properties":{"showEnvelopeCustomFields":{"type":"string","description":"Reserved for Docusign."}},"title":"envelopeViewEnvelopeCustomFieldSettings"},"envelopeViewRecipientSettings":{"type":"object","properties":{"showBulkSend":{"type":"string","description":"Reserved for Docusign."},"showContactsList":{"type":"string","description":"When `false`, the user will not be able to use the contacts list when selecting recipients for this envelope. The default value is `true`."},"showEditMessage":{"type":"string","description":"Reserved for Docusign."},"showEditRecipients":{"type":"string","description":"When `false`, prevents the user from changing the recipients from the **Tagger** page. The default value is `true`."}},"title":"envelopeViewRecipientSettings"},"paletteItemSettings":{"type":"object","properties":{"show":{"type":"string","description":"Reserved for Docusign."}},"title":"paletteItemSettings"},"paletteSettings":{"type":"object","properties":{"annotations":{"$ref":"#/components/schemas/paletteItemSettings"},"custom":{"$ref":"#/components/schemas/paletteItemSettings"},"merge":{"$ref":"#/components/schemas/paletteItemSettings"},"notary":{"$ref":"#/components/schemas/paletteItemSettings"},"seals":{"$ref":"#/components/schemas/paletteItemSettings"},"smartContracts":{"$ref":"#/components/schemas/paletteItemSettings"},"smartSections":{"$ref":"#/components/schemas/paletteItemSettings"}},"description":"Reserved for Docusign.","title":"paletteSettings"},"envelopeViewTaggerSettings":{"type":"object","properties":{"paletteDefault":{"type":"string","description":"When `paletteSections` is set to `custom`, this property selects the default tagger palette.\nValid values:\n\n- `custom`\n- `merge`\n- `notary`\n- `seals`\n- `smartContracts`\n- `annotations`\n- `smartSections`"},"paletteSections":{"type":"string","description":"Valid values:\n\n- `default` (default): The default tagger palette UX\n- `none`: No tagger palette\n- `custom`: Set by `paletteDefault`"},"paletteSettings":{"$ref":"#/components/schemas/paletteSettings"}},"title":"envelopeViewTaggerSettings"},"envelopeViewTemplateSettings":{"type":"object","properties":{"showMatchingTemplatesPrompt":{"type":"string","description":"When **true,** the auto-match template modal dialog will appear when the prepare page is loaded in the embedded sending experience. When **false,** the auto-match template modal dialog will not be shown."}},"title":"envelopeViewTemplateSettings"},"envelopeViewSettings":{"type":"object","properties":{"backButtonAction":{"type":"string","description":"Sets the behavior of the back button when clicked. Valid values:\n\n- `previousPage`: Navigate to browser's previous page\n- `redirect`: Redirect to the `returnUrl` specified in the request"},"documentSettings":{"$ref":"#/components/schemas/envelopeViewDocumentSettings"},"envelopeCustomFieldSettings":{"$ref":"#/components/schemas/envelopeViewEnvelopeCustomFieldSettings"},"lockToken":{"type":"string","description":"If your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications."},"recipientSettings":{"$ref":"#/components/schemas/envelopeViewRecipientSettings"},"sendButtonAction":{"type":"string","description":"Sets the behavior of the send button when clicked. Valid values:\n\n- `send`: send the envelope and redirect with query parameter `event=Send` (default)\n- `redirect`: Change the Tagger page's button text to 'Continue'; when clicked, redirect to the `returnUrl` with query parameter `event=Save`. Set `showBackButton` to `false` and `startingScreen` to `Tagger`."},"showAdvancedOptions":{"type":"string","description":"Reserved for Docusign."},"showBackButton":{"type":"string","description":"Determines whether the Tagger's back button is shown. Valid values:\n\n- `true`: The back button is shown. This is the default value.\n- `false`: Prevents access to the Prepare screen by hiding the back button."},"showDiscardAction":{"type":"string","description":"When **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**"},"showHeaderActions":{"type":"string","description":"Determines whether the Actions menu displays advanced actions. Valid values:\n\n- `true`: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value.\n- `false`: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set `startingScreen` to `Tagger` and `showBackButton` to `false`."},"showSignNow":{"type":"string","description":"When `true` and the sender is the first recipient (and not using bulk send or send later), the sender will be prompted to sign immediately after sending the envelope. Otherwise, the envelope is sent without launching the signing flow for the sender from the envelope sending view."},"startingScreen":{"type":"string","description":"Determines the starting screen for the sender view. Valid values:\n\n- `Prepare` (default)\n- `Tagger`"},"taggerSettings":{"$ref":"#/components/schemas/envelopeViewTaggerSettings"},"templateSettings":{"$ref":"#/components/schemas/envelopeViewTemplateSettings"}},"title":"envelopeViewSettings"},"envelopeViewRequest":{"type":"object","properties":{"returnUrl":{"type":"string","description":"**Required**\n\nIdentifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are:\n\n- send (user sends the envelope)\n- save (user saves the envelope)\n- cancel (user cancels the sending transaction. No envelopeId is returned in this case.)\n- error (there is an error when performing the send)\n- sessionEnd (the sending session ends before the user completes another action)."},"settings":{"$ref":"#/components/schemas/envelopeViewSettings"},"viewAccess":{"type":"string","description":"**Required** . Set to `envelope`"}},"title":"envelopeViewRequest"},"correctViewRequest":{"type":"object","properties":{"beginOnTagger":{"type":"string"},"returnUrl":{"type":"string","description":"(Required) The URL to which the user should be redirected after\nthe view session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\nWhen Docusign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n- `send`: User corrected and sent the envelope.\n- `save`: User saved the envelope.\n- `cancel`: User canceled the transaction.\n- `error`: There was an error when performing the correct or send.\n- `sessionEnd`: The session ended before the user completed a different action."},"suppressNavigation":{"type":"string","description":"Specifies whether the window is displayed with or without dressing."},"viewUrl":{"type":"string"}},"description":"The request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method.","title":"correctViewRequest"},"Uncategorized_Views_DeleteEnvelopeCorrectView_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_Views_DeleteEnvelopeCorrectView_Response_200"},"Uncategorized_EnvelopeWorkflowDelayedRouting_DeleteEnvelopeDelayedRoutingDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopeWorkflowDelayedRouting_DeleteEnvelopeDelayedRoutingDefinition_Response_200"},"Uncategorized_EnvelopeWorkflowScheduledSending_DeleteEnvelopeScheduledSendingDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopeWorkflowScheduledSending_DeleteEnvelopeScheduledSendingDefinition_Response_200"},"Uncategorized_EnvelopeWorkflowDefinitionV2_DeleteEnvelopeWorkflowDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopeWorkflowDefinitionV2_DeleteEnvelopeWorkflowDefinition_Response_200"},"Uncategorized_EnvelopeWorkflowStep_DeleteEnvelopeWorkflowStepDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_EnvelopeWorkflowStep_DeleteEnvelopeWorkflowStepDefinition_Response_200"},"Uncategorized_TemplateWorkflowDelayedRouting_DeleteTemplateDelayedRoutingDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_TemplateWorkflowDelayedRouting_DeleteTemplateDelayedRoutingDefinition_Response_200"},"Uncategorized_TemplateWorkflowScheduledSending_DeleteTemplateScheduledSendingDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_TemplateWorkflowScheduledSending_DeleteTemplateScheduledSendingDefinition_Response_200"},"Uncategorized_TemplateWorkflowDefinition_DeleteTemplateWorkflowDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_TemplateWorkflowDefinition_DeleteTemplateWorkflowDefinition_Response_200"},"Uncategorized_TemplateWorkflowStep_DeleteTemplateWorkflowStepDefinition_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_TemplateWorkflowStep_DeleteTemplateWorkflowStepDefinition_Response_200"},"jurisdiction":{"type":"object","properties":{"allowSystemCreatedSeal":{"type":"string","description":"When **true,** the seal can be generated by the platform."},"allowUserUploadedSeal":{"type":"string","description":"When **true,** the seal can be uploaded by the user."},"commissionIdInSeal":{"type":"string","description":"When **true,** the notary's `comissionId` appears in the seal."},"county":{"type":"string","description":"The county of the jurisdiction."},"countyInSeal":{"type":"string","description":"When **true,** the county name appears in the seal."},"enabled":{"type":"string","description":"When **true,** this jurisdiction is enabled."},"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`"},"name":{"type":"string","description":"The name of the jurisdiction. Typically the state name."},"notaryPublicInSeal":{"type":"string","description":"When **true,** the name of the notary appears in the seal."},"stateNameInSeal":{"type":"string","description":"When **true,** the name of the state appears in the seal."}},"description":"Describes the jurisdiction of a notary.\nThis is read-only object.","title":"jurisdiction"},"notaryJournalCredibleWitness":{"type":"object","properties":{"address":{"type":"string","description":"The address of the witness."},"name":{"type":"string","description":"The name of the witness."},"signatureImage":{"type":"string","description":"A base64-encoded image of the signature."}},"title":"notaryJournalCredibleWitness"},"notaryJournalMetaData":{"type":"object","properties":{"comment":{"type":"string","description":"A freeform comment that the notary can add to the journal entry."},"credibleWitnesses":{"type":"array","items":{"$ref":"#/components/schemas/notaryJournalCredibleWitness"},"description":"An array of witnesses."},"signatureImage":{"type":"string","description":"A base64-encoded image of the signature."},"signerIdType":{"type":"string","description":"A string that describes the ID that the signer presented. For example `drivers license` or `military ID`."}},"title":"notaryJournalMetaData"},"notaryJournal":{"type":"object","properties":{"createdDate":{"type":"string","description":"The creation date of the account in UTC timedate format."},"documentName":{"type":"string","description":"The name of the document."},"jurisdiction":{"$ref":"#/components/schemas/jurisdiction"},"notaryJournalId":{"type":"string","description":"A unique GUID for this journal entry."},"notaryJournalMetaData":{"$ref":"#/components/schemas/notaryJournalMetaData"},"signerName":{"type":"string","description":"The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters."}},"title":"notaryJournal"},"notaryJournalList":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"notaryJournals":{"type":"array","items":{"$ref":"#/components/schemas/notaryJournal"}},"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."},"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`."}},"title":"notaryJournalList"},"Uncategorized_TabsBlob_GetTabsBlob_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_TabsBlob_GetTabsBlob_Response_200"},"Uncategorized_TabsBlob_PutTabsBlob_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_TabsBlob_PutTabsBlob_Response_200"},"foldersResponse":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/envelopeSummary"}},"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."},"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."},"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`."}},"title":"foldersResponse"},"folderItemsResponse":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/envelopeSummary"}},"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."},"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."},"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`."}},"title":"folderItemsResponse"},"foldersRequest":{"type":"object","properties":{"envelopeIds":{"type":"array","items":{"type":"string"},"description":"An array of envelope ID GUIDs."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"},"description":"Not used."},"fromFolderId":{"type":"string","description":"The ID of the folder that the envelope is being moved from."}},"description":"Information for a folder request.","title":"foldersRequest"},"folderItemResponse":{"type":"object","properties":{"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. "},"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."},"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."},"totalRows":{"type":"string","description":"The total number of items in the result."}},"description":"Results from a folder item request.","title":"folderItemResponse"},"notary":{"type":"object","properties":{"createdDate":{"type":"string","description":"The creation date of the account in UTC timedate format."},"enabled":{"type":"string","description":"The date the this object was created."},"searchable":{"type":"string","description":"When **true,** this notary is searchable."},"userInfo":{"$ref":"#/components/schemas/userInformation"}},"title":"notary"},"notaryResult":{"type":"object","properties":{"jurisdictions":{"type":"array","items":{"$ref":"#/components/schemas/jurisdiction"}},"notary":{"$ref":"#/components/schemas/notary"}},"description":"Describes a single notary jurisdiction.","title":"notaryResult"},"notaryJurisdiction":{"type":"object","properties":{"commissionExpiration":{"type":"string","description":"The expiration date of the notary's commission in format: `MM/DD/YYYY`."},"commissionId":{"type":"string","description":"The notary's commission identification. This varies from jurisdiction to jurisdiction."},"county":{"type":"string","description":"The county that the commission is valid in."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"jurisdiction":{"$ref":"#/components/schemas/jurisdiction"},"registeredName":{"type":"string","description":"The registered name of the notary."},"sealType":{"type":"string","description":"The seal type used for this juridiction.\n\n- `not_available`\n- `system_created`\n- `user_uploaded`"}},"description":"A notary jurisdiction.","title":"notaryJurisdiction"},"Uncategorized_NotaryJurisdictions_DeleteNotaryJurisdiction_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Uncategorized_NotaryJurisdictions_DeleteNotaryJurisdiction_Response_200"},"notaryJurisdictionList":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"notaryJurisdictions":{"type":"array","items":{"$ref":"#/components/schemas/notaryJurisdiction"},"description":"An array of jurisdictions."},"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."},"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`."}},"description":"A paged list of jurisdictions.","title":"notaryJurisdictionList"},"paymentGatewayAccountSetting":{"type":"object","properties":{"apiFields":{"type":"string"},"authorizationCode":{"type":"string"},"credentialStatus":{"type":"string"},"merchantId":{"type":"string"}},"title":"paymentGatewayAccountSetting"},"payPalLegacySettings":{"type":"object","properties":{"currency":{"type":"string","description":"The three-letter\n[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment.\n\nFor example:\n\n- AUD Australian dollar\n- CAD Canadian dollar\n- EUR Euro\n- GBP Great Britain pound\n- USD United States dollar\n\nThis is a read-only property."},"partner":{"type":"string"},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"userName":{"type":"string","description":"The name of the user."},"vendor":{"type":"string"}},"title":"payPalLegacySettings"},"paymentMethodWithOptions":{"type":"object","properties":{"supportedCurrencies":{"type":"array","items":{"type":"string"},"description":"A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples:\n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"},"supportedOptions":{"type":"array","items":{"type":"string"},"description":"The payment options that are compatible with the payment method in the `type` property.\n\nPossible values are:\n\n- `save`\n- `save_and_authorize`\n- `authorize`"},"type":{"type":"string","description":"The name of a payment method that the gateway accepts.\n\nPossible values are:\n\n- `CreditCard`\n- `ApplePay`\n- `AndroidPay`\n- `BankAccount`\n- `PayPal`"}},"description":"This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.","title":"paymentMethodWithOptions"},"paymentGatewayAccount":{"type":"object","properties":{"allowCustomMetadata":{"type":"boolean","description":"When **true,** the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`.\n\nFor example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description.**\n\n**Note:** This property is read-only and cannot be changed."},"config":{"$ref":"#/components/schemas/paymentGatewayAccountSetting"},"displayName":{"type":"string","description":"A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`."},"isEnabled":{"type":"string","description":"When **true,** the payment gateway account is enabled."},"isLegacy":{"type":"string","description":"Reserved for Docusign."},"lastModified":{"type":"string","description":"The UTC DateTime that the payment gateway account was last updated."},"paymentGateway":{"type":"string","description":"Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n- `Stripe`\n- `Braintree`\n- `AuthorizeDotNet`\n- `CyberSource`\n- `Zuora`\n- `Elavon`"},"paymentGatewayAccountId":{"type":"string","description":"A GUID that identifies the payment gateway account. For a human-readable version use `displayName`."},"paymentGatewayDisplayName":{"type":"string","description":"The display name of the payment gateway that the connected gateway account uses.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n- Stripe\n- Braintree\n- Authorize.Net\n- CyberSource\n- Zuora\n- Elavon"},"payPalLegacySettings":{"$ref":"#/components/schemas/payPalLegacySettings"},"supportedCurrencies":{"type":"array","items":{"type":"string"},"description":"A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples:\n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"},"supportedPaymentMethods":{"type":"array","items":{"type":"string"},"description":"An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway."},"supportedPaymentMethodsWithOptions":{"type":"array","items":{"$ref":"#/components/schemas/paymentMethodWithOptions"},"description":"An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method."},"zeroDecimalCurrencies":{"type":"array","items":{"type":"string"}}},"description":"This object contains details about a payment gateway account.","title":"paymentGatewayAccount"},"paymentGatewayAccountsInfo":{"type":"object","properties":{"paymentGatewayAccounts":{"type":"array","items":{"$ref":"#/components/schemas/paymentGatewayAccount"},"description":"A list of payment gateway accounts."}},"description":"Holds information about connected payment accounts.","title":"paymentGatewayAccountsInfo"},"powerFormFormDataRecipient":{"type":"object","properties":{"email":{"type":"string"},"formData":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"}},"name":{"type":"string","description":"The name of the recipient."},"recipientId":{"type":"string","description":"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."}},"title":"powerFormFormDataRecipient"},"powerFormFormDataEnvelope":{"type":"object","properties":{"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/powerFormFormDataRecipient"},"description":"An array of recipient objects that provides details about the recipients of the envelope."}},"title":"powerFormFormDataEnvelope"},"powerFormsFormDataResponse":{"type":"object","properties":{"envelopes":{"type":"array","items":{"$ref":"#/components/schemas/powerFormFormDataEnvelope"}}},"title":"powerFormsFormDataResponse"},"PowerForms_deletepowerform_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"PowerForms_deletepowerform_Response_200"},"powerFormsRequest":{"type":"object","properties":{"powerForms":{"type":"array","items":{"$ref":"#/components/schemas/powerForm"},"description":"An array of PowerForm objects."}},"title":"powerFormsRequest"},"powerFormsResponse":{"type":"object","properties":{"endPosition":{"type":"integer","description":"The last index position in the result set."},"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."},"powerForms":{"type":"array","items":{"$ref":"#/components/schemas/powerForm"},"description":"An array of PowerForm objects."},"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":"integer","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":"integer","description":"The starting index position of the current result set."},"totalSetSize":{"type":"integer","description":"The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."}},"description":"A list of PowerForms.","title":"powerFormsResponse"},"powerFormSendersResponse":{"type":"object","properties":{"endPosition":{"type":"integer","description":"The last index position in the result set."},"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."},"powerFormSenders":{"type":"array","items":{"$ref":"#/components/schemas/userInfo"},"description":"An array of `userInfo` objects containing information about users who have sent PowerForms."},"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":"integer","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":"integer","description":"The starting index position of the current result set."},"totalSetSize":{"type":"integer","description":"The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."}},"description":"This object includes information about the users who have sent PowerForms.","title":"powerFormSendersResponse"},"signingGroupUser":{"type":"object","properties":{"email":{"type":"string"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"userName":{"type":"string","description":"The name of the group member. \n\nMaximum Length: 100 characters. "}},"title":"signingGroupUser"},"signingGroup":{"type":"object","properties":{"created":{"type":"string","description":"The UTC DateTime when the signing group was created. This property is read-only."},"createdBy":{"type":"string","description":"The name of the user who created the signing group. This property is read-only."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"groupEmail":{"type":"string","description":"The email address for the signing group. You can use a group email address to email all of the group members at the same time."},"groupName":{"type":"string","description":"The name of the group."},"groupType":{"type":"string","description":"The type of the group. The only valid value for this request is `sharedSigningGroup`."},"modified":{"type":"string","description":"The UTC DateTime when the signing group was last modified. This property is read-only."},"modifiedBy":{"type":"string","description":"The user ID (GUID) of the user who last modified this user record. This property is read-only."},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"users":{"type":"array","items":{"$ref":"#/components/schemas/signingGroupUser"},"description":"User management information."}},"description":"Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.","title":"signingGroup"},"signingGroupInformation":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/signingGroup"},"description":"A collection group objects containing information about the groups."}},"title":"signingGroupInformation"},"signingGroupUsers":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/signingGroupUser"},"description":"User management information."}},"title":"signingGroupUsers"},"templateCustomFields":{"type":"object","properties":{"listCustomFields":{"type":"array","items":{"$ref":"#/components/schemas/listCustomField"},"description":"An array of list custom fields."},"textCustomFields":{"type":"array","items":{"$ref":"#/components/schemas/textCustomField"},"description":"An array of text custom fields."}},"title":"templateCustomFields"},"templateDocumentsResult":{"type":"object","properties":{"templateDocuments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDocument"},"description":"An array of document objects that contain information about the documents associated with the template."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "}},"description":"The results of this method.","title":"templateDocumentsResult"},"templateTabs":{"type":"object","properties":{"approveTabs":{"type":"array","items":{"$ref":"#/components/schemas/approve"},"description":"A list of\n[Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set."},"checkboxTabs":{"type":"array","items":{"$ref":"#/components/schemas/checkbox"},"description":"A list of\n[Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set."},"commentThreadTabs":{"type":"array","items":{"$ref":"#/components/schemas/commentThread"},"description":"An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set."},"commissionCountyTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionCounty"},"description":"A list of\n[Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"commissionExpirationTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionExpiration"},"description":"A list of\n[Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"commissionNumberTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionNumber"},"description":"A list of\n[Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"commissionStateTabs":{"type":"array","items":{"$ref":"#/components/schemas/commissionState"},"description":"A list of\n[Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient."},"companyTabs":{"type":"array","items":{"$ref":"#/components/schemas/company"},"description":"A list of\n[Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company).\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set."},"dateSignedTabs":{"type":"array","items":{"$ref":"#/components/schemas/dateSigned"},"description":"A list of\n[Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set."},"dateTabs":{"type":"array","items":{"$ref":"#/components/schemas/date"},"description":"A list of\n[Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message."},"declineTabs":{"type":"array","items":{"$ref":"#/components/schemas/decline"},"description":"A list of\n[Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set."},"drawTabs":{"type":"array","items":{"$ref":"#/components/schemas/draw"},"description":"A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."},"emailAddressTabs":{"type":"array","items":{"$ref":"#/components/schemas/emailAddress"},"description":"A list of\n[Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set."},"emailTabs":{"type":"array","items":{"$ref":"#/components/schemas/email"},"description":"A list of\n[Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response."},"envelopeIdTabs":{"type":"array","items":{"$ref":"#/components/schemas/envelopeId"},"description":"A list of\n[Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid).\n\nAn Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set."},"firstNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/firstName"},"description":"A list of\n[First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname).\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set."},"formulaTabs":{"type":"array","items":{"$ref":"#/components/schemas/formulaTab"},"description":"A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html).\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html)."},"fullNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/fullName"},"description":"A list of\n[Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Full Name tab displays the recipient's full name. This value can't be set."},"initialHereTabs":{"type":"array","items":{"$ref":"#/components/schemas/initialHere"},"description":"A list of\n[Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set."},"lastNameTabs":{"type":"array","items":{"$ref":"#/components/schemas/lastName"},"description":"A list of\n[Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set."},"listTabs":{"type":"array","items":{"$ref":"#/components/schemas/list"},"description":"An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)."},"notarizeTabs":{"type":"array","items":{"$ref":"#/components/schemas/notarize"},"description":"A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page."},"notarySealTabs":{"type":"array","items":{"$ref":"#/components/schemas/notarySeal"},"description":"A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/)."},"noteTabs":{"type":"array","items":{"$ref":"#/components/schemas/note"},"description":"A list of\n[Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set."},"numberTabs":{"type":"array","items":{"$ref":"#/components/schemas/number"},"description":"A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs)."},"numericalTabs":{"type":"array","items":{"$ref":"#/components/schemas/numerical"},"description":"A list of numerical tabs.\n\nNumerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."},"phoneNumberTabs":{"type":"array","items":{"$ref":"#/components/schemas/phoneNumber"},"description":"A list of\n[Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/)."},"polyLineOverlayTabs":{"type":"array","items":{"$ref":"#/components/schemas/polyLineOverlay"},"description":"This type of tab enables the recipient to strike through document text. This value can't be set."},"prefillTabs":{"$ref":"#/components/schemas/prefillTabs"},"radioGroupTabs":{"type":"array","items":{"$ref":"#/components/schemas/radioGroup"},"description":"A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set."},"signerAttachmentTabs":{"type":"array","items":{"$ref":"#/components/schemas/signerAttachment"},"description":"A list of\n[Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set."},"signHereTabs":{"type":"array","items":{"$ref":"#/components/schemas/signHere"},"description":"A list of\n[Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set."},"smartSectionTabs":{"type":"array","items":{"$ref":"#/components/schemas/smartSection"},"description":"A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."},"ssnTabs":{"type":"array","items":{"$ref":"#/components/schemas/ssn"},"description":"A list of\n[SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set."},"tabGroups":{"type":"array","items":{"$ref":"#/components/schemas/tabGroup"},"description":"An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array."},"textTabs":{"type":"array","items":{"$ref":"#/components/schemas/text"},"description":"A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/)."},"titleTabs":{"type":"array","items":{"$ref":"#/components/schemas/title"},"description":"A list of\n[Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Title tab displays the recipient's title. This value can't be set."},"viewTabs":{"type":"array","items":{"$ref":"#/components/schemas/view"},"description":"A list of\n[View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA View tab is used with an Approve tab to handle supplemental documents. This value can be set."},"zipTabs":{"type":"array","items":{"$ref":"#/components/schemas/zip"},"description":"A list of\n[Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set."}},"title":"templateTabs"},"templateDocumentVisibilityList":{"type":"object","properties":{"documentVisibility":{"type":"array","items":{"$ref":"#/components/schemas/documentVisibility"},"description":"An array of `documentVisibility` objects that specifies which documents are visible to which recipients."}},"description":"A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.","title":"templateDocumentVisibilityList"},"templateRecipients":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/agent"},"description":"A list of agent recipients assigned to the documents."},"authorizedSignatories":{"type":"array","items":{"$ref":"#/components/schemas/authorizedSignatory"}},"carbonCopies":{"type":"array","items":{"$ref":"#/components/schemas/carbonCopy"},"description":"A list of carbon copy recipients assigned to the documents."},"certifiedDeliveries":{"type":"array","items":{"$ref":"#/components/schemas/certifiedDelivery"},"description":"A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."},"currentRoutingOrder":{"type":"string","description":"The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."},"editors":{"type":"array","items":{"$ref":"#/components/schemas/editor"},"description":"A list of users who can edit the envelope."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"inPersonSigners":{"type":"array","items":{"$ref":"#/components/schemas/inPersonSigner"},"description":"Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."},"intermediaries":{"type":"array","items":{"$ref":"#/components/schemas/intermediary"},"description":"Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."},"notaries":{"type":"array","items":{"$ref":"#/components/schemas/notaryRecipient"},"description":"A list of notary recipients on the envelope."},"notaryWitnesses":{"type":"array","items":{"$ref":"#/components/schemas/notaryWitness"}},"participants":{"type":"array","items":{"$ref":"#/components/schemas/participant"}},"recipientCount":{"type":"string","description":"The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n- recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n- includeDocuments - When **true,** the envelope time zone information is included in the message."},"seals":{"type":"array","items":{"$ref":"#/components/schemas/sealSign"},"description":"Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see [https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)"},"signers":{"type":"array","items":{"$ref":"#/components/schemas/signer"},"description":"A list of signers on the envelope."},"witnesses":{"type":"array","items":{"$ref":"#/components/schemas/witness"},"description":"A list of signers who act as witnesses on the envelope."}},"title":"templateRecipients"},"envelopeTemplate":{"type":"object","properties":{"accessControlListBase64":{"type":"string","description":"Reserved for Docusign."},"allowComments":{"type":"string","description":"When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document."},"allowMarkup":{"type":"string","description":"When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level."},"allowReassign":{"type":"string","description":"When **true,** the recipient can redirect an envelope to a more appropriate recipient."},"allowViewHistory":{"type":"string","description":"When **true,** recipients can view the history of the envelope."},"anySigner":{"type":"string","description":"Deprecated. This feature has been replaced by signing groups."},"asynchronous":{"type":"string","description":"When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the\nConnect notification."},"attachmentsUri":{"type":"string","description":"Contains a URL for retrieving the attachments that are associated with the envelope."},"authoritativeCopy":{"type":"string","description":"When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"},"authoritativeCopyDefault":{"type":"string","description":"The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."},"autoMatch":{"type":"string","description":"By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching."},"autoMatchSpecifiedByUser":{"type":"string","description":"When **true,** the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property."},"autoNavigation":{"type":"string","description":"When **true,** autonavigation is set for the recipient."},"brandId":{"type":"string","description":"The ID of the brand. This property is returned in the `Templates:get` response. It is not returned in the `Templates:list` response."},"brandLock":{"type":"string","description":"When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."},"burnDefaultTabData":{"type":"string"},"certificateUri":{"type":"string","description":"The URI for retrieving certificate information."},"completedDateTime":{"type":"string","description":"Specifies the date and time this item was completed."},"copyRecipientData":{"type":"string"},"created":{"type":"string","description":"The UTC DateTime when the workspace user authorization was created."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"customFields":{"$ref":"#/components/schemas/customFields"},"customFieldsUri":{"type":"string","description":"The URI for retrieving custom fields."},"declinedDateTime":{"type":"string","description":"The date and time the recipient declined the document. This property is read-only."},"deletedDateTime":{"type":"string","description":"Reserved for Docusign."},"deliveredDateTime":{"type":"string","description":"The date and time that the envelope was delivered to the recipient. This property is read-only."},"description":{"type":"string","description":"A sender-defined description of the line item."},"disableResponsiveDocument":{"type":"string","description":"When **true,** responsive documents are disabled for the envelope."},"documentBase64":{"type":"string","description":"The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"},"description":"A complex element that contains details about the documents associated with the envelope."},"documentsCombinedUri":{"type":"string","description":"The URI for retrieving all of the documents associated with the envelope as a single PDF file."},"documentsUri":{"type":"string","description":"The URI for retrieving all of the documents associated with the envelope as separate files."},"emailBlurb":{"type":"string","description":"This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients."},"emailSettings":{"$ref":"#/components/schemas/emailSettings"},"emailSubject":{"type":"string","description":"The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."},"enableWetSign":{"type":"string","description":"When **true,** the signer is allowed to print the document and sign it on paper."},"enforceSignerVisibility":{"type":"string","description":"When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings](https://admindemo.docusign.com/authenticate?goTo=sending) will be enforced for the envelope. See [Fields and Properties](https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html) for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting.\n\n**Note:** To use this functionality, [document visibility](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/) must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/en/contactSupport#) or your account manager to find out whether document visibility is available for your production account plan."},"envelopeAttachments":{"type":"array","items":{"$ref":"#/components/schemas/attachment"},"description":"An array of attachment objects that provide information about the attachments that are associated with the envelope."},"envelopeClassification":{"type":"string"},"envelopeCustomMetadata":{"$ref":"#/components/schemas/envelopeCustomMetadata"},"envelopeDocuments":{"type":"array","items":{"$ref":"#/components/schemas/envelopeDocument"},"description":"An array containing information about the documents that are included in the envelope."},"envelopeId":{"type":"string","description":"The envelope ID of an envelope that you want to use as\nthe basis for the template. The state of the envelope\ncan be `draft`, `sent`, or `completed`."},"envelopeIdStamping":{"type":"string","description":"When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."},"envelopeLocation":{"type":"string","description":"Reserved for Docusign."},"envelopeMetadata":{"$ref":"#/components/schemas/envelopeMetadata"},"envelopeUri":{"type":"string","description":"The URI for retrieving the envelope or envelopes."},"expireAfter":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"expireDateTime":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"expireEnabled":{"type":"string","description":"Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."},"externalEnvelopeId":{"type":"string","description":"May contain an external identifier for the envelope."},"favoritedByMe":{"type":"string"},"folderId":{"type":"string","description":"The ID of the folder."},"folderIds":{"type":"array","items":{"type":"string"},"description":"Read-Only. An array of `folderIds` representing folders where the template exists, either directly for this user, or through the template sharing feature."},"folderName":{"type":"string"},"folders":{"type":"array","items":{"$ref":"#/components/schemas/folder"},"description":"A list of folder objects."},"hasAuthorizedSignatoryRecipient":{"type":"string"},"hasComments":{"type":"string","description":"When **true,** indicates that users have added comments to the envelope."},"hasFormDataChanged":{"type":"string","description":"When **true,** indicates that the data collected through form fields on a document has changed."},"hasWavFile":{"type":"string","description":"When **true,** indicates that a .wav file used for voice authentication is included in the envelope."},"holder":{"type":"string","description":"Reserved for Docusign."},"initialSentDateTime":{"type":"string","description":"The date and time the envelope was initially sent."},"is21CFRPart11":{"type":"string","description":"When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."},"isAceGenTemplate":{"type":"string"},"isDocGenTemplate":{"type":"string"},"isDynamicEnvelope":{"type":"string","description":"When **true,** indicates that the envelope is a dynamic envelope."},"isSignatureProviderEnvelope":{"type":"string","description":"When **true,** indicates that the envelope is a signature-provided envelope."},"isTicketRelatedEnvelope":{"type":"string"},"lastModified":{"type":"string","description":"The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator."},"lastModifiedBy":{"$ref":"#/components/schemas/userInfo"},"lastModifiedDateTime":{"type":"string","description":"The date and time that the item was last modified."},"lastUsed":{"type":"string"},"location":{"type":"string","description":"Reserved for Docusign."},"lockInformation":{"$ref":"#/components/schemas/lockInformation"},"messageLock":{"type":"string","description":"When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.\n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.\n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."},"name":{"type":"string"},"newPassword":{"type":"string","description":"The user's new password."},"notification":{"$ref":"#/components/schemas/notification"},"notificationUri":{"type":"string","description":"The URI for retrieving notifications."},"owner":{"$ref":"#/components/schemas/userInfo"},"pageCount":{"type":"string","description":"An integer value specifying the number of document pages in the template."},"password":{"type":"string","description":"The password used to lock this eSignature template (provided in clear text).\n[Template passwords](https://support.docusign.com/s/document-item?language=en_US&bundleId=xry1643227563338&topicId=xwo1578456395432.html&_LANG=enus) protect against editing, sharing, copying, or downloading a template. You can set a password on any template you create."},"passwordProtected":{"type":"string"},"powerForm":{"$ref":"#/components/schemas/powerForm"},"powerForms":{"type":"array","items":{"$ref":"#/components/schemas/powerForm"},"description":"An array of PowerForm objects."},"purgeCompletedDate":{"type":"string","description":"The date that a purge was completed."},"purgeRequestDate":{"type":"string","description":"The date that a purge was requested."},"purgeState":{"type":"string","description":"Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)"},"recipients":{"$ref":"#/components/schemas/recipients"},"recipientsLock":{"type":"string","description":"When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."},"recipientsUri":{"type":"string","description":"Contains a URI for an endpoint that you can use to retrieve the recipients."},"sender":{"$ref":"#/components/schemas/userInfo"},"sentDateTime":{"type":"string","description":"The UTC DateTime when the envelope was sent. This property is read-only."},"shared":{"type":"string","description":"When **true,** indicates the template is shared with the **Everyone** group,\nwhich includes all users on the account.\n\nWhen **false,** the template is shared only with the groups you specify."},"signerCanSignOnMobile":{"type":"string","description":"When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting."},"signingLocation":{"type":"string","description":"Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online."},"status":{"type":"string","description":"Indicates the envelope status. Valid values are:\n\n- `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n- `created`: The envelope is created as a draft. It can be modified and sent later.\n- `declined`: The envelope has been declined by the recipients.\n- `delivered`: The envelope has been delivered to the recipients.\n- `sent`: The envelope will be sent to the recipients after the envelope is created.\n- `signed`: The envelope has been signed by the recipients.\n- `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope."},"statusChangedDateTime":{"type":"string","description":"The data and time that the status changed."},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "},"templatesUri":{"type":"string","description":"The URI for retrieving the templates."},"transactionId":{"type":"string","description":" Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."},"uri":{"type":"string","description":"A URI containing the user ID."},"useDisclosure":{"type":"string","description":"When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients.\n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."},"uSigState":{"type":"string"},"voidedDateTime":{"type":"string","description":"The date and time the envelope or template was voided."},"voidedReason":{"type":"string","description":"The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters."},"watermarkLanguage":{"type":"string"},"workflow":{"$ref":"#/components/schemas/workflow"}},"title":"envelopeTemplate"},"Templates_Pages_DeleteTemplatePage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Templates_Pages_DeleteTemplatePage_Response_200"},"groupInformation":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."}},"description":"This object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/).","title":"groupInformation"},"envelopeTemplateResults":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"envelopeTemplates":{"type":"array","items":{"$ref":"#/components/schemas/envelopeTemplate"},"description":"The list of requested templates."},"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."},"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."},"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`."}},"description":"Information about templates.","title":"envelopeTemplateResults"},"Templates_Pages_PutTemplatePageImage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Templates_Pages_PutTemplatePageImage_Response_200"},"templateUpdateSummary":{"type":"object","properties":{"bulkEnvelopeStatus":{"$ref":"#/components/schemas/bulkEnvelopeStatus"},"envelopeId":{"type":"string","description":"The envelope ID of the envelope status that failed to post."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"listCustomFieldUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/listCustomField"}},"lockInformation":{"$ref":"#/components/schemas/lockInformation"},"purgeState":{"type":"string","description":"Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)"},"recipientUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/recipientUpdateResponse"},"description":"An array of `recipientUpdateResults` objects that contain details about the recipients."},"tabUpdateResults":{"$ref":"#/components/schemas/tabs"},"textCustomFieldUpdateResults":{"type":"array","items":{"$ref":"#/components/schemas/textCustomField"}}},"title":"templateUpdateSummary"},"templateNotificationRequest":{"type":"object","properties":{"expirations":{"$ref":"#/components/schemas/expirations"},"password":{"type":"string","description":"The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests."},"reminders":{"$ref":"#/components/schemas/reminders"},"useAccountDefaults":{"type":"string","description":"When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"}},"title":"templateNotificationRequest"},"templateAutoMatch":{"type":"object","properties":{"autoMatch":{"type":"string","description":"\"true\" or \"false\" string values only."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"templateId":{"type":"string","description":"The unique identifier of the template. If this is not provided, DocuSign will generate a value. "}},"title":"templateAutoMatch"},"templateAutoMatchList":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/templateAutoMatch"}}},"title":"templateAutoMatchList"},"templateViewRecipientSettings":{"type":"object","properties":{"showContactsList":{"type":"string"},"showEditMessage":{"type":"string"},"showEditRecipients":{"type":"string"}},"title":"templateViewRecipientSettings"},"templateViewSettings":{"type":"object","properties":{"backButtonAction":{"type":"string"},"documentSettings":{"$ref":"#/components/schemas/envelopeViewDocumentSettings"},"envelopeCustomFieldSettings":{"$ref":"#/components/schemas/envelopeViewEnvelopeCustomFieldSettings"},"lockToken":{"type":"string"},"recipientSettings":{"$ref":"#/components/schemas/templateViewRecipientSettings"},"showAdvancedOptions":{"type":"string"},"showBackButton":{"type":"string"},"showDiscardAction":{"type":"string"},"showHeaderActions":{"type":"string"},"startingScreen":{"type":"string"},"taggerSettings":{"$ref":"#/components/schemas/envelopeViewTaggerSettings"}},"title":"templateViewSettings"},"templateViewRequest":{"type":"object","properties":{"returnUrl":{"type":"string","description":"Identifies the return point after the user selects `Save And Close`. This property is required."},"settings":{"$ref":"#/components/schemas/templateViewSettings"},"viewAccess":{"type":"string","description":"Set to `template` to limit the app user's access to only the specified template. **Required.**"}},"title":"templateViewRequest"},"GroupBrands":{"type":"object","properties":{"recipientBrandIdDefault":{"type":"string","description":"The brand that envelope recipients see when a brand is not explicitly set."},"senderBrandIdDefault":{"type":"string","description":"The brand that envelope senders see when a brand is not explicitly set."},"brandOptions":{"type":"array","items":{"$ref":"#/components/schemas/brand"},"description":"A list of brands."}},"description":"If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.","title":"GroupBrands"},"userInfoList":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/userInfo"},"description":"An array of `userInfo` objects containing information about the users in the group."}},"title":"userInfoList"},"usersResponse":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."},"users":{"type":"array","items":{"$ref":"#/components/schemas/userInfo"},"description":"User management information."}},"title":"usersResponse"},"groupUserInfo":{"type":"object","properties":{"activationAccessCode":{"type":"string"},"email":{"type":"string"},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"loginStatus":{"type":"string"},"sendActivationEmail":{"type":"string"},"uri":{"type":"string"},"userId":{"type":"string"},"userName":{"type":"string"},"userStatus":{"type":"string"},"userType":{"type":"string"}},"title":"groupUserInfo"},"groupUsersResponse":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last position in the result set. "},"nextUri":{"type":"string","description":"The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. "},"previousUri":{"type":"string","description":"The postal code for the billing address."},"resultSetSize":{"type":"string","description":"The number of results returned in this response. "},"startPosition":{"type":"string","description":"Starting position of the current result set."},"totalSetSize":{"type":"string","description":"The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response."},"users":{"type":"array","items":{"$ref":"#/components/schemas/groupUserInfo"}}},"title":"groupUsersResponse"},"contactPhoneNumber":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The contact's phone number.\n\nExample: `+12223334444`"},"phoneType":{"type":"string","description":"The type of phone number. Valid values are:\n\n- `home`\n- `mobile`\n- `work`\n- `other`\n- `fax`"}},"description":"Details about the phone numbers associated with a specific contact.","title":"contactPhoneNumber"},"jurisdictionSummary":{"type":"object","properties":{"authorizedForIPen":{"type":"string"},"authorizedForRon":{"type":"string"},"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`"},"jurisdictionName":{"type":"string"}},"title":"jurisdictionSummary"},"notaryContactDetails":{"type":"object","properties":{"hasDocusignCertificate":{"type":"string"},"jurisdictions":{"type":"array","items":{"$ref":"#/components/schemas/jurisdictionSummary"}}},"title":"notaryContactDetails"},"contact":{"type":"object","properties":{"canManage":{"type":"string","description":"Boolean value is set to true when either of the following conditions is met:\n\n- The user making the API call is the owner of the contact.\n\n- The user making the API call is an account administrator, and the contact is a shared contact."},"cloudProvider":{"type":"string","description":"The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)"},"cloudProviderContainerId":{"type":"string","description":"The ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room."},"contactId":{"type":"string","description":"The ID of a contact person in the account's address book."},"contactPhoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/contactPhoneNumber"},"description":"A list of the contact's phone numbers.\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box."},"contactUri":{"type":"string","description":"The URI for retrieving information about the contact."},"emails":{"type":"array","items":{"type":"string"},"description":"An array of email addresses."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"isOwner":{"type":"boolean"},"name":{"type":"string","description":"The name of the contact."},"notaryContactDetails":{"$ref":"#/components/schemas/notaryContactDetails"},"organization":{"type":"string"},"roomContactType":{"type":"string"},"shared":{"type":"string","description":"When **true,** this contact is shared."},"signingGroup":{"type":"string","description":"The ID of the signing group."},"signingGroupName":{"type":"string","description":"Optional. The name of the signing group.\n\nMaximum Length: 100 characters."}},"title":"contact"},"contactModRequest":{"type":"object","properties":{"contactList":{"type":"array","items":{"$ref":"#/components/schemas/contact"},"description":"A list of contacts."}},"description":"The request object containing the new information for the contacts.","title":"contactModRequest"},"contactUpdateResponse":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/contact"},"description":"A list of contacts."}},"description":"This response objects shows the updated details for the contacts.","title":"contactUpdateResponse"},"contactGetResponse":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/contact"},"description":"A list of contacts."},"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."}},"description":"This response object contains information about the contacts associated with an account.","title":"contactGetResponse"},"customSettingsInformation":{"type":"object","properties":{"customSettings":{"type":"array","items":{"$ref":"#/components/schemas/nameValue"},"description":"The name/value pair information for the user custom setting."}},"title":"customSettingsInformation"},"authenticationMethod":{"type":"object","properties":{"authenticationType":{"type":"string","description":"Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. "},"lastProvider":{"type":"string","description":"The last provider that authenticated the user. "},"lastTimestamp":{"type":"string","description":" The data and time the user last used the authentication method. "},"totalCount":{"type":"string","description":"The number of times the authentication method was used. "}},"description":"Contains information about the method used for authentication.","title":"authenticationMethod"},"usageHistory":{"type":"object","properties":{"lastSentDateTime":{"type":"string","description":"The date and time the user last sent an envelope. "},"lastSignedDateTime":{"type":"string","description":"The date and time the user last signed an envelope."},"sentCount":{"type":"string","description":"The number of envelopes the user has sent. "},"signedCount":{"type":"string","description":"The number of envelopes the user has signed. "}},"description":"A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed.","title":"usageHistory"},"userProfile":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/addressInformation"},"authenticationMethods":{"type":"array","items":{"$ref":"#/components/schemas/authenticationMethod"},"description":"Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation."},"companyName":{"type":"string","description":"The name of the user's Company."},"displayOrganizationInfo":{"type":"string","description":"When **true,** the user's company and title information display on the ID card."},"displayPersonalInfo":{"type":"string","description":"When **true,** the user's address and phone number display on the ID card."},"displayProfile":{"type":"string","description":"When **true,** the user's ID card can be viewed from signed documents and envelope history."},"displayUsageHistory":{"type":"string","description":"When **true,** the user's usage information displays on the ID card."},"profileImageUri":{"type":"string","description":"The URL for retrieving the user's profile image."},"title":{"type":"string","description":"The title of the user."},"usageHistory":{"$ref":"#/components/schemas/usageHistory"},"userDetails":{"$ref":"#/components/schemas/userInformation"},"userProfileLastModifiedDate":{"type":"string","description":"The date and time that the user's profile was last modified."}},"title":"userProfile"},"Users_UserProfile_PutProfile_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Users_UserProfile_PutProfile_Response_200"},"newUsersDefinition":{"type":"object","properties":{"newUsers":{"type":"array","items":{"$ref":"#/components/schemas/userInformation"},"description":"A list of one or more new users."}},"title":"newUsersDefinition"},"newUser":{"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."},"createdDateTime":{"type":"string","description":"The UTC DateTime when the item was created."},"email":{"type":"string","description":"The user's email address."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"licenseStatus":{"type":"string"},"licenseType":{"type":"string"},"membershipId":{"type":"string","description":"The user's membership ID."},"permissionProfileId":{"type":"string","description":"The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page."},"permissionProfileName":{"type":"string","description":"The name of the account permission profile.\n\nExample: `Account Administrator`"},"uri":{"type":"string","description":"A URI containing the user ID."},"userId":{"type":"string","description":"Specifies the user ID for the new user."},"userName":{"type":"string","description":"The name of the user."},"userStatus":{"type":"string","description":"Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`"}},"description":"Object representing a new user.","title":"newUser"},"newUsersSummary":{"type":"object","properties":{"newUsers":{"type":"array","items":{"$ref":"#/components/schemas/newUser"},"description":"A list of one or more new users."}},"description":"Object representing a summary of data for new users.","title":"newUsersSummary"},"Users_UserProfileImage_DeleteUserProfileImage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Users_UserProfileImage_DeleteUserProfileImage_Response_200"},"userInformationList":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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."},"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`."},"users":{"type":"array","items":{"$ref":"#/components/schemas/userInformation"},"description":"User management information."}},"description":"Contains a list of account users.","title":"userInformationList"},"Users_UserProfileImage_PutUserProfileImage_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Users_UserProfileImage_PutUserProfileImage_Response_200"},"Users_UserSettings_PutUserSettings_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Users_UserSettings_PutUserSettings_Response_200"},"userSignaturesInformation":{"type":"object","properties":{"userSignatures":{"type":"array","items":{"$ref":"#/components/schemas/userSignature"},"description":"An array of `userSignature` objects."}},"title":"userSignaturesInformation"},"Users_UserSignatures_DeleteUserSignature_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Users_UserSignatures_DeleteUserSignature_Response_200"},"userSignatureDefinition":{"type":"object","properties":{"dateStampProperties":{"$ref":"#/components/schemas/dateStampProperties"},"disallowUserResizeStamp":{"type":"string","description":"When **true,** users may not resize the stamp."},"externalID":{"type":"string","description":"Optionally specify an external identifier for the user's signature."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"},"isDefault":{"type":"string","description":"Boolean that specifies whether the signature is the default signature for the user."},"nrdsId":{"type":"string","description":"The National Association of Realtors (NAR) membership ID for a user who is a realtor."},"nrdsLastName":{"type":"string","description":"The realtor's last name."},"phoneticName":{"type":"string","description":"The phonetic spelling of the `signatureName`."},"signatureFont":{"type":"string","description":"The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`"},"signatureId":{"type":"string","description":"Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."},"signatureInitials":{"type":"string","description":"Specifies the user's signature in initials format."},"signatureName":{"type":"string","description":"Specifies the user's signature name."},"signatureType":{"type":"string","description":"Specifies the type of signature."},"stampFormat":{"type":"string","description":"The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date."},"stampSizeMM":{"type":"string","description":"The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."}},"title":"userSignatureDefinition"},"workspaceUser":{"type":"object","properties":{"accountId":{"type":"string","description":"The account ID associated with the workspace user."},"accountName":{"type":"string","description":"The name of the account that the workspace user belongs to."},"activeSince":{"type":"string","description":"The UTC DateTime when the user joined the workspace."},"created":{"type":"string","description":"The UTC DateTime when the workspace user was created."},"createdById":{"type":"string","description":"The ID of the user who created this workspace user."},"email":{"type":"string","description":"The workspace user's email address."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"invitationEmailBlurb":{"type":"string","description":"The text of the workspace invitation email message sent to the user."},"invitationEmailSubject":{"type":"string","description":"The subject line of the workspace invitation email message sent to the user."},"lastModified":{"type":"string","description":"The UTC DateTime that the workspace user was last modified."},"lastModifiedById":{"type":"string","description":"The ID of the user who last modified the workspace user."},"status":{"type":"string","description":"Filters the results by user status.\nYou can specify a comma-separated\nlist of the following statuses:\n\n- ActivationRequired\n- ActivationSent\n- Active\n- Closed\n- Disabled"},"type":{"type":"string","description":"Type of the user. Valid values: type_owner, type_participant."},"userId":{"type":"string","description":"The ID of the workspace user."},"userName":{"type":"string","description":"The name of workspace user."},"workspaceId":{"type":"string","description":"The ID of the workspace."},"workspaceUserBaseUrl":{"type":"string","description":"The URL for accessing the workspace user."},"workspaceUserId":{"type":"string","description":"The ID of the workspace user."},"workspaceUserUri":{"type":"string","description":"The URI for accessing the workspace user."}},"description":"This object represents the workspace user. This property is only returned in response to user specific GET call.","title":"workspaceUser"},"workspaceUserAuthorization":{"type":"object","properties":{"canDelete":{"type":"string","description":"When **true,** the workspace user can delete items from the workspace."},"canMove":{"type":"string","description":"When **true,** the workspace user can move the items in the workspace."},"canTransact":{"type":"string","description":"When **true,** the workspace user can create transactions from the workspace."},"canView":{"type":"string","description":"When **true,** the workspace user can view the items in the workspace."},"created":{"type":"string","description":"The UTC DateTime when the workspace user authorization was created."},"createdById":{"type":"string","description":"The ID of the user who created the workspace user authorization."},"errorDetails":{"$ref":"#/components/schemas/errorDetails"},"modified":{"type":"string","description":"The UTC DateTime when the workspace user authorization was last modified."},"modifiedById":{"type":"string","description":"The ID of the user who last modified the workspace user authorization."},"workspaceUserId":{"type":"string","description":"The ID of the workspace user."},"workspaceUserInformation":{"$ref":"#/components/schemas/workspaceUser"}},"description":"Provides properties that describe user authorization to a workspace.","title":"workspaceUserAuthorization"},"workspaceItem":{"type":"object","properties":{"callerAuthorization":{"$ref":"#/components/schemas/workspaceUserAuthorization"},"contentType":{"type":"string","description":"If the item is a file, this property specifies the content type of the file."},"created":{"type":"string","description":"The UTC DateTime when the workspace item was created."},"createdById":{"type":"string","description":"The ID of the user who created the workspace item."},"createdByInformation":{"$ref":"#/components/schemas/workspaceUser"},"extension":{"type":"string","description":"The file extension of a file item."},"fileSize":{"type":"string","description":"The size of the file in bytes."},"fileUri":{"type":"string","description":"The URI for retrieving the file."},"id":{"type":"string","description":"A unique ID for the Salesforce object."},"isPublic":{"type":"string","description":"When **true,** the item is public."},"lastModified":{"type":"string","description":"The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator."},"lastModifiedById":{"type":"string","description":"The ID of the user who last modified the item."},"lastModifiedByInformation":{"$ref":"#/components/schemas/workspaceUser"},"name":{"type":"string","description":"The name of the file or folder."},"pageCount":{"type":"string","description":"The number of pages in a file."},"parentFolderId":{"type":"string","description":"The ID of the parent folder, or the special value `root` for the root folder."},"parentFolderUri":{"type":"string","description":"The URI of the parent folder."},"sha256":{"type":"string","description":"A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. Docusign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused."},"thumbHeight":{"type":"string","description":"The height of the thumbnail image."},"thumbnail":{"$ref":"#/components/schemas/page"},"thumbWidth":{"type":"string","description":"The width of the thumbnail image."},"type":{"type":"string","description":"The type of the workspace item. Valid values are file, folder."},"uri":{"type":"string","description":"A URI containing the user ID."},"userAuthorization":{"$ref":"#/components/schemas/workspaceUserAuthorization"}},"description":"This object represents an item in a workspace, which can be either a file or folder.","title":"workspaceItem"},"workspaceItemList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/workspaceItem"},"description":"A list of workspace items."}},"description":"An array of objects that describe the items in a workspace.","title":"workspaceItemList"},"Workspaces_WorkspaceFolder_DeleteWorkspaceItems_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Workspaces_WorkspaceFolder_DeleteWorkspaceItems_Response_200"},"Workspaces_WorkspaceFile_GetWorkspaceFile_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Workspaces_WorkspaceFile_GetWorkspaceFile_Response_200"},"workspaceFolderContents":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"folder":{"$ref":"#/components/schemas/workspaceItem"},"items":{"type":"array","items":{"$ref":"#/components/schemas/workspaceItem"},"description":"A list of workspace items."},"parentFolders":{"type":"array","items":{"$ref":"#/components/schemas/workspaceItem"}},"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."},"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`."},"workspaceId":{"type":"string","description":"The id of the workspace, always populated."}},"description":"This object's properties describe the contents of a workspace folder.","title":"workspaceFolderContents"},"workspaceSettings":{"type":"object","properties":{"commentsAllowed":{"type":"string","description":"When **true,** commenting on the documents in the workspace is allowed."}},"description":"This object provides information about the settings for the workspace.","title":"workspaceSettings"},"workspace":{"type":"object","properties":{"billableAccountId":{"type":"string","description":"The ID of the account to bill."},"callerInformation":{"$ref":"#/components/schemas/workspaceUser"},"created":{"type":"string","description":"The UTC DateTime when the workspace user authorization was created."},"createdByInformation":{"$ref":"#/components/schemas/workspaceUser"},"lastModified":{"type":"string","description":"Utc date and time the comment was last updated (can only be done by creator.)"},"lastModifiedByInformation":{"$ref":"#/components/schemas/workspaceUser"},"settings":{"$ref":"#/components/schemas/workspaceSettings"},"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."},"workspaceBaseUrl":{"type":"string","description":"The relative URL for accessing the workspace."},"workspaceDescription":{"type":"string","description":"Text describing the purpose of the workspace."},"workspaceId":{"type":"string","description":"The id of the workspace, always populated."},"workspaceName":{"type":"string","description":"The name of the workspace."},"workspaceUri":{"type":"string","description":"The relative URI for accessing the workspace."}},"description":"A Docusign workspace is a collaboration area for sharing files and data.","title":"workspace"},"workspaceList":{"type":"object","properties":{"endPosition":{"type":"string","description":"The last index position in the result set."},"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."},"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`."},"workspaces":{"type":"array","items":{"$ref":"#/components/schemas/workspace"},"description":"A list of workspaces."}},"description":"This object contains a list of available workspaces.","title":"workspaceList"}},"securitySchemes":{"bearerAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"OAuth 2.0 access token (JWT or auth-code grant). Sent as\n`Authorization: Bearer <token>` on every request except\n`GET /v2.1` and `GET /service_information`, which are\npublic discovery endpoints.\n"}}}}