bulkSendBatchStatus
{
"type": "object",
"properties": {
"sent": {
"type": "string",
"description": "The number of envelopes sent successfully."
},
"action": {
"type": "string",
"description": ""
},
"failed": {
"type": "string",
"description": "The number of envelopes that failed to process or send.\n"
},
"queued": {
"type": "string",
"description": "The number of envelopes waiting in pending queue\n"
},
"batchId": {
"type": "string",
"description": "The batch ID."
},
"batchName": {
"type": "string",
"description": "The batch name."
},
"batchSize": {
"type": "string",
"description": "The number of of bulk envelopes submitted in the current batch\n"
},
"bulkErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendErrorStatus"
},
"description": "An array of error statuses."
},
"ownerUserId": {
"type": "string",
"description": ""
},
"actionStatus": {
"type": "string",
"description": ""
},
"envelopesUri": {
"type": "string",
"description": "The URI to get all envelopes sent in the batch.\n"
},
"senderUserId": {
"type": "string",
"description": "The ID of the sender."
},
"envelopesInfo": {
"$ref": "#/components/schemas/bulkSendEnvelopesInfo"
},
"mailingListId": {
"type": "string",
"description": "The ID of the mailing list used to create the batch."
},
"submittedDate": {
"type": "string",
"description": "The timestamp of when the batch was submitted in ISO 8601 format.\n\n"
},
"mailingListName": {
"type": "string",
"description": ""
},
"resendsRemaining": {
"type": "string",
"description": ""
},
"envelopeIdOrTemplateId": {
"type": "string",
"description": "The ID of the draft envelope or template that was used to create the batch.\n"
}
},
"description": "Result of `getBulkSendBatchStatus`",
"x-ms-summary": "Result of `getBulkSendBatchStatus`",
"x-ds-definition-name": "bulkSendBatchStatus"
}
bulkSendBatchSummaries
{
"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. "
},
"queueLimit": {
"type": "string",
"description": "Maximum number of envelopes an account is permitted to have in the queue at any one time."
},
"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. "
},
"totalQueued": {
"type": "string",
"description": "The number of envelopes currently pending processing for the entire account."
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"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."
},
"batchSizeLimit": {
"type": "string",
"description": "The maximum number of envelopes the account is permitted to submit in a given batch."
},
"bulkBatchSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendBatchSummary"
},
"description": "An array of batch summaries."
},
"bulkProcessQueueLimit": {
"type": "string",
"description": ""
},
"bulkProcessTotalQueued": {
"type": "string",
"description": ""
}
},
"description": "A list of bulk send batch summaries. ",
"x-ms-summary": "A list of bulk send batch summaries. ",
"x-ds-definition-name": "bulkSendBatchSummaries"
}
bulkSendBatchSummary
{
"type": "object",
"properties": {
"sent": {
"type": "string",
"description": "Number of envelopes that have been sent."
},
"action": {
"type": "string",
"description": ""
},
"failed": {
"type": "string",
"description": "Number of envelopes that failed to send."
},
"queued": {
"type": "string",
"description": "Number of envelopes peding processing.\n"
},
"batchId": {
"type": "string",
"description": "The batch ID."
},
"batchUri": {
"type": "string",
"description": "The batch details URI."
},
"batchName": {
"type": "string",
"description": "The name of the batch."
},
"batchSize": {
"type": "string",
"description": "The number of envelopes in the batch."
},
"actionStatus": {
"type": "string",
"description": ""
},
"submittedDate": {
"type": "string",
"description": "The time stamp of when the batch was created in ISO 8601 format."
}
},
"description": "Summary status of a single batch.",
"x-ms-summary": "Summary status of a single batch.",
"x-ds-definition-name": "bulkSendBatchSummary"
}
bulkSendEnvelopesInfo
{
"type": "object",
"properties": {
"sent": {
"type": "string",
"description": "The number of entries with a status of `sent`."
},
"signed": {
"type": "string",
"description": ""
},
"voided": {
"type": "string",
"description": ""
},
"correct": {
"type": "string",
"description": ""
},
"created": {
"type": "string",
"description": "The UTC DateTime when the workspace user authorization was created."
},
"deleted": {
"type": "string",
"description": ""
},
"declined": {
"type": "string",
"description": ""
},
"timedOut": {
"type": "string",
"description": ""
},
"completed": {
"type": "string",
"description": ""
},
"delivered": {
"type": "string",
"description": ""
},
"authoritativeCopy": {
"type": "string",
"description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
},
"transferCompleted": {
"type": "string",
"description": ""
},
"digitalSignaturesPending": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "bulkSendEnvelopesInfo"
}
bulkSendErrorStatus
{
"type": "object",
"properties": {
"created": {
"type": "string",
"description": "The timestamp of when the error occurred in ISO 8601 format."
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"errorMessage": {
"type": "string",
"description": "The error message generated during processing, if any.\n"
},
"recipientEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of email addresses for the failed bulk envelope.\n\nRecipient email/info of the failed bulk envelope.\n"
}
},
"description": "A single bulk send error report.",
"x-ms-summary": "A single bulk send error report.",
"x-ds-definition-name": "bulkSendErrorStatus"
}
bulkSendRequest
{
"type": "object",
"properties": {
"batchName": {
"type": "string",
"description": "The human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object.\n"
},
"envelopeOrTemplateId": {
"type": "string",
"description": "The GUID of the envelope or template that you want to send in bulk."
}
},
"description": "This object contains information about the envelope or template that you want to send in bulk.",
"x-ms-summary": "This object contains information about the envelope or template that you want to send in bulk.",
"x-ds-definition-name": "bulkSendRequest"
}
bulkSendResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of errors that occurred. This information is intended to be parsed by machine."
},
"batchId": {
"type": "string",
"description": "A batch identifier that you can use to get the status of the batch."
},
"batchName": {
"type": "string",
"description": ""
},
"batchSize": {
"type": "string",
"description": "The total number of items in the batch being queried."
},
"queueLimit": {
"type": "string",
"description": ""
},
"totalQueued": {
"type": "string",
"description": ""
},
"errorDetails": {
"type": "array",
"items": {
"type": "string"
},
"description": "A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests."
},
"envelopeOrTemplateId": {
"type": "string",
"description": "The GUID of the envelope or template that was sent."
}
},
"description": "The object contains the response to a bulk send request.",
"x-ms-summary": "The object contains the response to a bulk send request.",
"x-ds-definition-name": "bulkSendResponse"
}
bulkSendTestResponse
{
"type": "object",
"properties": {
"canBeSent": {
"type": "boolean",
"description": "When **true,** the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend: createBulkSendRequest][BulkSendRequest] method.\n\n**Note:** This property is only returned in responses and ignored in requests.\n\n[BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/\n"
},
"validationErrors": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of validation errors that were encountered during the bulk send test.\n\n**Note:** This information is intended to be parsed by machine."
},
"validationErrorDetails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Human-readable details about any validation errors that occurred."
}
},
"description": "This object contains the results of a bulk send test.",
"x-ms-summary": "This object contains the results of a bulk send test.",
"x-ds-definition-name": "bulkSendTestResponse"
}
bulkSendingCopy
{
"type": "object",
"properties": {
"emailBlurb": {
"type": "string",
"description": "The email body for this copy of the envelope."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendingCopyRecipient"
},
"description": "Information about the recipients associated with this copy of the envelope."
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendingCopyCustomField"
},
"description": "The custom fields for this copy of the envelope.\n\n**Note:** These custom fields must also be included in the original envelope or template that you want to send."
},
"emailSubject": {
"type": "string",
"description": "The email subject line for this copy of the envelope.\n\nFor information about adding merge field information to the email subject,\nsee [Template Email Subject Merge Fields](https://raw.githubusercontent.com).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."
},
"docGenFormFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulksendingCopyDocGenFormField"
},
"description": ""
}
},
"description": "This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.",
"x-ms-summary": "This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.",
"x-ds-definition-name": "bulkSendingCopy"
}
bulkSendingCopyCustomField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom field."
},
"value": {
"type": "string",
"description": "The value of the custom field."
}
},
"description": "This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.",
"x-ms-summary": "This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.",
"x-ds-definition-name": "bulkSendingCopyCustomField"
}
bulkSendingCopyRecipient
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"note": {
"type": "string",
"description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
},
"tabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendingCopyTab"
},
"description": "A list of tabs associated with the recipient. In a bulk send request, each of these recipient tabs must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.\n\n You can use the following types of tabs to match bulk send recipients to an envelope:\n\n- Text tabs\n- Radio group tabs (where the name of the `radioGroup` on the envelope is used as the `tabLabel` in the bulk send list)\n- List tabs"
},
"email": {
"type": "string",
"description": "The recipient's email address."
},
"hostName": {
"type": "string",
"description": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
},
"roleName": {
"type": "string",
"description": "The name of the role associated with the recipient.\n\n**Note:** Every recipient must be assigned either a `recipientId` or a `roleName` but not both. You cannot use `roleName` and `recipientId` in the same list."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"hostEmail": {
"type": "string",
"description": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n"
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"signerName": {
"type": "string",
"description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"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/"
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"identificationMethod": {
"type": "string",
"description": ""
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"recipientSignatureProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientSignatureProvider"
},
"description": "The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://raw.githubusercontent.com)"
}
},
"description": "This object contains details about a bulk send recipient.",
"x-ms-summary": "This object contains details about a bulk send recipient.",
"x-ds-definition-name": "bulkSendingCopyRecipient"
}
bulkSendingCopyTab
{
"type": "object",
"properties": {
"tabLabel": {
"type": "string",
"description": "The label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nMaximum Length: 500 characters."
},
"initialValue": {
"type": "string",
"description": "The initial value that you want to assign to the tab."
}
},
"description": "A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.",
"x-ms-summary": "A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.",
"x-ds-definition-name": "bulkSendingCopyTab"
}
bulkSendingList
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the bulk send list."
},
"listId": {
"type": "string",
"description": "The GUID of the bulk send list."
},
"bulkCopies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendingCopy"
},
"description": "An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information."
}
},
"description": "This object contains the details for the bulk send list.",
"x-ms-summary": "This object contains the details for the bulk send list.",
"x-ds-definition-name": "bulkSendingList"
}
bulkSendingListSummaries
{
"type": "object",
"properties": {
"bulkListSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bulkSendingListSummary"
},
"description": "An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user."
}
},
"description": "This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.",
"x-ms-summary": "This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.",
"x-ds-definition-name": "bulkSendingListSummaries"
}
bulkSendingListSummary
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the bulk send list."
},
"createdDate": {
"type": "string",
"description": "The UTC DateTime that the bulk send list was created."
},
"createdByUser": {
"type": "string",
"description": "The GUID of the user who created the bulk send list."
},
"bulkSendListId": {
"type": "string",
"description": "The GUID of the bulk send list. This property is created after you post a new bulk send list."
}
},
"description": "This object contains basic information about a bulk send list.",
"x-ms-summary": "This object contains basic information about a bulk send list.",
"x-ds-definition-name": "bulkSendingListSummary"
}
bulksendingCopyDocGenFormField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "bulksendingCopyDocGenFormField"
}
captiveRecipient
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address associated with the captive recipient."
},
"userName": {
"type": "string",
"description": "The username associated with the captive recipient."
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
}
},
"description": "This object contains details about a captive (embedded) recipient.",
"x-ms-summary": "This object contains details about a captive (embedded) recipient.",
"x-ds-definition-name": "captiveRecipient"
}
captiveRecipientInformation
{
"type": "object",
"properties": {
"captiveRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/captiveRecipient"
},
"description": "A complex type containing information about one or more captive recipients."
}
},
"description": "Contains information about captive (embedded) recipients.",
"x-ms-summary": "Contains information about captive (embedded) recipients.",
"x-ds-definition-name": "captiveRecipientInformation"
}
carbonCopy
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set."
},
"note": {
"type": "string",
"description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
},
"tabs": {
"$ref": "#/components/schemas/EnvelopeRecipientTabs"
},
"email": {
"type": "string",
"description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. "
},
"status": {
"type": "string",
"description": "The recipient's status. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"fullName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lastName": {
"type": "string",
"description": "The recipient's last name."
},
"roleName": {
"type": "string",
"description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"firstName": {
"type": "string",
"description": "The recipient's first name. Maximum Length: 50 characters."
},
"proofFile": {
"$ref": "#/components/schemas/recipientProofFile"
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"statusCode": {
"type": "string",
"description": "The code associated with the recipient's status. This property is read-only."
},
"phoneNumber": {
"$ref": "#/components/schemas/recipientPhoneNumber"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
},
"clientUserId": {
"type": "string",
"description": "Not applicable for Carbon Copy recipients."
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"designatorId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"noteMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"emailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientType": {
"type": "string",
"description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
},
"totalTabCount": {
"type": "string",
"description": "The total number of tabs in the documents. This property is read-only."
},
"completedCount": {
"type": "string",
"description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only."
},
"declinedReason": {
"type": "string",
"description": "The reason the recipient declined the document. This property is read-only."
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
},
"suppressEmails": {
"type": "string",
"description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"requireIdLookup": {
"type": "string",
"description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
},
"agentCanEditName": {
"type": "string",
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"designatorIdGuid": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fullNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lastNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"agentCanEditEmail": {
"type": "string",
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"excludedDocuments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent."
},
"faxNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"firstNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "A complex type that contains information about users in the signing group."
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"accessCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"consentDetailsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consentDetails"
},
"description": ""
},
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
},
"autoRespondedReason": {
"type": "string",
"description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
},
"bulkSendV2Recipient": {
"type": "string",
"description": ""
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"addAccessCodeToEmail": {
"type": "string",
"description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"recipientAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAttachment"
},
"description": "Reserved for DocuSign."
},
"routingOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"deliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"additionalNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAdditionalNotification"
},
"description": "An array of additional notification objects."
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"requireIdLookupMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"recipientFeatureMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureAvailableMetadata"
},
"description": "Metadata about the features that are supported for the recipient type. This property is read-only."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"lockedRecipientSmsEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"emailRecipientPostSigningURL": {
"type": "string",
"description": ""
},
"linkedAccountConfigurationId": {
"type": "string",
"description": ""
},
"recipientAuthenticationStatus": {
"$ref": "#/components/schemas/authenticationStatus"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedRecipientPhoneAuthEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowSystemOverrideForLockedRecipient": {
"type": "string",
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
},
"inheritEmailNotificationConfiguration": {
"type": "string",
"description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
}
},
"description": "Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. ",
"x-ms-summary": "Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. ",
"x-ds-definition-name": "carbonCopy"
}
certifiedDelivery
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set."
},
"note": {
"type": "string",
"description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
},
"email": {
"type": "string",
"description": "The recipient's email address."
},
"status": {
"type": "string",
"description": "The status of the recipient. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"fullName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lastName": {
"type": "string",
"description": "The recipient's last name."
},
"roleName": {
"type": "string",
"description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"firstName": {
"type": "string",
"description": "The recipient's first name. Maximum Length: 50 characters."
},
"proofFile": {
"$ref": "#/components/schemas/recipientProofFile"
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"statusCode": {
"type": "string",
"description": "The code associated with the recipient's status. This property is read-only."
},
"phoneNumber": {
"$ref": "#/components/schemas/recipientPhoneNumber"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"designatorId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"noteMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"emailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientType": {
"type": "string",
"description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
},
"totalTabCount": {
"type": "string",
"description": "The total number of tabs in the documents. This property is read-only."
},
"completedCount": {
"type": "string",
"description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only."
},
"declinedReason": {
"type": "string",
"description": "The reason the recipient declined the document. This property is read-only."
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
},
"suppressEmails": {
"type": "string",
"description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"requireIdLookup": {
"type": "string",
"description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
},
"agentCanEditName": {
"type": "string",
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"designatorIdGuid": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fullNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lastNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"agentCanEditEmail": {
"type": "string",
"description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"excludedDocuments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent."
},
"faxNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"firstNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "A complex type that contains information about users in the signing group."
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"accessCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"consentDetailsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consentDetails"
},
"description": ""
},
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
},
"autoRespondedReason": {
"type": "string",
"description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
},
"bulkSendV2Recipient": {
"type": "string",
"description": ""
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"addAccessCodeToEmail": {
"type": "string",
"description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"recipientAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAttachment"
},
"description": "Reserved for DocuSign."
},
"routingOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"deliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"additionalNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAdditionalNotification"
},
"description": "An array of additional notification objects."
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"requireIdLookupMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"recipientFeatureMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureAvailableMetadata"
},
"description": "Metadata about the features that are supported for the recipient type. This property is read-only."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"lockedRecipientSmsEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"emailRecipientPostSigningURL": {
"type": "string",
"description": ""
},
"recipientAuthenticationStatus": {
"$ref": "#/components/schemas/authenticationStatus"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedRecipientPhoneAuthEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowSystemOverrideForLockedRecipient": {
"type": "string",
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
},
"inheritEmailNotificationConfiguration": {
"type": "string",
"description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
}
},
"description": "Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.",
"x-ms-summary": "Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.",
"x-ds-definition-name": "certifiedDelivery"
}
checkbox
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"name": {
"type": "string",
"description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** this tab is shared."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"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": "This property does not apply to `checkbox` tabs.\n\nTo require users to check\nat least one, or at most some number\nof checkboxes,\nassociate the checkbox tabs\nwith a [`tabGroup`][tabGroup].\nThen set the following `tabGroup` properties:\n\n- [`maximumAllowed`][maximumAllowed]\n- [`minimumRequired`][minimumRequired]\n- [`groupRule`][groupRule] specifies how the other two properties are interpreted.\n\nYou can find an example\nat [Stack Overflow][so].\n\n[so]: https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277\n[tabGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups\n[groupRule]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule\n[maximumAllowed]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed\n[minimumRequired]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired\n"
},
"selected": {
"type": "string",
"description": "When **true,** the checkbox is selected."
},
"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 (-7, -6)\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 (-7, -6)\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 apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all 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"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"selectedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"selectedOriginal": {
"type": "string",
"description": ""
},
"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"
},
"shareToRecipients": {
"type": "string",
"description": "Reserved for DocuSign."
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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."
},
"selectedOriginalMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChange": {
"type": "string",
"description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows the recipient to select a yes/no (on/off) option.\n",
"x-ms-summary": "A tab that allows the recipient to select a yes/no (on/off) option.\n",
"x-ds-definition-name": "checkbox"
}
chunkedUploadPart
{
"type": "object",
"properties": {
"size": {
"type": "string",
"description": "The size of the part in bytes. \n\nDocuSign recommends that a chunked upload part is no larger than a few MB in size."
},
"sequence": {
"type": "string",
"description": "The order of the part in the chunked upload."
}
},
"description": "An object that contains information about the chunked upload part.",
"x-ms-summary": "An object that contains information about the chunked upload part.",
"x-ds-definition-name": "chunkedUploadPart"
}
chunkedUploadRequest
{
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "A base64-encoded representation of the content that is used to upload the file. \n\nMaximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size."
},
"chunkedUploadId": {
"type": "string",
"description": "The ID of the chunked upload.\n\n**Note:** This property is ignored in requests, and overridden with an auto-generated value in responses."
}
},
"description": "This is the request object for uploading a chunked upload.",
"x-ms-summary": "This is the request object for uploading a chunked upload.",
"x-ds-definition-name": "chunkedUploadRequest"
}
chunkedUploadResponse
{
"type": "object",
"properties": {
"checksum": {
"type": "string",
"description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the commit action is refused."
},
"committed": {
"type": "string",
"description": "When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. "
},
"totalSize": {
"type": "string",
"description": "The total size of the parts of the chunked upload.\n\n**Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents."
},
"maxTotalSize": {
"type": "string",
"description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB."
},
"chunkedUploadId": {
"type": "string",
"description": "The ID of the chunked upload. "
},
"chunkedUploadUri": {
"type": "string",
"description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. "
},
"chunkedUploadParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/chunkedUploadPart"
},
"description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload."
},
"expirationDateTime": {
"type": "string",
"description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note:** You must fully upload and use a chunked upload within 20 minutes of initializing it.\n"
},
"maxChunkedUploadParts": {
"type": "string",
"description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256. "
}
},
"description": "This response object is returned after you upload a chunked upload.",
"x-ms-summary": "This response object is returned after you upload a chunked upload.",
"x-ds-definition-name": "chunkedUploadResponse"
}
cloudStorageProvider
{
"type": "object",
"properties": {
"service": {
"type": "string",
"description": "The service name for the cloud storage provider."
},
"serviceId": {
"type": "string",
"description": "The DocuSign-generated ID for the cloud storage provider."
},
"redirectUrl": {
"type": "string",
"description": "The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"authenticationUrl": {
"type": "string",
"description": "The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. "
}
},
"description": "Contains details about a specific cloud storage provider.",
"x-ms-summary": "Contains details about a specific cloud storage provider.",
"x-ds-definition-name": "cloudStorageProvider"
}
cloudStorageProviders
{
"type": "object",
"properties": {
"storageProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cloudStorageProvider"
},
"description": "An Array containing the storage providers associated with the user."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "cloudStorageProviders"
}
comment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the comment."
},
"hmac": {
"type": "string",
"description": "Reserved for DocuSign."
},
"read": {
"type": "boolean",
"description": "When **true,** indicates that the comment was read."
},
"text": {
"type": "string",
"description": "The content of the comment, as UTF-8 text. \n\nMaximum Length: 500 characters.\n\n**Note:** The maximum size allowed for the entire message body is 32 KB. "
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab that represents the comment thread."
},
"subject": {
"type": "string",
"description": "The subject of the envelope."
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of userIds that are mentioned directly in the body of a comment."
},
"threadId": {
"type": "string",
"description": "The unique identifier for the comment thread."
},
"timestamp": {
"type": "string",
"description": "The time the comment was created."
},
"visibleTo": {
"type": "array",
"items": {
"type": "string"
},
"description": "The user IDs of the users that the comment is visible to."
},
"envelopeId": {
"type": "string",
"description": "The Guid of the envelope the comment thread belongs to."
},
"sentByEmail": {
"type": "string",
"description": "The email address of the user who created the comment."
},
"sentByUserId": {
"type": "string",
"description": "The user ID of the user who created the comment."
},
"sentByImageId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"sentByFullName": {
"type": "string",
"description": "The full name of the user who created the comment."
},
"sentByInitials": {
"type": "string",
"description": "The initials of the user who created the comment."
},
"signingGroupId": {
"type": "string",
"description": "The ID of the signing group that can view the comment or that created the comment."
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"sentByRecipientId": {
"type": "string",
"description": "The recipient ID of the user who created the comment."
},
"threadOriginatorId": {
"type": "string",
"description": "The userId of the user who created the thread."
},
"timeStampFormatted": {
"type": "string",
"description": "The time the comment was created, formatted according to the format of the user who created the comment."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "comment"
}
commentHistoryResult
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32",
"description": "The maximum number of results to return."
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/comment"
},
"description": "An array of comment tabs that contain information about users' comments on documents."
},
"endTimetoken": {
"type": "string",
"description": ""
},
"startTimetoken": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "commentHistoryResult"
}
commentPublish
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Salesforce object."
},
"text": {
"type": "string",
"description": "Specifies the text that is shown in the dropdown list. "
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of userIds that are mentioned directly in the body of a comment."
},
"threadId": {
"type": "string",
"description": "The unique identifier for the comment thread."
},
"visibleTo": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"threadAnchorKeys": {
"type": "object",
"description": "",
"additionalProperties": {
"type": "string"
}
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "commentPublish"
}
commentThread
{
"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": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/comment"
},
"description": "An array of comment tabs that contain information about users' comments on documents."
},
"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."
},
"threadId": {
"type": "string",
"description": "The unique identifier for the comment thread."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "commentThread"
}
commentsPublish
{
"type": "object",
"properties": {
"commentsToPublish": {
"type": "array",
"items": {
"$ref": "#/components/schemas/commentPublish"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "commentsPublish"
}
commissionCounty
{
"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": ""
},
"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."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"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"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
"x-ms-summary": "A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
"x-ds-definition-name": "commissionCounty"
}
commissionExpiration
{
"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": ""
},
"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."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"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"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
"x-ms-summary": "A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
"x-ds-definition-name": "commissionExpiration"
}
commissionNumber
{
"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": ""
},
"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."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"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"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
"x-ms-summary": "A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
"x-ds-definition-name": "commissionNumber"
}
commissionState
{
"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": ""
},
"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."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
},
"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"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n"
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located."
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
"x-ms-summary": "A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
"x-ds-definition-name": "commissionState"
}
company
{
"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."
},
"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`."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that displays the recipient's company name.\n",
"x-ms-summary": "A tab that displays the recipient's company name.\n",
"x-ds-definition-name": "company"
}
compositeTemplate
{
"type": "object",
"properties": {
"document": {
"$ref": "#/components/schemas/document"
},
"inlineTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inlineTemplate"
},
"description": " Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value."
},
"serverTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/serverTemplate"
},
"description": "Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value."
},
"compositeTemplateId": {
"type": "string",
"description": "The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document."
},
"pdfMetaDataTemplateSequence": {
"type": "string",
"description": "A number representing the sequence in which to apply the template that contains the PDF metadata.\n\nExample: `4`"
}
},
"description": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/",
"x-ms-summary": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/",
"x-ds-definition-name": "compositeTemplate"
}
conditionalRecipientRule
{
"type": "object",
"properties": {
"order": {
"type": "string",
"description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conditionalRecipientRuleCondition"
},
"description": "An array of conditions that define when the recipients will be used."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the condition will be applied. This value should match the `recipientId` defined in the recipient object.\n"
},
"recipientGroup": {
"$ref": "#/components/schemas/recipientGroup"
}
},
"description": "A rule that defines a set of recipients and the conditions under which they will be used for the envelope.",
"x-ms-summary": "A rule that defines a set of recipients and the conditions under which they will be used for the envelope.",
"x-ds-definition-name": "conditionalRecipientRule"
}
conditionalRecipientRuleCondition
{
"type": "object",
"properties": {
"order": {
"type": "string",
"description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values."
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conditionalRecipientRuleFilter"
},
"description": ""
},
"recipientLabel": {
"type": "string",
"description": "An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](https://raw.githubusercontent.com).\n"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "conditionalRecipientRuleCondition"
}
conditionalRecipientRuleFilter
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"description": "The scope under which the condition is evaluated. Valid values:\n\n* `tabs`"
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "A set value to which the tab's actual value is compared."
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"operator": {
"type": "string",
"description": "How the tab value is compared to the `value` property. Valid values:\n\n* `equals`\n* `greaterThan`\n* `greaterThanEquals`\n* `lessThan`\n* `lessThanEquals`\n* `filled`\n* `selected`"
},
"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"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "conditionalRecipientRuleFilter"
}
connectConfigResults
{
"type": "object",
"properties": {
"totalRecords": {
"type": "string",
"description": "The number of results."
},
"configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectCustomConfiguration"
},
"description": "An array of DocuSign Connect configurations."
}
},
"description": "This object contains the results of a ConnectConfigurations::GET method.",
"x-ms-summary": "This object contains the results of a ConnectConfigurations::GET method.",
"x-ds-definition-name": "connectConfigResults"
}
connectCustomConfiguration
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Connect configuration.\n\nThis property is required."
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](https://raw.githubusercontent.com). If you are instead using any of [the legacy event message formats](https://raw.githubusercontent.com), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/improved-json-sim-event-model/#eventreference) are:\n\n* `envelope-created`\n* `envelope-sent`\n* `envelope-resent`\n* `envelope-delivered`\n* `envelope-completed`\n* `envelope-declined`\n* `envelope-voided`\n* `recipient-authenticationfailed`\n* `recipient-autoresponded`\n* `recipient-declined`\n* `recipient-delivered`\n* `recipient-completed`\n* `recipient-sent`\n* `recipient-resent`\n* `template-created`\n* `template-modified`\n* `template-deleted`\n* `envelope-corrected`\n* `envelope-purge`\n* `envelope-deleted`\n* `envelope-discard`\n* `recipient-reassign`\n* `recipient-delegate`\n* `recipient-finish-later`\n* `click-agreed`\n* `click-declined`\n"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\nBy default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.**\n\n**Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs."
},
"allUsers": {
"type": "string",
"description": "When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.**\n\n**Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs."
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"password": {
"type": "string",
"description": "The password for the Connect configuration.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.\n"
},
"userName": {
"type": "string",
"description": "The name of the user."
},
"connectId": {
"type": "string",
"description": "The DocuSign-generated ID for the Connect configuration.\n\nThis property is read-only."
},
"enableLog": {
"type": "string",
"description": "When **true,** Connect logging is turned on. DocuSign recommends that you enable this functionality to help troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console."
},
"eventData": {
"$ref": "#/components/schemas/connectEventData"
},
"sfObjects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectSalesforceObject"
},
"description": "An array of Salesforce objects."
},
"disabledBy": {
"type": "string",
"description": ""
},
"includeHMAC": {
"type": "string",
"description": ""
},
"deliveryMode": {
"type": "string",
"description": "The delivery mode of the configuration. Valid values:\n\n* `SIM`\n* `Aggregate`"
},
"includeOAuth": {
"type": "string",
"description": ""
},
"soapNamespace": {
"type": "string",
"description": "The namespace of the SOAP interface.\n\n**Note:** If `useSoapInterface` is set to **true,** you must set this value."
},
"allUsersExcept": {
"type": "string",
"description": "This flag allows you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.**"
},
"envelopeEvents": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.\n\nWhen using any of [the legacy event message formats](https://raw.githubusercontent.com), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](]/platform/webhooks/connect/improved-json-sim-event-model/), use the `events` property.\n\nThe [possible event statuses](https://raw.githubusercontent.com) are:\n\n* `Sent`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `Voided`\n\n**Note:** These values are case-sensitive."
},
"senderOverride": {
"type": "string",
"description": ""
},
"urlToPublishTo": {
"type": "string",
"description": "The web address of the listener or retrieving service endpoint. It must be an HTTPS URL."
},
"recipientEvents": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the `url` property. \n\nWhen using any of [the legacy event message formats](https://raw.githubusercontent.com), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](https://raw.githubusercontent.com), use the `events` property.\n\nThe [possible event statuses](https://raw.githubusercontent.com) are:\n\n* `Sent`\n* `AutoResponded`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `AuthenticationFailed`\n\n**Note:** These values are case-sensitive."
},
"externalFolderId": {
"type": "string",
"description": "The ID of an external folder."
},
"includeDocuments": {
"type": "string",
"description": "Reserved for DocuSign."
},
"requireMutualTls": {
"type": "string",
"description": "When **true,** [Mutual TLS](https://raw.githubusercontent.com) authentication is enabled."
},
"useSoapInterface": {
"type": "string",
"description": "When **true,** the notifications are sent to your endpoint as SOAP requests. "
},
"configurationType": {
"type": "string",
"description": "The type of the configuration. Valid values:\n\n* `custom`: Creates an account-level configuration\n* `customrecipient`: Creates a Recipient Connect configuration\n* `salesforce`\n* `eOriginal`\n\nThis property is required."
},
"integratorManaged": {
"type": "string",
"description": ""
},
"salesforceAuthcode": {
"type": "string",
"description": ""
},
"externalFolderLabel": {
"type": "string",
"description": "The label for an external folder."
},
"allowEnvelopePublish": {
"type": "string",
"description": "Set this value to **true** to enable the webhook. The default property is **false.**"
},
"salesforceApiVersion": {
"type": "string",
"description": "The version of the Salesforce API that you are using."
},
"includeCertSoapHeader": {
"type": "string",
"description": ""
},
"includeDocumentFields": {
"type": "string",
"description": "When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. "
},
"salesforceCallBackUrl": {
"type": "string",
"description": ""
},
"senderSelectableItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "This property sets the items that are available for selection when adding or editing Connect objects. "
},
"allowSalesforcePublish": {
"type": "string",
"description": "When **true,** DocuSign sends data to the designated Salesforce account through Connect. The default value is **true.**"
},
"requiresAcknowledgement": {
"type": "string",
"description": "When **true,** event delivery acknowledgements are enabled for your Connect configuration.\n\nDocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\n"
},
"includeEnvelopeVoidReason": {
"type": "string",
"description": "When **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. "
},
"includeTimeZoneInformation": {
"type": "string",
"description": "When **true,** Connect will include the envelope time zone information."
},
"includeCertificateOfCompletion": {
"type": "string",
"description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. "
},
"signMessageWithX509Certificate": {
"type": "string",
"description": "When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. "
},
"includeSenderAccountasCustomField": {
"type": "string",
"description": "When **true,** Connect will include the sender account as Custom Field in the data."
},
"salesforceDocumentsAsContentFiles": {
"type": "string",
"description": "When **true,** DocuSign can use documents in your Salesforce account for sending and signing."
}
},
"description": "The `connectCustomConfiguration` object describes a Connect configuration for your account.",
"x-ms-summary": "The `connectCustomConfiguration` object describes a Connect configuration for your account.",
"x-ds-definition-name": "connectCustomConfiguration"
}
connectDebugLog
{
"type": "object",
"properties": {
"payload": {
"type": "string",
"description": "Log output."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"connectConfig": {
"type": "string",
"description": "The name of the Connect configuration."
},
"eventDateTime": {
"type": "string",
"description": "The UTC date and time of the event."
},
"eventDescription": {
"type": "string",
"description": "A description of the event."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "connectDebugLog"
}
connectDeleteFailureResult
{
"type": "object",
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "connectDeleteFailureResult"
}
connectEventData
{
"type": "object",
"properties": {
"format": {
"type": "string",
"description": "Reserved for DocuSign."
},
"version": {
"type": "string",
"description": "Set this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default."
},
"includeData": {
"type": "array",
"items": {
"type": "string"
},
"description": "A string array of the data to be included.\nThe default is the empty array `[]`.\n\n- `attachments`: Include attachments associated with the envelope.\n- `custom_fields`: Include the custom fields associated with the envelope.\n- `documents`: Include the documents associated with the envelope.\n- `extensions`: Include information about the email settings associated with the envelope.\n- `folders`: Include the folder where the envelope exists.\n- `payment_tabs`: Include the payment tabs associated with the envelope.\n- `powerform`: Include the PowerForms associated with the envelope.\n- `prefill_tabs`: Include the [pre-filled tabs](https://raw.githubusercontent.com) associated with the envelope.\n- `recipients`: Include the recipients associated with the envelope.\n- `tabs`: Include the tabs associated with the envelope.\n"
}
},
"description": "This object lets you choose the data format of your Connect response.",
"x-ms-summary": "This object lets you choose the data format of your Connect response.",
"x-ds-definition-name": "connectEventData"
}
connectFailureFilter
{
"type": "object",
"properties": {
"envelopeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of envelope GUIDs.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
},
"synchronous": {
"type": "string",
"description": "Must be **false.** Setting this property to any other value will result in errors."
}
},
"description": "A list of failed envelope IDs to retry.",
"x-ms-summary": "A list of failed envelope IDs to retry.",
"x-ds-definition-name": "connectFailureFilter"
}
connectFailureResult
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The connection status."
},
"configId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"configUrl": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"statusMessage": {
"type": "string",
"description": "A human-readable message describing the connection status."
}
},
"description": "This object contains details about a Connect failure result.",
"x-ms-summary": "This object contains details about a Connect failure result.",
"x-ds-definition-name": "connectFailureResult"
}
connectFailureResults
{
"type": "object",
"properties": {
"retryQueue": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectFailureResult"
},
"description": "Details about a Connect failure result."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "connectFailureResults"
}
connectHistoricalEnvelopeRepublish
{
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/connectCustomConfiguration"
},
"envelopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of envelope IDs as comma-separated strings. This property is required.\n\nFor example: `[\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\",\"9586h293-xxxx-xxxx-xxxx-m923b8opre71\",\"2347w948-xxxx-xxxx-xxxx-t096b8krno89\"]`"
}
},
"description": "The request body for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"x-ms-summary": "The request body for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"x-ds-definition-name": "connectHistoricalEnvelopeRepublish"
}
connectLog
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address of the envelope sender."
},
"error": {
"type": "string",
"description": "The error that caused the Connect post to fail."
},
"logId": {
"type": "string",
"description": "The Connect log ID for the entry."
},
"logUri": {
"type": "string",
"description": "The URI for the Connect log entry."
},
"status": {
"type": "string",
"description": "The envelope status for the Connect post. Possible values are:\n- `Any`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Template`\n- `Processing`\n\nFor details about these statuses, see [Envelope Status Code Descriptions](https://raw.githubusercontent.com)."
},
"created": {
"type": "string",
"description": "The UTC DateTime when the Connect post was created."
},
"lastTry": {
"type": "string",
"description": "The UTC DateTime of the last attempt to post."
},
"subject": {
"type": "string",
"description": "The subject of the envelope."
},
"retryUri": {
"type": "string",
"description": "A URI that you can use to retry to publish the Connect post."
},
"userName": {
"type": "string",
"description": "The name of the sender of the envelope."
},
"accountId": {
"type": "string",
"description": "The account ID associated with the envelope."
},
"configUrl": {
"type": "string",
"description": "The web address of the listener or retrieving service endpoint for Connect."
},
"connectId": {
"type": "string",
"description": "The ID of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post."
},
"failureId": {
"type": "string",
"description": "The failure log ID for the failure."
},
"envelopeId": {
"type": "string",
"description": "The ID of the envelope that failed to post."
},
"failureUri": {
"type": "string",
"description": "The URI for the Connect post failure."
},
"retryCount": {
"type": "string",
"description": "The number of times the Connect post has been retried."
},
"connectDebugLog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectDebugLog"
},
"description": "A complex element containing information about the Connect configuration, error details, date/time, description and payload.\nThis information is included in the response only when the `additional_info` query is set to **true.**\nThis additional information is only available when retrieving general logs with [ConnectEvents:get](https://raw.githubusercontent.com), but not when retrieving failure logs with [ConnectEvents:listFailures](https://raw.githubusercontent.com)."
}
},
"description": "Contains information about a Connect log entry.",
"x-ms-summary": "Contains information about a Connect log entry.",
"x-ds-definition-name": "connectLog"
}