polyLineOverlay
{
"type": "object",
"properties": {
"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."
},
"locked": {
"type": "string",
"description": "When **true,** the signer cannot change the data of the custom tab."
},
"shared": {
"type": "string",
"description": "When **true,** indicates that the 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"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"polyLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/polyLine"
},
"description": "An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines."
},
"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."
},
"overlayType": {
"type": "string",
"description": "The type of overlay to use. The API currently supports only the `outline` overlay type."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"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"
},
"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"
},
"graphicsContext": {
"$ref": "#/components/schemas/graphicsContext"
},
"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"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"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"
},
"overlayTypeMetadata": {
"$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": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.",
"x-ms-summary": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.",
"x-ds-definition-name": "polyLineOverlay"
}
powerForm
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "The URI for the PowerForm."
},
"name": {
"type": "string",
"description": "The name of the PowerForm."
},
"isActive": {
"type": "string",
"description": "When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\nWhen **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.\n"
},
"lastUsed": {
"type": "string",
"description": "The UTC DateTime when the PowerForm was last used."
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the PowerForm."
},
"emailBody": {
"type": "string",
"description": "The body of the email message sent to the recipients. \n\nMaximum length: 10000 characters."
},
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelope"
},
"description": ""
},
"timesUsed": {
"type": "string",
"description": "The number of times the PowerForm has been used. "
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerFormRecipient"
},
"description": "An array of recipient objects that provides details about the recipients of the envelope."
},
"senderName": {
"type": "string",
"description": "The sender's name."
},
"templateId": {
"type": "string",
"description": "The ID of the template used to create the PowerForm."
},
"powerFormId": {
"type": "string",
"description": "The ID of the PowerForm."
},
"signingMode": {
"type": "string",
"description": "The signing mode to use. Valid values are:\n \n- `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document. \n- `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). \n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`."
},
"emailSubject": {
"type": "string",
"description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"instructions": {
"type": "string",
"description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm. Limit: 2000 characters."
},
"powerFormUrl": {
"type": "string",
"description": "The URL for the PowerForm."
},
"senderUserId": {
"type": "string",
"description": "The ID of the sender."
},
"templateName": {
"type": "string",
"description": "The name of the template used to create the PowerForm."
},
"maxUseEnabled": {
"type": "string",
"description": "When **true,** you can set a maximum number of uses for the PowerForm."
},
"usesRemaining": {
"type": "string",
"description": "The number of times the PowerForm can still be used."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
},
"limitUseInterval": {
"type": "string",
"description": "The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property."
},
"limitUseIntervalUnits": {
"type": "string",
"description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n"
},
"limitUseIntervalEnabled": {
"type": "string",
"description": "When **true,** the `limitUseInterval` is enabled."
}
},
"description": "Contains details about a PowerForm.",
"x-ms-summary": "Contains details about a PowerForm.",
"x-ds-definition-name": "powerForm"
}
powerFormFormDataEnvelope
{
"type": "object",
"properties": {
"envelopeId": {
"type": "string",
"description": "The envelope ID of the envelope status that failed to post."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerFormFormDataRecipient"
},
"description": "An array of recipient objects that provides details about the recipients of the envelope."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "powerFormFormDataEnvelope"
}
powerFormFormDataRecipient
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the recipient."
},
"email": {
"type": "string",
"description": ""
},
"formData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": ""
},
"recipientId": {
"type": "string",
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "powerFormFormDataRecipient"
}
powerFormRecipient
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the PowerForm recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank."
},
"email": {
"type": "string",
"description": "The email address of the recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank."
},
"roleName": {
"type": "string",
"description": "The role associated with the recipient (for example, `Member`).\n\nThis property is required when you are working with template recipients and PowerForm recipients."
},
"accessCode": {
"type": "string",
"description": "(Optional) The access code that the recipient must enter to access the PowerForm.\n\nMaximum Length: 50 characters. The code must also conform to the account's access code format setting.\n\nIf blank but the signer accessCode property is set in the envelope, then that value is used.\n\nIf blank and the signer accessCode property is not set, then the access code is not required."
},
"emailLocked": {
"type": "string",
"description": "When **true,** the recipient's email address is locked and cannot be edited."
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"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."
},
"userNameLocked": {
"type": "string",
"description": "When **true,** the `userName` property for the recipient is locked and cannot be edited."
},
"idCheckRequired": {
"type": "string",
"description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope. \n- `never`: Authentication checks are not performed on any envelopes. \n- `optional:` Authentication is configurable per envelope."
},
"accessCodeLocked": {
"type": "string",
"description": "When **true,** the `accessCode` property is locked and cannot be edited."
},
"accessCodeRequired": {
"type": "string",
"description": "When **true,** the recipient must enter the `accessCode` to access the PowerForm."
},
"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."
},
"templateRequiresIdLookup": {
"type": "string",
"description": "When **true,** the template used to create the PowerForm requires ID lookup for the recipient."
}
},
"description": "**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.",
"x-ms-summary": "**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.",
"x-ds-definition-name": "powerFormRecipient"
}
powerFormSendersResponse
{
"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. "
},
"endPosition": {
"type": "integer",
"format": "int32",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "integer",
"format": "int32",
"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": "integer",
"format": "int32",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "integer",
"format": "int32",
"description": "The starting index position of the current result set."
},
"powerFormSenders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "An array of `userInfo` objects containing information about users who have sent PowerForms."
}
},
"description": "This object includes information about the users who have sent PowerForms.",
"x-ms-summary": "This object includes information about the users who have sent PowerForms.",
"x-ds-definition-name": "powerFormSendersResponse"
}
powerFormsFormDataResponse
{
"type": "object",
"properties": {
"envelopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerFormFormDataEnvelope"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "powerFormsFormDataResponse"
}
powerFormsRequest
{
"type": "object",
"properties": {
"powerForms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerForm"
},
"description": "An array of PowerForm objects."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "powerFormsRequest"
}
powerFormsResponse
{
"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. "
},
"powerForms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/powerForm"
},
"description": "An array of PowerForm objects."
},
"endPosition": {
"type": "integer",
"format": "int32",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"totalSetSize": {
"type": "integer",
"format": "int32",
"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": "integer",
"format": "int32",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "integer",
"format": "int32",
"description": "The starting index position of the current result set."
}
},
"description": "A list of PowerForms.",
"x-ms-summary": "A list of PowerForms.",
"x-ds-definition-name": "powerFormsResponse"
}
prefillFormData
{
"type": "object",
"properties": {
"formData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/formDataItem"
},
"description": ""
},
"senderName": {
"type": "string",
"description": "The sender's name."
},
"senderEmail": {
"type": "string",
"description": "The sender's email address."
},
"senderUserId": {
"type": "string",
"description": "The ID of the sender."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "prefillFormData"
}
prefillTabs
{
"type": "object",
"properties": {
"ssnTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ssn"
},
"description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"zipTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zip"
},
"description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"dateTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/date"
},
"description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, DocuSign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"textTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/text"
},
"description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"emailTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/email"
},
"description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"tabGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tabGroup"
},
"description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n"
},
"numberTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/number"
},
"description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"checkboxTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/checkbox"
},
"description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"radioGroupTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/radioGroup"
},
"description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
},
"senderNameTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/senderName"
},
"description": ""
},
"senderCompanyTabs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/senderCompany"
},
"description": ""
}
},
"description": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields",
"x-ms-summary": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields",
"x-ds-definition-name": "prefillTabs"
}
propertyMetadata
{
"type": "object",
"properties": {
"rights": {
"type": "string",
"description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of option strings supported by this setting."
}
},
"description": "Metadata about a property.",
"x-ms-summary": "Metadata about a property.",
"x-ds-definition-name": "propertyMetadata"
}
province
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"isoCode": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "province"
}
provisioningInformation
{
"type": "object",
"properties": {
"defaultPlanId": {
"type": "string",
"description": ""
},
"distributorCode": {
"type": "string",
"description": "The code that identifies the billing plan groups and plans for the new account."
},
"passwordRuleText": {
"type": "string",
"description": ""
},
"planPromotionText": {
"type": "string",
"description": ""
},
"defaultConnectionId": {
"type": "string",
"description": ""
},
"distributorPassword": {
"type": "string",
"description": "The password for the `distributorCode`."
},
"purchaseOrderOrPromAllowed": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "provisioningInformation"
}
purchasedEnvelopesInformation
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "The total amount of the purchase."
},
"appName": {
"type": "string",
"description": "The AppName of the client application."
},
"platform": {
"type": "string",
"description": "The Platform of the client application"
},
"quantity": {
"type": "string",
"description": "The quantity of envelopes to add to the account."
},
"productId": {
"type": "string",
"description": "The Product ID from the AppStore."
},
"storeName": {
"type": "string",
"description": "The name of the AppStore."
},
"receiptData": {
"type": "string",
"description": "The encrypted Base64 encoded receipt data."
},
"currencyCode": {
"type": "string",
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase.\n"
},
"transactionId": {
"type": "string",
"description": "Specifies the Transaction ID from the AppStore."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "purchasedEnvelopesInformation"
}
radio
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"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."
},
"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": ""
},
"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."
},
"selected": {
"type": "string",
"description": "When **true,** the radio button is selected."
},
"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"
},
"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"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n"
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"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"
},
"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"
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"selectedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$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"
},
"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"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"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"
},
"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": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://raw.githubusercontent.com) tab.\n",
"x-ms-summary": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://raw.githubusercontent.com) tab.\n",
"x-ds-definition-name": "radio"
}
radioGroup
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Specifies the value of the tab. "
},
"radios": {
"type": "array",
"items": {
"$ref": "#/components/schemas/radio"
},
"description": "Specifies the locations and status for radio buttons that are grouped together."
},
"shared": {
"type": "string",
"description": "When **true,** this custom tab is shared."
},
"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"
},
"groupName": {
"type": "string",
"description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."
},
"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."
},
"requireAll": {
"type": "string",
"description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
},
"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"
},
"originalValue": {
"type": "string",
"description": "The initial value of the tab. "
},
"valueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"sharedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"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"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"groupNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"shareToRecipients": {
"type": "string",
"description": "Reserved for DocuSign."
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"requireAllMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"originalValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"shareToRecipientsMetadata": {
"$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"
},
"requireInitialOnSharedChangeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://raw.githubusercontent.com)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n",
"x-ms-summary": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://raw.githubusercontent.com)\nobjects associated with the group. Only one radio button can\nbe selected in a group.\n",
"x-ds-definition-name": "radioGroup"
}
recipientAdditionalNotification
{
"type": "object",
"properties": {
"phoneNumber": {
"$ref": "#/components/schemas/recipientPhoneNumber"
},
"secondaryDeliveryMethod": {
"type": "string",
"description": "The secondary delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][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/"
},
"secondaryDeliveryStatus": {
"type": "string",
"description": "The status of the delivery. This property is read-only.\n\nOne of:\n\n- `autoresponded`\n- `optedout`\n- `limitreached`\n"
},
"secondaryDeliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "Describes an additional notification method.",
"x-ms-summary": "Describes an additional notification method.",
"x-ds-definition-name": "recipientAdditionalNotification"
}
recipientAttachment
{
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."
},
"name": {
"type": "string",
"description": "The name of the attachment."
},
"label": {
"type": "string",
"description": "An optional label for the attachment."
},
"remoteUrl": {
"type": "string",
"description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads."
},
"attachmentId": {
"type": "string",
"description": "The unique identifier for the attachment."
},
"attachmentType": {
"type": "string",
"description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientAttachment"
}
recipientDomain
{
"type": "object",
"properties": {
"active": {
"type": "string",
"description": ""
},
"domainCode": {
"type": "string",
"description": ""
},
"domainName": {
"type": "string",
"description": ""
},
"recipientDomainId": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientDomain"
}
recipientEmailNotification
{
"type": "object",
"properties": {
"emailBody": {
"type": "string",
"description": "The body of the email message."
},
"emailSubject": {
"type": "string",
"description": "The subject line for the email notification."
},
"emailBodyMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"supportedLanguage": {
"type": "string",
"description": "The language to use for the standard email format and signing view for a recipient.\n\nFor example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** This setting affects only DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nTo retrieve the possible values, use the [Accounts::listSupportedLanguages][ListLang] method.\n\n[ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/\n"
},
"emailSubjectMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"supportedLanguageMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.\n",
"x-ms-summary": "Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.\n",
"x-ds-definition-name": "recipientEmailNotification"
}
recipientEvent
{
"type": "object",
"properties": {
"includeDocuments": {
"type": "string",
"description": "When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."
},
"recipientEventStatusCode": {
"type": "string",
"description": "Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientEvent"
}
recipientFormData
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the recipient."
},
"email": {
"type": "string",
"description": "The recipient's email address."
},
"SentTime": {
"type": "string",
"description": "The date and time the envelope was sent to the recipient."
},
"formData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/formDataItem"
},
"description": "An array of form data objects."
},
"SignedTime": {
"type": "string",
"description": "The date and time the recipient signed the documents."
},
"recipientId": {
"type": "string",
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
},
"DeclinedTime": {
"type": "string",
"description": "The date and time the recipient declined the envelope."
},
"DeliveredTime": {
"type": "string",
"description": "The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientFormData"
}
recipientGroup
{
"type": "object",
"properties": {
"groupName": {
"type": "string",
"description": "The name of the group."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientOption"
},
"description": "An array of recipient objects that provides details about the recipients of the envelope."
},
"groupMessage": {
"type": "string",
"description": "The group message, typically a description of the group."
}
},
"description": "Describes a group of recipients.",
"x-ms-summary": "Describes a group of recipients.",
"x-ds-definition-name": "recipientGroup"
}
recipientIdentityInputOption
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"valueType": {
"type": "string",
"description": ""
},
"phoneNumberList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientIdentityPhoneNumber"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientIdentityInputOption"
}
recipientIdentityPhoneNumber
{
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`."
},
"extension": {
"type": "string",
"description": "The telephone extension, if any."
},
"countryCode": {
"type": "string",
"description": "The numeric country calling code for the phone number. For example, the country calling code for the US and Canada is 1. For the UK, the country calling code is 44.\n\nDo not include the + symbol."
},
"numberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"countryCodeLock": {
"type": "string",
"description": ""
},
"extensionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"countryCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientIdentityPhoneNumber"
}
recipientIdentityVerification
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"description": "ID of the Identity Verification worklow used to verify recipients' identity.\n\nThis ID must match one of the [workflowId](https://raw.githubusercontent.com) available to your account."
},
"inputOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientIdentityInputOption"
},
"description": ""
},
"workflowLabel": {
"type": "string",
"description": ""
},
"workflowIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](https://raw.githubusercontent.com)\nmethod in the [IdentityVerifications](https://raw.githubusercontent.com) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.",
"x-ms-summary": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](https://raw.githubusercontent.com)\nmethod in the [IdentityVerifications](https://raw.githubusercontent.com) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.",
"x-ds-definition-name": "recipientIdentityVerification"
}
recipientNamesResponse
{
"type": "object",
"properties": {
"multipleUsers": {
"type": "string",
"description": "When **true,** the email address is used by more than one user."
},
"recipientNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The names of the recipients associated with the email address."
},
"reservedRecipientEmail": {
"type": "string",
"description": "When **true,** new names cannot be added to the email address."
}
},
"description": "This response object contains a list of recipients.",
"x-ms-summary": "This response object contains a list of recipients.",
"x-ds-definition-name": "recipientNamesResponse"
}
recipientOption
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full legal name of the recipient. Maximum length: 100 characters."
},
"email": {
"type": "string",
"description": "The email ID of the agent. This property is required. Maximum length: 100 characters."
},
"roleName": {
"type": "string",
"description": "Specifies the signing group role of the recipient. This property is required."
},
"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"
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
}
},
"description": "Describes a recipient who is a member of a conditional group.",
"x-ms-summary": "Describes a recipient who is a member of a conditional group.",
"x-ds-definition-name": "recipientOption"
}
recipientPhoneAuthentication
{
"type": "object",
"properties": {
"recordVoicePrint": {
"type": "string",
"description": "Reserved for DocuSign."
},
"recipMayProvideNumber": {
"type": "string",
"description": "Boolean. When **true,** the recipient can supply a phone number their choice."
},
"senderProvidedNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. "
},
"recordVoicePrintMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validateRecipProvidedNumber": {
"type": "string",
"description": " Reserved for DocuSign."
},
"recipMayProvideNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"senderProvidedNumbersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"validateRecipProvidedNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.",
"x-ms-summary": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.",
"x-ds-definition-name": "recipientPhoneAuthentication"
}
recipientPhoneNumber
{
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`."
},
"countryCode": {
"type": "string",
"description": "The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`,\n\nDo not include the `+` symbol."
},
"numberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"countryCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "Describes the recipient phone number.",
"x-ms-summary": "Describes the recipient phone number.",
"x-ds-definition-name": "recipientPhoneNumber"
}
recipientPreviewRequest
{
"type": "object",
"properties": {
"pingUrl": {
"type": "string",
"description": "The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received."
},
"returnUrl": {
"type": "string",
"description": "This property is not supported."
},
"clientURLs": {
"$ref": "#/components/schemas/recipientTokenClientURLs"
},
"assertionId": {
"type": "string",
"description": "A unique identifier of the authentication event executed by the client application."
},
"recipientId": {
"type": "string",
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
},
"pingFrequency": {
"type": "string",
"description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds."
},
"xFrameOptions": {
"type": "string",
"description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property."
},
"securityDomain": {
"type": "string",
"description": "The domain in which the user authenticated."
},
"authenticationMethod": {
"type": "string",
"description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion."
},
"authenticationInstant": {
"type": "string",
"description": "A sender-generated value that indicates the date and time that the signer was authenticated."
},
"xFrameOptionsAllowFromUrl": {
"type": "string",
"description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property."
}
},
"description": "This request object contains the information necessary to create a recipient preview.",
"x-ms-summary": "This request object contains the information necessary to create a recipient preview.",
"x-ds-definition-name": "recipientPreviewRequest"
}
recipientProofFile
{
"type": "object",
"properties": {
"isInProofFile": {
"type": "string",
"description": "Indicates whether a proof file is available for this recipient."
},
"hasIdentityAttempts": {
"type": "string",
"description": ""
}
},
"description": "The proof file of the recipient. [ID Evidence](https://raw.githubusercontent.com) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://raw.githubusercontent.com)",
"x-ms-summary": "The proof file of the recipient. [ID Evidence](https://raw.githubusercontent.com) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://raw.githubusercontent.com)",
"x-ds-definition-name": "recipientProofFile"
}
recipientRouting
{
"type": "object",
"properties": {
"rules": {
"$ref": "#/components/schemas/recipientRules"
}
},
"description": "Describes the recipient routing rules.",
"x-ms-summary": "Describes the recipient routing rules.",
"x-ds-definition-name": "recipientRouting"
}
recipientRules
{
"type": "object",
"properties": {
"conditionalRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conditionalRecipientRule"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientRules"
}
recipientSMSAuthentication
{
"type": "object",
"properties": {
"senderProvidedNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. "
},
"senderProvidedNumbersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.",
"x-ms-summary": "Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.",
"x-ds-definition-name": "recipientSMSAuthentication"
}
recipientSignatureInformation
{
"type": "object",
"properties": {
"fontStyle": {
"type": "string",
"description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n"
},
"signatureName": {
"type": "string",
"description": "Specifies the user's signature name."
},
"signatureInitials": {
"type": "string",
"description": "Specifies the user's signature in initials format."
}
},
"description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.",
"x-ms-summary": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.",
"x-ds-definition-name": "recipientSignatureInformation"
}
recipientSignatureProvider
{
"type": "object",
"properties": {
"sealName": {
"type": "string",
"description": "Indicates the name of the electronic seal to apply on documents.\n"
},
"signatureProviderName": {
"type": "string",
"description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://raw.githubusercontent.com). You can also retrieve the list by using the [AccountSignatureProviders: List](https://raw.githubusercontent.com) method.\n\nExample: `universalsignaturepen_default`\n\n"
},
"signatureProviderOptions": {
"$ref": "#/components/schemas/recipientSignatureProviderOptions"
},
"sealDocumentsWithTabsOnly": {
"type": "string",
"description": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. "
},
"signatureProviderNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://raw.githubusercontent.com).\n",
"x-ms-summary": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://raw.githubusercontent.com).\n",
"x-ds-definition-name": "recipientSignatureProvider"
}
recipientSignatureProviderOptions
{
"type": "object",
"properties": {
"sms": {
"type": "string",
"description": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."
},
"cpfNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signerRole": {
"type": "string",
"description": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc."
},
"smsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"oneTimePassword": {
"type": "string",
"description": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field."
},
"cpfNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signerRoleMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"oneTimePasswordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://raw.githubusercontent.com)",
"x-ms-summary": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://raw.githubusercontent.com)",
"x-ds-definition-name": "recipientSignatureProviderOptions"
}
recipientTokenClientURLs
{
"type": "object",
"properties": {
"onCancel": {
"type": "string",
"description": ""
},
"onDecline": {
"type": "string",
"description": ""
},
"onException": {
"type": "string",
"description": ""
},
"onFaxPending": {
"type": "string",
"description": ""
},
"onTTLExpired": {
"type": "string",
"description": ""
},
"onIdCheckFailed": {
"type": "string",
"description": ""
},
"onSessionTimeout": {
"type": "string",
"description": ""
},
"onSigningComplete": {
"type": "string",
"description": ""
},
"onViewingComplete": {
"type": "string",
"description": ""
},
"onAccessCodeFailed": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "recipientTokenClientURLs"
}
recipientUpdateResponse
{
"type": "object",
"properties": {
"tabs": {
"$ref": "#/components/schemas/EnvelopeRecipientTabs"
},
"combined": {
"type": "string",
"description": "When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When **true,** it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order."
},
"recipientId": {
"type": "string",
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"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."
}
},
"description": "The recipient details that are returned after you update the recipient.",
"x-ms-summary": "The recipient details that are returned after you update the recipient.",
"x-ds-definition-name": "recipientUpdateResponse"
}
recipientViewRequest
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient."
},
"userId": {
"type": "string",
"description": "The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. \n\nIf `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. \n\nIf a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user."
},
"pingUrl": {
"type": "string",
"description": "The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received."
},
"userName": {
"type": "string",
"description": "The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient."
},
"returnUrl": {
"type": "string",
"description": "(Required) The URL to which the user should be redirected\nafter the signing session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\n\nWhen DocuSign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n* `access_code_failed`: Recipient used incorrect access code.\n* `cancel`: Recipient canceled the signing operation,\n possibly by using the **Finish Later** option.\n* `decline`: Recipient declined to sign.\n* `exception`: A system error occurred during the signing process.\n* `fax_pending`: Recipient has a fax pending.\n* `id_check_failed`: Recipient failed an ID check.\n* `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option.\n* `signing_complete`: The recipient completed the signing ceremony.\n* `ttl_expired`: The Time To Live token for the envelope has expired.\n After being successfully invoked, these tokens expire\n after five minutes.\n* `viewing_complete`: The recipient completed viewing an envelope\n that is in a read-only/terminal state,\n such as completed, declined, or voided.\n\n"
},
"clientURLs": {
"$ref": "#/components/schemas/recipientTokenClientURLs"
},
"assertionId": {
"type": "string",
"description": "A unique identifier of the authentication event executed by the client application."
},
"recipientId": {
"type": "string",
"description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
},
"clientUserId": {
"type": "string",
"description": "A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.\n\nUse your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.\n\nMaximum length: 100 characters."
},
"pingFrequency": {
"type": "string",
"description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds."
},
"xFrameOptions": {
"type": "string",
"description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property."
},
"frameAncestors": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"messageOrigins": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"securityDomain": {
"type": "string",
"description": "The domain in which the user authenticated."
},
"authenticationMethod": {
"type": "string",
"description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion."
},
"authenticationInstant": {
"type": "string",
"description": "A sender-generated value that indicates the date and time that the signer was authenticated."
},
"xFrameOptionsAllowFromUrl": {
"type": "string",
"description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property."
}
},
"description": "The request body for the [EnvelopeViews: createRecipient](https://raw.githubusercontent.com)\nand\n[EnvelopeViews: createSharedRecipient](https://raw.githubusercontent.com) methods.",
"x-ms-summary": "The request body for the [EnvelopeViews: createRecipient](https://raw.githubusercontent.com)\nand\n[EnvelopeViews: createSharedRecipient](https://raw.githubusercontent.com) methods.",
"x-ds-definition-name": "recipientViewRequest"
}
recipients
{
"type": "object",
"properties": {
"seals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sealSign"
},
"description": "A list of electronic seals to apply to documents."
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agent"
},
"description": "A list of agent recipients assigned to the documents."
},
"editors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/editor"
},
"description": "A list of users who can edit the envelope."
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signer"
},
"description": "A list of signers on the envelope."
},
"notaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/notaryRecipient"
},
"description": "A list of notary recipients on the envelope."
},
"witnesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/witness"
},
"description": "A list of signers who act as witnesses on the envelope."
},
"carbonCopies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/carbonCopy"
},
"description": "A list of carbon copy recipients assigned to the documents."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/participant"
},
"description": ""
},
"intermediaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/intermediary"
},
"description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
},
"recipientCount": {
"type": "string",
"description": "The number of recipients in the envelope."
},
"inPersonSigners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inPersonSigner"
},
"description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
},
"certifiedDeliveries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/certifiedDelivery"
},
"description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
},
"currentRoutingOrder": {
"type": "string",
"description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
}
},
"description": "Specifies the envelope recipients.",
"x-ms-summary": "Specifies the envelope recipients.",
"x-ds-definition-name": "recipients"
}
recipientsUpdateSummary
{
"type": "object",
"properties": {
"recipientUpdateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientUpdateResponse"
},
"description": "An array of `recipientUpdateResults` objects that contain details about the recipients."
}
},
"description": "This is the response that the API returns after you update recipients.",
"x-ms-summary": "This is the response that the API returns after you update recipients.",
"x-ds-definition-name": "recipientsUpdateSummary"
}
referralInformation
{
"type": "object",
"properties": {
"idType": {
"type": "string",
"description": ""
},
"industry": {
"type": "string",
"description": "The name of the industry associated with the referral. \n\nExample: `Accounting`"
},
"promoCode": {
"type": "string",
"description": ""
},
"shopperId": {
"type": "string",
"description": ""
},
"publisherId": {
"type": "string",
"description": ""
},
"referralCode": {
"type": "string",
"description": ""
},
"referrerName": {
"type": "string",
"description": "The name of the referrer."
},
"enableSupport": {
"type": "string",
"description": "When **true,** customer support is provided as part of the account plan."
},
"externalOrgId": {
"type": "string",
"description": "An optional external ID for the referral."
},
"groupMemberId": {
"type": "string",
"description": ""
},
"includedSeats": {
"type": "string",
"description": "The number of seats (users) included in the plan."
},
"planStartMonth": {
"type": "string",
"description": ""
},
"advertisementId": {
"type": "string",
"description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.\n"
},
"saleDiscountAmount": {
"type": "string",
"description": "Reserved for DocuSign."
},
"saleDiscountPercent": {
"type": "string",
"description": "Reserved for DocuSign."
},
"saleDiscountPeriods": {
"type": "string",
"description": "Reserved for DocuSign."
},
"saleDiscountFixedAmount": {
"type": "string",
"description": "Reserved for DocuSign."
},
"saleDiscountSeatPriceOverride": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.",
"x-ms-summary": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.",
"x-ds-definition-name": "referralInformation"
}
reminders
{
"type": "object",
"properties": {
"reminderDelay": {
"type": "string",
"description": "An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0."
},
"reminderEnabled": {
"type": "string",
"description": "When **true,** reminders are enabled. The default value is **false.**"
},
"reminderFrequency": {
"type": "string",
"description": "An integer specifying the interval in days between reminder emails. The default value is 0."
}
},
"description": "A complex element that specifies reminder settings for the envelope.",
"x-ms-summary": "A complex element that specifies reminder settings for the envelope.",
"x-ds-definition-name": "reminders"
}
resourceInformation
{
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "resourceInformation"
}
returnUrlRequest
{
"type": "object",
"properties": {
"returnUrl": {
"type": "string",
"description": "The URL to which the user should be redirected after the editing session is complete. It must be an absolute URL (e.g. `https://www.example.com` not `www.example.com`).\n\nThe maximum length is 470 characters. If the value exceeds this limit, the user is redirected to a truncated URL.\n\n**Note:** If this property is not provided, the user will have full access to the sending account.\n"
}
},
"description": "The request body for the [TemplateViews: createEdit](https://raw.githubusercontent.com) method.",
"x-ms-summary": "The request body for the [TemplateViews: createEdit](https://raw.githubusercontent.com) method.",
"x-ds-definition-name": "returnUrlRequest"
}
scheduledSending
{
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/envelopeDelayRule"
},
"description": "User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified."
},
"status": {
"type": "string",
"description": "Status of the scheduled sending job. Valid values:\n\n* `pending`: The envelope has not yet been sent and the scheduled sending delay has not been initiated.\n* `started`: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient.\n* `completed`: The delay has elapsed and the envelope has been sent to the first recipient.\n\nThis property is read-only."
},
"bulkListId": {
"type": "string",
"description": "The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation."
},
"resumeDate": {
"type": "string",
"description": "The timestamp of when the envelope is scheduled to be sent in ISO 8601 format.\n\nThis property is read-only.\n"
}
},
"description": "A complex element that specifies the scheduled sending settings for the envelope.",
"x-ms-summary": "A complex element that specifies the scheduled sending settings for the envelope.",
"x-ds-definition-name": "scheduledSending"
}
sealIdentifier
{
"type": "object",
"properties": {
"sealName": {
"type": "string",
"description": "The name of a seal."
},
"sealDisplayName": {
"type": "string",
"description": "The user-friendly display name for a seal."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "sealIdentifier"
}