connectLogs
{
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectLog"
},
"description": "A list of Connect general logs."
},
"type": {
"type": "string",
"description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectLog"
},
"description": "An array of containing failure information from the Connect failure log."
},
"totalRecords": {
"type": "string",
"description": "The count of records in the log list."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "connectLogs"
}
connectOAuthConfig
{
"type": "object",
"properties": {
"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`"
},
"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": "string",
"description": "",
"additionalProperties": {
"type": "string"
}
},
"authorizationServerUrl": {
"type": "string",
"description": "The token URL for your authorization server or OAuth service.\n\nThis property is required."
}
},
"description": "A complex object describing a Connect OAuth configuration.",
"x-ms-summary": "A complex object describing a Connect OAuth configuration.",
"x-ds-definition-name": "connectOAuthConfig"
}
connectSalesforceField
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Salesforce object."
},
"dsLink": {
"type": "string",
"description": "A URL that links to the information in the DocuSign field."
},
"dsNode": {
"type": "string",
"description": ""
},
"sfField": {
"type": "string",
"description": ""
},
"sfFolder": {
"type": "string",
"description": "The name of the Salesforce folder."
},
"dsAttribute": {
"type": "string",
"description": ""
},
"sfFieldName": {
"type": "string",
"description": "The name of the Salesforce field."
},
"sfLockedValue": {
"type": "string",
"description": ""
}
},
"description": "This object is used to match a DocuSign field to a Salesforce field so that DocuSign can send information to your Salesforce account.",
"x-ms-summary": "This object is used to match a DocuSign field to a Salesforce field so that DocuSign can send information to your Salesforce account.",
"x-ds-definition-name": "connectSalesforceField"
}
connectSalesforceObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the `connectSalesforceObject`."
},
"active": {
"type": "string",
"description": "When **true,** the `connectSalesforceObject` is active."
},
"insert": {
"type": "string",
"description": ""
},
"sfObject": {
"type": "string",
"description": "The Salesforce.com object type, such as `case`, `contact`, or `opportunity`."
},
"description": {
"type": "string",
"description": "A description of the `connectSalesforceObject`."
},
"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."
},
"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."
},
"onCompleteOnly": {
"type": "string",
"description": "When **true,** Salesforce is updated only when the envelope is complete."
}
},
"description": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).",
"x-ms-summary": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).",
"x-ds-definition-name": "connectSalesforceObject"
}
connectUserInfo
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": ""
},
"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."
},
"isIncluded": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "connectUserInfo"
}
connectUserObject
{
"type": "object",
"properties": {
"enabled": {
"type": "string",
"description": "Boolean value that indicates whether the custom Connect configuration is enabled or not."
},
"connectId": {
"type": "string",
"description": "The ID of the custom Connect configuration being accessed."
},
"hasAccess": {
"type": "string",
"description": ""
},
"configurationtype": {
"type": "string",
"description": "The type of custom Connect configuration being accessed."
},
"senderSearchableItems": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "connectUserObject"
}
consentDetails
{
"type": "object",
"properties": {
"consentKey": {
"type": "string",
"description": ""
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signerConsentStatus": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "consentDetails"
}
consoleViewRequest
{
"type": "object",
"properties": {
"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."
},
"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."
}
},
"description": "The request object for the [EnvelopeViews: createConsole](https://raw.githubusercontent.com) method.",
"x-ms-summary": "The request object for the [EnvelopeViews: createConsole](https://raw.githubusercontent.com) method.",
"x-ds-definition-name": "consoleViewRequest"
}
consumerDisclosure
{
"type": "object",
"properties": {
"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. "
},
"custom": {
"type": "string",
"description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"
},
"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. "
},
"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."
},
"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."
},
"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.**"
},
"enableEsign": {
"type": "string",
"description": "When **true** (default), indicates that eSign is enabled."
},
"companyPhone": {
"type": "string",
"description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string."
},
"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`."
},
"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. "
},
"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. "
},
"withdrawState": {
"type": "string",
"description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"
},
"accountEsignId": {
"type": "string",
"description": "The GUID of the account associated with the consumer disclosure."
},
"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."
},
"withdrawByMail": {
"type": "string",
"description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"
},
"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.**\n**Note:** Only Admin users can change this setting."
},
"copyCostPerPage": {
"type": "string",
"description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
},
"withdrawByEmail": {
"type": "string",
"description": "When **true** (default), indicates that the customer can withdraw consent by email."
},
"withdrawByPhone": {
"type": "string",
"description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"
},
"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.`"
},
"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."
},
"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."
},
"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. "
},
"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. "
},
"withdrawConsequences": {
"type": "string",
"description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."
},
"allowCDWithdrawMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"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.`"
},
"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"
}
},
"description": "Details about consumer disclosures.",
"x-ms-summary": "Details about consumer disclosures.",
"x-ds-definition-name": "consumerDisclosure"
}
contact
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the contact."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of email addresses."
},
"shared": {
"type": "string",
"description": "When **true,** this contact is shared."
},
"isOwner": {
"type": "boolean",
"description": ""
},
"contactId": {
"type": "string",
"description": "The ID of a contact person in the account's address book."
},
"contactUri": {
"type": "string",
"description": "The URI for retrieving information about the contact."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"organization": {
"type": "string",
"description": ""
},
"signingGroup": {
"type": "string",
"description": "The ID of the signing group."
},
"cloudProvider": {
"type": "string",
"description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n<!-- Future:\n\n- `Box`\n- `GoogleDrive`\n- `Dropbox`\n- `SalesForce`\n- `SkyDrive`\n\n-->"
},
"roomContactType": {
"type": "string",
"description": ""
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"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."
},
"notaryContactDetails": {
"$ref": "#/components/schemas/notaryContactDetails"
},
"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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "contact"
}
contactGetResponse
{
"type": "object",
"properties": {
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"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. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "This response object contains information about the contacts associated with an account.",
"x-ms-summary": "This response object contains information about the contacts associated with an account.",
"x-ds-definition-name": "contactGetResponse"
}
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.",
"x-ms-summary": "The request object containing the new information for the contacts.",
"x-ds-definition-name": "contactModRequest"
}
contactPhoneNumber
{
"type": "object",
"properties": {
"phoneType": {
"type": "string",
"description": "The type of phone number. Valid values are:\n\n- `home`\n- `mobile`\n- `work`\n- `other`\n- `fax`"
},
"phoneNumber": {
"type": "string",
"description": "The contact's phone number.\n\nExample: `+12223334444`"
}
},
"description": "Details about the phone numbers associated with a specific contact.",
"x-ms-summary": "Details about the phone numbers associated with a specific contact.",
"x-ds-definition-name": "contactPhoneNumber"
}
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.",
"x-ms-summary": "This response objects shows the updated details for the contacts.",
"x-ds-definition-name": "contactUpdateResponse"
}
correctViewRequest
{
"type": "object",
"properties": {
"viewUrl": {
"type": "string",
"description": ""
},
"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.\n"
},
"beginOnTagger": {
"type": "string",
"description": ""
},
"suppressNavigation": {
"type": "string",
"description": "Specifies whether the window is displayed with or without dressing."
}
},
"description": "The request body for the [EnvelopeViews: createCorrect](https://raw.githubusercontent.com) method.",
"x-ms-summary": "The request body for the [EnvelopeViews: createCorrect](https://raw.githubusercontent.com) method.",
"x-ds-definition-name": "correctViewRequest"
}
country
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"isoCode": {
"type": "string",
"description": ""
},
"provinces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/province"
},
"description": ""
},
"provinceValidated": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "country"
}
creditCardInformation
{
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/addressInformation"
},
"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)."
},
"cardNumber": {
"type": "string",
"description": "The credit card number."
},
"nameOnCard": {
"type": "string",
"description": "The exact name as it appears on the credit card."
},
"tokenizedCard": {
"type": "string",
"description": ""
},
"cardLastDigits": {
"type": "string",
"description": ""
},
"expirationYear": {
"type": "string",
"description": "The year in which the credit card expires, in 4-digit format."
},
"expirationMonth": {
"type": "string",
"description": "The month that the credit card expires, expressed as a number from 1 to 12."
}
},
"description": "This object contains information about a credit card that is associated with an account.",
"x-ms-summary": "This object contains information about a credit card that is associated with an account.",
"x-ds-definition-name": "creditCardInformation"
}
creditCardTypes
{
"type": "object",
"properties": {
"cardTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array containing supported credit card types."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "creditCardTypes"
}
currencyFeatureSetPrice
{
"type": "object",
"properties": {
"seatFee": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fixedFee": {
"type": "string",
"description": "Reserved for DocuSign."
},
"envelopeFee": {
"type": "string",
"description": "Reserved for DocuSign."
},
"currencyCode": {
"type": "string",
"description": "Specifies the alternate ISO currency code for the account. "
},
"currencySymbol": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.",
"x-ms-summary": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.",
"x-ds-definition-name": "currencyFeatureSetPrice"
}
currencyPlanPrice
{
"type": "object",
"properties": {
"currencyCode": {
"type": "string",
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
},
"perSeatPrice": {
"type": "string",
"description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`"
},
"currencySymbol": {
"type": "string",
"description": "Specifies the currency symbol.\nValid values:\n\n- `AED` <br> \"د.إ\"\n- `AFN` <br> \"؋\"\n- `ALL` <br> \"L\"\n- `AMD` <br> \"֏\"\n- `ANG` <br> \"ƒ\"\n- `AOA` <br> \"Kz\"\n- `ARS` <br> \"$\"\n- `AUD` <br> \"$\"\n- `AWG` <br> \"ƒ\"\n- `AZN` <br> \"₼\"\n- `BAM` <br> \"KM\"\n- `BBD` <br> \"$\"\n- `BDT` <br> \"৳\"\n- `BGN` <br> \"лв\"\n- `BHD` <br> \".د.ب\"\n- `BIF` <br> \"FBu\"\n- `BMD` <br> \"$\"\n- `BND` <br> \"$\"\n- `BOB` <br> \"$b\"\n- `BOV` <br> \"BOV\"\n- `BRL` <br> \"R$\"\n- `BSD` <br> \"$\"\n- `BTN` <br> \"Nu.\"\n- `BWP` <br> \"P\"\n- `BYN` <br> \"Br\"\n- `BYR` <br> \"Br\"\n- `BZD` <br> \"BZ$\"\n- `CAD` <br> \"$\"\n- `CDF` <br> \"FC\"\n- `CHE` <br> \"CHE\"\n- `CHF` <br> \"CHF\"\n- `CHW` <br> \"CHW\"\n- `CLF` <br> \"CLF\"\n- `CLP` <br> \"$\"\n- `CNY` <br> \"¥\"\n- `COP` <br> \"$\"\n- `COU` <br> \"COU\"\n- `CRC` <br> \"₡\"\n- `CUC` <br> \"$\"\n- `CUP` <br> \"₱\"\n- `CVE` <br> \"$\"\n- `CZK` <br> \"Kč\"\n- `DJF` <br> \"Fdj\"\n- `DKK` <br> \"kr\"\n- `DOP` <br> \"RD$\"\n- `DZD` <br> \"دج\"\n- `EGP` <br> \"£\"\n- `ERN` <br> \"Nfk\"\n- `ETB` <br> \"Br\"\n- `EUR` <br> \"€\"\n- `FJD` <br> \"$\"\n- `FKP` <br> \"£\"\n- `GBP` <br> \"£\"\n- `GEL` <br> \"₾\"\n- `GHS` <br> \"GH₵\"\n- `GIP` <br> \"£\"\n- `GMD` <br> \"D\"\n- `GNF` <br> \"FG\"\n- `GTQ` <br> \"Q\"\n- `GYD` <br> \"$\"\n- `HKD` <br> \"$\"\n- `HNL` <br> \"L\"\n- `HRK` <br> \"kn\"\n- `HTG` <br> \"G\"\n- `HUF` <br> \"Ft\"\n- `IDR` <br> \"Rp\"\n- `ILS` <br> \"₪\"\n- `INR` <br> \"₹\"\n- `IQD` <br> \"ع.د\"\n- `IRR` <br> \"﷼\"\n- `ISK` <br> \"kr\"\n- `JMD` <br> \"J$\"\n- `JOD` <br> \"JD\"\n- `JPY` <br> \"¥\"\n- `KES` <br> \"KSh\"\n- `KGS` <br> \"лв\"\n- `KHR` <br> \"៛\"\n- `KMF` <br> \"CF\"\n- `KPW` <br> \"₩\"\n- `KRW` <br> \"₩\"\n- `KWD` <br> \"KD\"\n- `KYD` <br> \"$\"\n- `KZT` <br> \"₸\"\n- `LAK` <br> \"₭\"\n- `LBP` <br> \"£\"\n- `LKR` <br> \"₨\"\n- `LRD` <br> \"$\"\n- `LSL` <br> \"M\"\n- `LYD` <br> \"LD\"\n- `MAD` <br> \"MAD\"\n- `MDL` <br> \"lei\"\n- `MGA` <br> \"Ar\"\n- `MKD` <br> \"ден\"\n- `MMK` <br> \"K\"\n- `MNT` <br> \"₮\"\n- `MOP` <br> \"MOP$\"\n- `MRO` <br> \"UM\"\n- `MUR` <br> \"₨\"\n- `MVR` <br> \"Rf\"\n- `MWK` <br> \"MK\"\n- `MXN` <br> \"$\"\n- `MXV` <br> \"MXV\"\n- `MYR` <br> \"RM\"\n- `MZN` <br> \"MT\"\n- `NAD` <br> \"$\"\n- `NGN` <br> \"₦\"\n- `NIO` <br> \"C$\"\n- `NOK` <br> \"kr\"\n- `NPR` <br> \"₨\"\n- `NZD` <br> \"$\"\n- `OMR` <br> \"﷼\"\n- `PAB` <br> \"B/.\"\n- `PEN` <br> \"S/.\"\n- `PGK` <br> \"K\"\n- `PHP` <br> \"₱\"\n- `PKR` <br> \"₨\"\n- `PLN` <br> \"zł\"\n- `PYG` <br> \"Gs\"\n- `QAR` <br> \"﷼\"\n- `RON` <br> \"lei\"\n- `RSD` <br> \"Дин.\"\n- `RUB` <br> \"₽\"\n- `RWF` <br> \"R₣\"\n- `SAR` <br> \"﷼\"\n- `SBD` <br> \"$\"\n- `SCR` <br> \"₨\"\n- `SDG` <br> \"ج.س.\"\n- `SEK` <br> \"kr\"\n- `SGD` <br> \"S$\"\n- `SHP` <br> \"£\"\n- `SLL` <br> \"Le\"\n- `SOS` <br> \"S\"\n- `SRD` <br> \"$\"\n- `SSP` <br> \"£\"\n- `STD` <br> \"Db\"\n- `SVC` <br> \"$\"\n- `SYP` <br> \"£\"\n- `SZL` <br> \"E\"\n- `THB` <br> \"฿\"\n- `TJS` <br> \"SM\"\n- `TMT` <br> \"T\"\n- `TND` <br> \"د.ت\"\n- `TOP` <br> \"T$\"\n- `TRY` <br> \"₺\"\n- `TTD` <br> \"TT$\"\n- `TWD` <br> \"NT$\"\n- `TZS` <br> \"TSh\"\n- `UAH` <br> \"₴\"\n- `UGX` <br> \"USh\"\n- `USD` <br> \"$\"\n- `USN` <br> \"$\"\n- `UYI` <br> \"UYI\"\n- `UYU` <br> \"$U\"\n- `UZS` <br> \"лв\"\n- `VEF` <br> \"Bs\"\n- `VND` <br> \"₫\"\n- `VUV` <br> \"VT\"\n- `WST` <br> \"WS$\"\n- `XAF` <br> \"FCFA\"\n- `XAG` <br> \"XAG\" Silver\n- `XAU` <br> \"XAU\" Gold\n- `XBA` <br> \"XBA\" Bond Markets Units European Composite Unit (EURCO)\n- `XBB` <br> \"XBB\" European Monetary Unit (E.M.U.-6)\n- `XBC` <br> \"XBC\" European Unit of Account 9(E.U.A.-9)\n- `XBD` <br> \"XBD\" European Unit of Account 17(E.U.A.-17)\n- `XCD` <br> \"$\"\n- `XDR` <br> \"XDR\" }` <br> // Special Drawing Rights (SDRs)` <br> units of account for IMF\n- `XOF` <br> \"CFA\"\n- `XPD` <br> \"XPD\" Palladium\n- `XPF` <br> \"₣\"\n- `XPT` <br> \"XPT\" Platinum\n- `XSU` <br> \"Sucre\"\n- `XTS` <br> \"XTS\" Reserved for testing purposes\n- `XUA` <br> \"XUA\"\n- `XXX` <br> \"XXX\" Denotes transaction involving no currency\n- `YER` <br> \"﷼\"\n- `ZAR` <br> \"R\"\n- `ZMW` <br> \"ZK\"\n- `ZWL` <br> \"$\"\n"
},
"supportPlanFee": {
"type": "string",
"description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"
},
"supportIncidentFee": {
"type": "string",
"description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"
},
"supportedCardTypes": {
"$ref": "#/components/schemas/creditCardTypes"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "currencyPlanPrice"
}
customField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of 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."
},
"fieldId": {
"type": "string",
"description": "The ID of the custom field."
},
"required": {
"type": "string",
"description": "When **true,** the signer must complete 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."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"customFieldType": {
"type": "string",
"description": "The type of custom field. Valid values are:\n\n- `text` (default)\n- `list`"
}
},
"description": "This object provides details about a custom field.",
"x-ms-summary": "This object provides details about a custom field.",
"x-ds-definition-name": "customField"
}
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.",
"x-ms-summary": "Contains information about custom fields.",
"x-ds-definition-name": "customFields"
}
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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "customFieldsEnvelope"
}
customSettingsInformation
{
"type": "object",
"properties": {
"customSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "The name/value pair information for the user custom setting."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "customSettingsInformation"
}
date
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** this custom tab is shared."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n"
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"required": {
"type": "string",
"description": "When **true,** the signer is required to fill out this tab."
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"maxLength": {
"type": "string",
"description": "An optional value that describes the maximum length of the property when the property is a string."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."
},
"requireAll": {
"type": "string",
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"originalValue": {
"type": "string",
"description": "The initial value of the tab. "
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequired": {
"type": "string",
"description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope."
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"disableAutoSize": {
"type": "string",
"description": "When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes."
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"maxLengthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"shareToRecipients": {
"type": "string",
"description": "Reserved for DocuSign."
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationMessage": {
"type": "string",
"description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
},
"validationPattern": {
"type": "string",
"description": "A regular expression used to validate input for the tab."
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireAllMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"originalValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"concealValueOnDocument": {
"type": "string",
"description": "When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"disableAutoSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"shareToRecipientsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationMessageMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validationPatternMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChange": {
"type": "string",
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
},
"concealValueOnDocumentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows the recipient to enter 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",
"x-ms-summary": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n",
"x-ds-definition-name": "date"
}
dateSigned
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "**Note:** Date Signed tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the date that the recipient signed the\ndocument.\n",
"x-ms-summary": "A tab that displays the date that the recipient signed the\ndocument.\n",
"x-ds-definition-name": "dateSigned"
}
dateStampProperties
{
"type": "object",
"properties": {
"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."
},
"dateAreaWidth": {
"type": "string",
"description": "The width of the rectangle."
},
"dateAreaHeight": {
"type": "string",
"description": "The height of the rectangle."
}
},
"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.",
"x-ms-summary": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.",
"x-ds-definition-name": "dateStampProperties"
}
decline
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "**Note:** Decline tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"buttonText": {
"type": "string",
"description": " Specifies the decline text displayed in the tab."
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "The page number on which the tab is located.\nFor supplemental documents, this value must be `1`."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"declineReason": {
"type": "string",
"description": "The reason the recipient declined the document."
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"buttonTextMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"declineReasonMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n",
"x-ms-summary": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n",
"x-ds-definition-name": "decline"
}
delayedRouting
{
"type": "object",
"properties": {
"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."
},
"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.\n"
}
},
"description": "A complex element that specifies the delayed routing settings for the workflow step.",
"x-ms-summary": "A complex element that specifies the delayed routing settings for the workflow step.",
"x-ds-definition-name": "delayedRouting"
}
delegationInfo
{
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": ""
},
"Email": {
"type": "string",
"description": ""
},
"UserId": {
"type": "string",
"description": ""
},
"UserAuthorizationId": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "delegationInfo"
}
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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "diagnosticsSettingsInformation"
}
directDebitProcessorInformation
{
"type": "object",
"properties": {
"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."
},
"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."
},
"country": {
"type": "string",
"description": "The user's country. The system populates this value automatically.\n\n"
},
"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."
},
"lastName": {
"type": "string",
"description": "The user's last name. This field is required for POST and PUT requests.\n\nMaximum Length: 70 characters."
},
"firstName": {
"type": "string",
"description": "The user's first name. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters."
},
"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."
},
"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`"
},
"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."
}
},
"description": "Contains information about a bank that processes a customer's direct debit payments.",
"x-ms-summary": "Contains information about a bank that processes a customer's direct debit payments.",
"x-ds-definition-name": "directDebitProcessorInformation"
}
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. Valid values are:\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",
"x-ms-summary": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse",
"x-ds-definition-name": "dobInformationInput"
}
docGenFormField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form field. The name must be unique to the document.\n\nRequired for PUT requests."
},
"type": {
"type": "string",
"description": "Always `TextBox`. You do not need to provide this value."
},
"label": {
"type": "string",
"description": "Reserved for DocuSign."
},
"value": {
"type": "string",
"description": "The value of the form field.\n\nRequired for PUT requests."
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/docGenFormFieldOption"
},
"description": "An array of option strings supported by this setting."
},
"required": {
"type": "string",
"description": "When **true,** the field is required. This value comes from the the document."
},
"validation": {
"$ref": "#/components/schemas/docGenFormFieldValidation"
},
"description": {
"type": "string",
"description": "A sender-defined description of the line item.\n"
},
"predefinedValidation": {
"type": "string",
"description": ""
}
},
"description": "The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT).\nWhen used with [DocumentGeneration: updateEnvelopeDocGenFormFields](https://raw.githubusercontent.com)\n(PUT) the `name` and `value` properties are required,\nand any other values are ignored.",
"x-ms-summary": "The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT).\nWhen used with [DocumentGeneration: updateEnvelopeDocGenFormFields](https://raw.githubusercontent.com)\n(PUT) the `name` and `value` properties are required,\nand any other values are ignored.",
"x-ds-definition-name": "docGenFormField"
}
docGenFormFieldOption
{
"type": "object",
"properties": {
"label": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"selected": {
"type": "string",
"description": "When **true,** the radio button is selected."
},
"description": {
"type": "string",
"description": "A sender-defined description of the line item.\n"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "docGenFormFieldOption"
}
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.",
"x-ms-summary": "This object maps the document generation fields to their values.",
"x-ds-definition-name": "docGenFormFieldRequest"
}
docGenFormFieldResponse
{
"type": "object",
"properties": {
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"docGenFormFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/docGenFormFields"
},
"description": "A list of `docGenFormFields` objects."
}
},
"description": "An object for document generation responses.",
"x-ms-summary": "An object for document generation responses.",
"x-ds-definition-name": "docGenFormFieldResponse"
}
docGenFormFieldValidation
{
"type": "object",
"properties": {
"expression": {
"type": "string",
"description": ""
},
"errorMessage": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "docGenFormFieldValidation"
}
docGenFormFields
{
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "The GUID of the document."
},
"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."
},
"docGenDocumentStatus": {
"type": "string",
"description": "The status of the document. This is a read-only property.\nValid values:\n\n- `mergesuceeded`\n- `created`\n- `hassyntaxerror`\n"
}
},
"description": "A collection of document generation fields.",
"x-ms-summary": "A collection of document generation fields.",
"x-ds-definition-name": "docGenFormFields"
}
docGenSyntaxError
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message."
},
"errorCode": {
"type": "string",
"description": "A code associated with the error condition."
},
"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.",
"x-ms-summary": "Describes document generation errors.",
"x-ds-definition-name": "docGenSyntaxError"
}
document
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "A URI containing the user ID."
},
"name": {
"type": "string",
"description": "The name of the document."
},
"tabs": {
"$ref": "#/components/schemas/EnvelopeRecipientTabs"
},
"order": {
"type": "string",
"description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
},
"pages": {
"type": "string",
"description": "The number of pages in the document. This property is read-only."
},
"display": {
"type": "string",
"description": "This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n* `modal`<br>\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `inline`<br>\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n"
},
"password": {
"type": "string",
"description": "The user's encrypted password hash."
},
"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](https://raw.githubusercontent.com) or\n[CloudStorage: list](https://raw.githubusercontent.com).\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID of this document. This value is used by tabs to determine which document they appear in."
},
"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.\n\n"
},
"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. \n "
},
"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. \n"
},
"fileFormatHint": {
"type": "string",
"description": ""
},
"htmlDefinition": {
"$ref": "#/components/schemas/documentHtmlDefinition"
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"applyAnchorTabs": {
"type": "string",
"description": "Reserved for DocuSign."
},
"docGenFormFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/docGenFormField"
},
"description": ""
},
"isDocGenDocument": {
"type": "string",
"description": ""
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"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."
},
"includeInDownload": {
"type": "string",
"description": "When **true,**\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true.**\n"
},
"pdfFormFieldOption": {
"type": "string",
"description": ""
},
"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.\n"
},
"signerMustAcknowledge": {
"type": "string",
"description": "Sets how the signer interacts with the supplemental document.\nValid values:\n\n* `no_interaction`<br>\n No recipient action is required.\n\n* `view`<br>\n The recipient is required to view the document.\n\n* `accept`<br>\n The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.\n\n* `view_accept`<br>\n The recipient is required to view and accept the document.\n\n"
},
"assignTabsToRecipientId": {
"type": "string",
"description": ""
},
"encryptedWithKeyManager": {
"type": "string",
"description": "When **true,** the document has been encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n "
},
"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)."
}
},
"description": "A document object.",
"x-ms-summary": "A document object.",
"x-ds-definition-name": "document"
}
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. \n"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "documentFieldsInformation"
}
documentHtmlCollapsibleDisplaySettings
{
"type": "object",
"properties": {
"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.\n"
},
"arrowSize": {
"type": "string",
"description": "Indicates the size of the collapsible arrows. Possible values are:\n\n- `small`\n- `large` (default)\n"
},
"arrowColor": {
"type": "string",
"description": "A CSS color value (such as `#DCF851`) that indicates the color of the arrow.\n"
},
"arrowStyle": {
"type": "string",
"description": "The name of the CSS style to be used on collapsible arrow section.\n"
},
"labelStyle": {
"type": "string",
"description": "The name of the CSS style to be used for the collapsible container's label."
},
"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.\n"
},
"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`\n"
},
"containerStyle": {
"type": "string",
"description": "The name of the CSS style to be used for the collapsible container.\n"
},
"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.\n"
},
"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.",
"x-ms-summary": "Display settings for collapsible section.",
"x-ds-definition-name": "documentHtmlCollapsibleDisplaySettings"
}
documentHtmlDefinition
{
"type": "object",
"properties": {
"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][] is enabled,\nthe HTML code is used to display the signing page:\n\n```\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```\nsource: \"document\"\n```\n\n**Related topics**\n\n- [How to create a signable HTML document](https://raw.githubusercontent.com)\n- [How to convert a PDF file into a signable HTML document](https://raw.githubusercontent.com)\n- [Responsive signing](https://raw.githubusercontent.com)\n\n\n[smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html"
},
"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."
},
"displayOrder": {
"type": "string",
"description": "The position on the page where the display section appears."
},
"documentGuid": {
"type": "string",
"description": "The GUID of the document."
},
"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)"
},
"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.\n"
},
"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)."
},
"displayPageNumber": {
"type": "string",
"description": "The number of the page on which the display section appears."
},
"displayAnchorPrefix": {
"type": "string",
"description": "Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance."
},
"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.\n"
}
},
"description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.\nSee [Responsive signing](https://raw.githubusercontent.com)\nin the [eSignature concepts guide](https://raw.githubusercontent.com).",
"x-ms-summary": "Holds the properties that define how to generate the responsive-formatted HTML for the document.\nSee [Responsive signing](https://raw.githubusercontent.com)\nin the [eSignature concepts guide](https://raw.githubusercontent.com).",
"x-ds-definition-name": "documentHtmlDefinition"
}
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"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "documentHtmlDefinitionOriginals"
}
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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "documentHtmlDefinitions"
}
documentHtmlDisplayAnchor
{
"type": "object",
"properties": {
"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."
},
"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."
},
"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"
},
"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."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "documentHtmlDisplayAnchor"
}
documentHtmlDisplaySettings
{
"type": "object",
"properties": {
"display": {
"type": "string",
"description": "Sets the display and behavior properties. Possible values are:\n\n- `inline`:\n Leaves the HTML where it is in the document.\n This property lets you add a label or present on a separate page.\n\n- `collapsible`:\n The HTML in this section may be expanded or collapsed.\n Initially this section is expanded.\n\n- `collapsed`:\n The HTML in this section may be expanded or collapsed.\n Initially this section is collapsed.\n\n- `continue_button`:\n Creates a stop point in the document to draw the reader's\n attention before proceeding to the next section.\n\n- `responsive_table`:\n Turns this section into a responsive table.\n Note that this is only used on HTML tables that fall within the anchor start and end positions.\n\n- `responsive_table_single_column`:\n Turns this section into a responsive single-column table.\n Note this is only used on HTML tables that fall within the anchor start and end positions.\n The table will be converted to one single column where each current column will become a row, then stacked.\n\n- `print_only`:\n Do not show this portion of the HTML in the responsive signing view.\n\n\n"
},
"preLabel": {
"type": "string",
"description": "Enables you to add descriptive text that appears before a collapsed section or continue button."
},
"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."
},
"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`."
},
"displayLabel": {
"type": "string",
"description": "The label to add to this display section in the signing page.\n"
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "The position on the page where the display section appears."
},
"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`."
},
"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`."
},
"displayPageNumber": {
"type": "integer",
"format": "int32",
"description": "The number of the page on which the display section appears."
},
"collapsibleSettings": {
"$ref": "#/components/schemas/documentHtmlCollapsibleDisplaySettings"
},
"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`."
},
"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`.\n"
}
},
"description": "This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`.",
"x-ms-summary": "This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`.",
"x-ds-definition-name": "documentHtmlDisplaySettings"
}
documentTemplate
{
"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."
},
"templateId": {
"type": "string",
"description": "The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"documentEndPage": {
"type": "string",
"description": ""
},
"documentStartPage": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "documentTemplate"
}