DocuSign: Esignature schemas (part 21)
74 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Gets account settings information — response body — access Code Format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Object specifying the format of the string provided to a recipient in order to access an envelope. |
formatRequired | string | Optional | Boolean specifying whether this format configuration is required. |
formatRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `formatRequired` property is editable. |
letterRequired | string | Optional | Boolean specifying whether alphabetical characters are required in the access code string. |
letterRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `letterRequired` property is editable. |
minimumLength | string | Optional | Minimum length of the access code string. |
minimumLengthMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `minimumLength` property is editable. |
numberRequired | string | Optional | Boolean specifying whether numerical characters (0-9) are required in the access code string. |
numberRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `numberRequired` property is editable. |
specialCharacterRequired | string | Optional | Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'. |
specialCharacterRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `specialCharacterRequired` property is editable. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — account Notification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies notifications (expirations and reminders) for the envelope. |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
userOverrideEnabled | string | Optional | When **true,** the user can override envelope expirations. |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Gets account settings information — response body — account UI Settings
Referenced models: Gets account settings information — response body — account UI Settings admin Message, Gets account settings information — response body — account UI Settings ask An Admin, Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — account UI Settings admin Message
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
baseMessage | string | Optional | |
moreInformation | string | Optional |
Gets account settings information — response body — account UI Settings ask An Admin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | |
message | string | Optional | |
name | string | Optional | |
phone | string | Optional |
Gets account settings information — response body — additional Settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
name | string | Optional | |
value | string | Optional | Specifies the value of the tab. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — external Document Sources
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object specifying the external document sources. |
boxnetEnabled | string | Optional | The account is enabled to allow external documents to be attached from BoxNet. |
boxnetMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `boxnetEnabled` property is editable. |
dropboxEnabled | string | Optional | The account is enabled to allow external documents to be attached from DropBox. |
dropboxMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `dropboxEnabled` property is editable. |
googleDriveEnabled | string | Optional | The account is enabled to allow external documents to be attached from Google Drive. |
googleDriveMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `googleDriveEnabled` property is editable. |
oneDriveEnabled | string | Optional | The account is enabled to allow external documents to be attached from OneDrive. |
oneDriveMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `oneDriveEnabled` property is editable. |
salesforceEnabled | string | Optional | The account is enabled to allow external documents to be attached from Salesforce. |
salesforceMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `salesforceEnabled` property is editable. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — id Check Configurations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object specifying ID check configuration. |
authSteps | array | Optional | A list of ID check security steps, each specifying an authorization type. |
authSteps[] | Model | Each item | Expand Gets account settings information — response body — id Check Configurations item auth Steps item |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
name | string | Optional | The name of the signature. |
Referenced models: Gets account settings information — response body — id Check Configurations item auth Steps item
Gets account settings information — response body — id Check Configurations item auth Steps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authType | string | Optional | Type of authorization used for the security check. |
Gets account settings information — response body — identity Verification item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies an Identity Verification workflow. |
defaultDescription | string | Optional | Text describing the purpose of the Identity Verification workflow. |
defaultName | string | Optional | The name of the Identity Verification workflow. |
displayOrder | string | Optional | The position on the page where the display section appears. Format: int32 |
inputOptions | array | Optional | |
inputOptions[] | Model | Each item | Expand Gets account settings information — response body — identity Verification item input Options item |
isDisabled | string | Optional | When **true,** the workflow is disabled. |
ownerType | string | Optional | |
signatureProvider | Model | Optional | Expand Gets the available signature providers for an account — response body — signature Providers item The signature provider associated with the Identity Verification workflow. |
workflowId | string | Optional | Workflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification` [core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters) |
workflowLabel | string | Optional | |
workflowResourceKey | string | Optional | Reserved for Docusign. |
Referenced models: Gets account settings information — response body — identity Verification item input Options item, Gets the available signature providers for an account — response body — signature Providers item
Gets account settings information — response body — identity Verification item input Options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isRequired | boolean | Optional | |
optionName | string | Optional | |
valueType | string | Optional |
Gets account settings information — response body — linked External Primary Accounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountName | string | Optional | The name on the account. |
configurationId | string | Optional | |
email | string | Optional | |
exemptMembersOfSameAccountFromAuth | string | Optional | |
linkId | string | Optional | |
pdfFieldHandlingOption | string | Optional | |
pdfFieldHandlingPrefillTabPermission | string | Optional | |
pdfFieldHandlingStandardInputTabPermission | string | Optional | |
pdfFieldHandlingStandardTabPermission | string | Optional | |
recipientAuthRequirements | Model | Optional | Expand Gets account settings information — response body — linked External Primary Accounts item recipient Auth Requirements |
status | string | Optional | Indicates the envelope status. Valid values are: * `sent` - The envelope is sent to the recipients. * `created` - The envelope is saved as a draft and can be modified to be sent later. |
userId | string | Optional | The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. |
Referenced models: Gets account settings information — response body — linked External Primary Accounts item recipient Auth Requirements
Gets account settings information — response body — linked External Primary Accounts item recipient Auth Requirements
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessCode | string | Optional | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. |
idVerification | string | Optional | |
kba | string | Optional | |
phone | string | Optional |
Gets billing payment information for a specific payment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing payment request object. |
amount | string | Optional | The total amount of the purchase. |
description | string | Optional | A sender-defined description of the line item. |
paymentDate | string | Optional | |
paymentId | string | Optional | The ID of the payment. |
paymentNumber | string | Optional | When **true,** a PDF version of the invoice is available. To get the PDF, make the call again and change "Accept:" in the header to "Accept: application/pdf". |
Gets billing plan details — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing plan response object. |
billingPlan | Model | Optional | Expand Gets billing plan details — response body — billing Plan An object that contains details about the billing plan. |
successorPlans | array | Optional | A list of billing plans that the current billing plan can be rolled into. |
successorPlans[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan |
Referenced models: Gets billing plan details — response body — billing Plan
Gets billing plan details — response body — billing Plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a billing plan. |
appStoreProducts | array | Optional | Reserved for Docusign. |
appStoreProducts[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan app Store Products item |
currencyPlanPrices | array | Optional | Contains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set. |
currencyPlanPrices[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan currency Plan Prices item |
enableSupport | string | Optional | When **true,** customer support is provided as part of the account plan. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
otherDiscountPercent | string | Optional | Any other percentage discount for the plan. Example: `"0.00"` |
paymentCycle | string | Optional | The payment cycle associated with the plan. Valid values: Monthly or Annually. |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
perSeatPrice | string | Optional | The per seat price for the plan. |
planClassification | string | Optional | Identifies the type of plan. Examples include: - `business` - `corporate` - `enterprise` - `free` |
planFeatureSets | array | Optional | Reserved for Docusign. |
planFeatureSets[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item |
planId | string | Optional | Docusign's ID for the account plan. |
planName | string | Optional | The name of the billing plan. |
seatDiscounts | array | Optional | A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`. |
seatDiscounts[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan seat Discounts item |
supportIncidentFee | string | Optional | The support incident fee charged for each support incident. Example: `"$0.00"` |
supportPlanFee | string | Optional | The support plan fee charged for this plan. Example: `"$0.00"` |
Referenced models: Gets billing plan details — response body — billing Plan app Store Products item, Gets billing plan details — response body — billing Plan currency Plan Prices item, Get Account Billing Plan — response body — billing Plan plan Feature Sets item, Get Account Billing Plan — response body — billing Plan seat Discounts item
Gets billing plan details — response body — billing Plan app Store Products item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an APP store product. |
marketPlace | string | Optional | |
productId | string | Optional | The Product ID from the AppStore. |
Gets billing plan details — response body — billing Plan currency Plan Prices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
currencySymbol | string | Optional | Specifies the currency symbol. Valid values: - `AED` <br> "د.إ" - `AFN` <br> "؋" - `ALL` <br> "L" - `AMD` <br> "֏" - `ANG` <br> "ƒ" - `AOA` <br> "Kz" - `ARS` <br> "$" - `AUD` <br> "$" - `AWG` <br> "ƒ" - `AZN` <br> "₼" - `BAM` <br> "KM" - `BBD` <br> "$" - `BDT` <br> "৳" - `BGN` <br> "лв" - `BHD` <br> ".د.ب" - `BIF` <br> "FBu" - `BMD` <br> "$" - `BND` <br> "$" - `BOB` <br> "$b" - `BOV` <br> "BOV" - `BRL` <br> "R$" - `BSD` <br> "$" - `BTN` <br> "Nu." - `BWP` <br> "P" - `BYN` <br> "Br" - `BYR` <br> "Br" - `BZD` <br> "BZ$" - `CAD` <br> "$" - `CDF` <br> "FC" - `CHE` <br> "CHE" - `CHF` <br> "CHF" - `CHW` <br> "CHW" - `CLF` <br> "CLF" - `CLP` <br> "$" - `CNY` <br> "¥" - `COP` <br> "$" - `COU` <br> "COU" - `CRC` <br> "₡" - `CUC` <br> "$" - `CUP` <br> "₱" - `CVE` <br> "$" - `CZK` <br> "Kč" - `DJF` <br> "Fdj" - `DKK` <br> "kr" - `DOP` <br> "RD$" - `DZD` <br> "دج" - `EGP` <br> "£" - `ERN` <br> "Nfk" - `ETB` <br> "Br" - `EUR` <br> "€" - `FJD` <br> "$" - `FKP` <br> "£" - `GBP` <br> "£" - `GEL` <br> "₾" - `GHS` <br> "GH₵" - `GIP` <br> "£" - `GMD` <br> "D" - `GNF` <br> "FG" - `GTQ` <br> "Q" - `GYD` <br> "$" - `HKD` <br> "$" - `HNL` <br> "L" - `HRK` <br> "kn" - `HTG` <br> "G" - `HUF` <br> "Ft" - `IDR` <br> "Rp" - `ILS` <br> "₪" - `INR` <br> "₹" - `IQD` <br> "ع.د" - `IRR` <br> "﷼" - `ISK` <br> "kr" - `JMD` <br> "J$" - `JOD` <br> "JD" - `JPY` <br> "¥" - `KES` <br> "KSh" - `KGS` <br> "лв" - `KHR` <br> "៛" - `KMF` <br> "CF" - `KPW` <br> "₩" - `KRW` <br> "₩" - `KWD` <br> "KD" - `KYD` <br> "$" - `KZT` <br> "₸" - `LAK` <br> "₭" - `LBP` <br> "£" - `LKR` <br> "₨" - `LRD` <br> "$" - `LSL` <br> "M" - `LYD` <br> "LD" - `MAD` <br> "MAD" - `MDL` <br> "lei" - `MGA` <br> "Ar" - `MKD` <br> "ден" - `MMK` <br> "K" - `MNT` <br> "₮" - `MOP` <br> "MOP$" - `MRO` <br> "UM" - `MUR` <br> "₨" - `MVR` <br> "Rf" - `MWK` <br> "MK" - `MXN` <br> "$" - `MXV` <br> "MXV" - `MYR` <br> "RM" - `MZN` <br> "MT" - `NAD` <br> "$" - `NGN` <br> "₦" - `NIO` <br> "C$" - `NOK` <br> "kr" - `NPR` <br> "₨" - `NZD` <br> "$" - `OMR` <br> "﷼" - `PAB` <br> "B/." - `PEN` <br> "S/." - `PGK` <br> "K" - `PHP` <br> "₱" - `PKR` <br> "₨" - `PLN` <br> "zł" - `PYG` <br> "Gs" - `QAR` <br> "﷼" - `RON` <br> "lei" - `RSD` <br> "Дин." - `RUB` <br> "₽" - `RWF` <br> "R₣" - `SAR` <br> "﷼" - `SBD` <br> "$" - `SCR` <br> "₨" - `SDG` <br> "ج.س." - `SEK` <br> "kr" - `SGD` <br> "S$" - `SHP` <br> "£" - `SLL` <br> "Le" - `SOS` <br> "S" - `SRD` <br> "$" - `SSP` <br> "£" - `STD` <br> "Db" - `SVC` <br> "$" - `SYP` <br> "£" - `SZL` <br> "E" - `THB` <br> "฿" - `TJS` <br> "SM" - `TMT` <br> "T" - `TND` <br> "د.ت" - `TOP` <br> "T$" - `TRY` <br> "₺" - `TTD` <br> "TT$" - `TWD` <br> "NT$" - `TZS` <br> "TSh" - `UAH` <br> "₴" - `UGX` <br> "USh" - `USD` <br> "$" - `USN` <br> "$" - `UYI` <br> "UYI" - `UYU` <br> "$U" - `UZS` <br> "лв" - `VEF` <br> "Bs" - `VND` <br> "₫" - `VUV` <br> "VT" - `WST` <br> "WS$" - `XAF` <br> "FCFA" - `XAG` <br> "XAG" Silver - `XAU` <br> "XAU" Gold - `XBA` <br> "XBA" Bond Markets Units European Composite Unit (EURCO) - `XBB` <br> "XBB" European Monetary Unit (E.M.U.-6) - `XBC` <br> "XBC" European Unit of Account 9(E.U.A.-9) - `XBD` <br> "XBD" European Unit of Account 17(E.U.A.-17) - `XCD` <br> "$" - `XDR` <br> "XDR" }` <br> // Special Drawing Rights (SDRs)` <br> units of account for IMF - `XOF` <br> "CFA" - `XPD` <br> "XPD" Palladium - `XPF` <br> "₣" - `XPT` <br> "XPT" Platinum - `XSU` <br> "Sucre" - `XTS` <br> "XTS" Reserved for testing purposes - `XUA` <br> "XUA" - `XXX` <br> "XXX" Denotes transaction involving no currency - `YER` <br> "﷼" - `ZAR` <br> "R" - `ZMW` <br> "ZK" - `ZWL` <br> "$" |
perSeatPrice | string | Optional | The per-seat price associated with the plan. Example: `"456.0000"` |
supportIncidentFee | string | Optional | The support incident fee charged for each support incident. Example: `"$0.00"` |
supportPlanFee | string | Optional | The support plan fee charged for this plan. Example: `"$0.00"` |
supportedCardTypes | Model | Optional | Expand Gets billing plan details — response body — billing Plan currency Plan Prices item supported Card Types A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). |
Referenced models: Gets billing plan details — response body — billing Plan currency Plan Prices item supported Card Types
Gets billing plan details — response body — billing Plan currency Plan Prices item supported Card Types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardTypes | array | Optional | An array containing supported credit card types. |
cardTypes[] | string | Each item |
Gets bulk send lists — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user. |
bulkListSummaries | array | Optional | An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user. |
bulkListSummaries[] | Model | Each item | Expand Gets bulk send lists — response body — bulk List Summaries item |
Referenced models: Gets bulk send lists — response body — bulk List Summaries item
Gets bulk send lists — response body — bulk List Summaries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains basic information about a bulk send list. |
bulkSendListId | string | Optional | The GUID of the bulk send list. This property is created after you post a new bulk send list. |
createdByUser | string | Optional | The GUID of the user who created the bulk send list. |
createdDate | string | Optional | The UTC DateTime that the bulk send list was created. |
name | string | Optional | The name of the bulk send list. |
Gets envelope notification defaults — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
apiEmailNotifications | Model | Optional | Expand Gets envelope notification defaults — response body — email Notifications The default notification settings for envelopes sent by using the console. |
emailNotifications | Model | Optional | Expand Gets envelope notification defaults — response body — email Notifications The default notification settings for envelopes sent by using the API. |
Referenced models: Gets envelope notification defaults — response body — email Notifications
Gets envelope notification defaults — response body — email Notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about the default notification settings for the envelope notifications that senders and signers receive. |
senderEmailNotifications | Model | Optional | Expand Gets the user account settings for a specified user — response body — sender Email Notifications An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from Docusign. The user inherits the default account sender email notification settings when the user is created. The email notifications are: * envelopeComplete * changedSigner * senderEnvelopeDeclined * withdrawnConsent * recipientViewed * deliveryFailed |
signerEmailNotifications | Model | Optional | Expand Gets the user account settings for a specified user — response body — signer Email Notifications An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created. |
Referenced models: Gets the user account settings for a specified user — response body — sender Email Notifications, Gets the user account settings for a specified user — response body — signer Email Notifications
Gets envelope notification information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the notification settings for the envelope. |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
useAccountDefaults | string | Optional | When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.** |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Gets envelope notification information — response body — expirations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided. |
expireAfter | string | Optional | An integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.** |
expireEnabled | string | Optional | When **true,** the envelope expires in the number of days set by `expireAfter`. When **false** or not set, the envelope expires in the number of days specified by the [default expiration account setting](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html). |
expireWarn | string | Optional | An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent. |
Gets envelope notification information — response body — reminders
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies reminder settings for the envelope. |
maximumReminderCount | string | Optional | |
reminderDelay | string | Optional | 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 | string | Optional | When **true,** reminders are enabled. The default value is **false.** |
reminderFrequency | string | Optional | An integer specifying the interval in days between reminder emails. The default value is 0. |
smartReminderEnabled | string | Optional |
Gets envelope statuses for a set of envelopes — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Lists of envelope and transaction IDs to use in the results. If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value `request_body`: - `envelope_ids=request_body` - `transaction_ids=request_body` |
envelopeIds | array | Optional | A comma-separated list of envelope IDs to include in the results. |
envelopeIds[] | string | Each item | |
transactionIds | array | Optional | A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days. |
transactionIds[] | string | Each item |
Gets envelope statuses for a set of envelopes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result set for the Envelopes: listStatusChanges method |
continuationToken | string | Optional | Reserved for Docusign. |
endPosition | string | Optional | The last index position in the result set. |
envelopeSearchSource | string | Optional | |
envelopeTransactionStatuses | array | Optional | Array of envelope statuses and transaction IDs in the result set. |
envelopeTransactionStatuses[] | Model | Each item | Expand Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item |
envelopes | array | Optional | Array of envelope information. |
envelopes[] | Model | Each item | Expand Gets the status of a single envelope — response body |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
lastQueriedDateTime | string | Optional | The last time that a query was performed. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | 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 | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Gets the status of a single envelope — response body, Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item, Gets the list of templates — response body — folders item
Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
status | string | Optional | Indicates the envelope status. Valid values are: * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. * `created`: The envelope is created as a draft. It can be modified and sent later. * `declined`: The envelope has been declined by the recipients. * `delivered`: The envelope has been delivered to the recipients. * `sent`: The envelope will be sent to the recipients after the envelope is created. * `signed`: The envelope has been signed by the recipients. * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. |
transactionId | string | Optional | Used to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. |
Referenced models: Locks a template — response body — error Details
Gets envelope transfer rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
envelopeTransferRules | array | Optional | Contains information about a specific envelope transfer rule. |
envelopeTransferRules[] | Model | Each item | Expand Gets envelope transfer rules — response body — envelope Transfer Rules item |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | 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 | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Gets envelope transfer rules — response body — envelope Transfer Rules item
Gets envelope transfer rules — response body — envelope Transfer Rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about an envelope transfer rule. |
carbonCopyOriginalOwner | string | Optional | When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.** |
enabled | string | Optional | When **true,** the envelope transfer rule is active. |
envelopeTransferRuleId | string | Optional | The ID of the envelope transfer rule. The system generates this ID when the rule is first created. |
eventType | string | Optional | The type of envelope event that triggers the transfer. Valid values are: - `sent` - `before sent` - `completed` |
fromGroup | Model | Optional | Expand Deletes an existing user group — response body — groups item Information about the group that triggers the transfer. |
fromUser | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body Information about the user who triggers the transfer. |
modifiedDate | string | Optional | The UTC DateTime when the envelope transfer rule was last modified. This property is read-only. |
modifiedUser | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body Information about the user who last modified the envelope transfer rule. |
toFolder | Model | Optional | Expand Gets the list of templates — response body — folders item Information about the destination folder to which the envelope is transferred. |
toUser | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body Information about the user to which the envelope is transferred. |
Referenced models: Gets the list of templates — response body — folders item, Deletes an existing user group — response body — groups item, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Gets list of recurring and usage charges for the account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing charge response object. |
billingChargeItems | array | Optional | Reserved for Docusign. |
billingChargeItems[] | Model | Each item | Expand Gets list of recurring and usage charges for the account — response body — billing Charge Items item |
Referenced models: Gets list of recurring and usage charges for the account — response body — billing Charge Items item
Gets list of recurring and usage charges for the account — response body — billing Charge Items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a billing charge. |
allowedQuantity | string | Optional | Reserved for Docusign. |
blocked | string | Optional | Reserved for Docusign. |
chargeName | string | Optional | Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | Docusign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | |
chargeType | string | Optional | Reserved for Docusign. |
chargeUnitOfMeasure | string | Optional | Reserved for Docusign. |
discounts | array | Optional | |
discounts[] | Model | Each item | Expand Gets list of recurring and usage charges for the account — response body — billing Charge Items item discounts item |
firstEffectiveDate | string | Optional | |
includedQuantity | string | Optional | |
incrementalQuantity | string | Optional | Reserved for Docusign. |
lastEffectiveDate | string | Optional | |
prices | array | Optional | |
prices[] | Model | Each item | Expand Gets list of recurring and usage charges for the account — response body — billing Charge Items item prices item |
unitPrice | string | Optional | Reserved for Docusign. |
usedQuantity | string | Optional |
Referenced models: Gets list of recurring and usage charges for the account — response body — billing Charge Items item discounts item, Gets list of recurring and usage charges for the account — response body — billing Charge Items item prices item
Gets list of recurring and usage charges for the account — response body — billing Charge Items item discounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
beginQuantity | string | Optional | Reserved for Docusign. |
discount | string | Optional | |
endQuantity | string | Optional |
Gets list of recurring and usage charges for the account — response body — billing Charge Items item prices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
beginQuantity | string | Optional | Reserved for Docusign. |
endQuantity | string | Optional | |
unitPrice | string | Optional | Reserved for Docusign. |
Gets membership account password rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about the password rules for a user. |
passwordRules | Model | Optional | Expand Gets the password rules for an account — response body Contains details about the password rules for the user. |
userId | string | Optional | The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. |
Referenced models: Gets the password rules for an account — response body
Gets notary jurisdictions for a user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
notaryJournals | array | Optional | |
notaryJournals[] | Model | Each item | Expand Gets notary jurisdictions for a user — response body — notary Journals item |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | 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 | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Gets notary jurisdictions for a user — response body — notary Journals item
Gets notary jurisdictions for a user — response body — notary Journals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdDate | string | Optional | The creation date of the account in UTC timedate format. |
documentName | string | Optional | The name of the document. |
jurisdiction | Model | Optional | Expand Creates a jurisdiction object — response body — jurisdiction The notary's jurisdiction. |
notaryJournalId | string | Optional | A unique GUID for this journal entry. |
notaryJournalMetaData | Model | Optional | Expand Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data Additional journal data such as the witness list and signature image. |
signerName | string | Optional | The in-person signer's full legal name. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. |
Referenced models: Creates a jurisdiction object — response body — jurisdiction, Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data
Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comment | string | Optional | A freeform comment that the notary can add to the journal entry. |
credibleWitnesses | array | Optional | An array of witnesses. |
credibleWitnesses[] | Model | Each item | Expand Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item |
signatureImage | string | Optional | A base64-encoded image of the signature. |
signerIdType | string | Optional | A string that describes the ID that the signer presented. For example `drivers license` or `military ID`. |
Referenced models: Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item
Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | string | Optional | The address of the witness. |
name | string | Optional | The name of the witness. |
signatureImage | string | Optional | A base64-encoded image of the signature. |
Gets one or more contacts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This response object contains information about the contacts associated with an account. |
contacts | array | Optional | A list of contacts. |
contacts[] | Model | Each item | Expand Deletes a contact — response body — contacts item |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | 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 | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Deletes a contact — response body — contacts item
Gets payment information for one or more payments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing payments response object. |
billingPayments | array | Optional | Reserved for Docusign. |
billingPayments[] | Model | Each item | Expand Gets billing payment information for a specific payment — response body |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | 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. |
Referenced models: Gets billing payment information for a specific payment — response body
Gets settings for a notary user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a single notary jurisdiction. |
jurisdictions | array | Optional | |
jurisdictions[] | Model | Each item | Expand Creates a jurisdiction object — response body — jurisdiction |
notary | Model | Optional | Expand Registers the current user as a notary — response body |
Referenced models: Creates a jurisdiction object — response body — jurisdiction, Registers the current user as a notary — response body
Gets templates used in an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
templates | array | Optional | An array of `templateSummary` objects that contain information about templates. |
templates[] | Model | Each item | Expand Creates one or more templates — response body |
Referenced models: Creates one or more templates — response body
Gets the API request logging log files — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about multiple API request logs. |
apiRequestLogs | array | Optional | Reserved for Docusign. |
apiRequestLogs[] | Model | Each item | Expand Gets the API request logging log files — response body — api Request Logs item |
Referenced models: Gets the API request logging log files — response body — api Request Logs item
Gets the API request logging log files — response body — api Request Logs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains API request log information. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
description | string | Optional | The API endpoint that was called. |
requestLogId | string | Optional | The ID of the log entry. |
status | string | Optional | The status of the API request. |
Gets the API request logging settings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
apiRequestLogMaxEntries | string | Optional | Specifies the maximum number of API requests to log. |
apiRequestLogRemainingEntries | string | Optional | Indicates the remaining number of API requests that can be logged. |
apiRequestLogging | string | Optional | When **true,** enables API request logging for the user. |
Gets the BCC email archive configurations for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains a list of BCC email archive configurations. |
bccEmailArchives | array | Optional | A list of BCC email archive configurations. |
bccEmailArchives[] | Model | Each item | Expand Creates a BCC email archive configuration — response body |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | 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 | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Creates a BCC email archive configuration — response body
Gets the Connect log — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failures | array | Optional | An array of containing failure information from the Connect failure log. |
failures[] | Model | Each item | Expand Gets a Connect log entry — response body |
logs | array | Optional | A list of Connect general logs. |
logs[] | Model | Each item | Expand Gets a Connect log entry — response body |
totalRecords | string | Optional | The count of records in the log list. |
type | string | Optional | The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` |
Referenced models: Gets a Connect log entry — response body
Gets the Electronic Record and Signature Disclosure for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about account consumer disclosures. |
accountEsignId | string | Optional | The GUID of the account associated with the consumer disclosure. |
allowCDWithdraw | string | Optional | When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.** **Note:** Only Admin users can change this setting. |
allowCDWithdrawMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowCDWithdraw` property is editable. |
changeEmail | string | Optional | If the customer needs to change their email address, this is the email address to which they should the change request. Maximum length: 100 characters. |
changeEmailOther | string | Optional | Other information about the requirements for the user to change their email address. Maximum length: 255 characters. Example: `We do not require any other information from you to change your email address.` |
companyName | string | Optional | Specifies the company name used in the disclosure. The default value is the account name. However, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience. **Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.** |
companyPhone | string | Optional | The phone number of the company associated with the consumer disclosure, as a free-formatted string. |
copyCostPerPage | string | Optional | The cost per page if the customer requests paper copies. Example: `0.0000` |
copyFeeCollectionMethod | string | Optional | Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum length: 255 characters. Example: `We will bill you for any fees at that time, if any.` |
copyRequestEmail | string | Optional | The email address to which the customer should send a request for copies of a document. Maximum length: 100 characters. |
custom | string | Optional | When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.** |
enableEsign | string | Optional | When **true** (default), indicates that eSign is enabled. |
esignAgreement | string | Optional | The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting. |
esignText | string | Optional | The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting. **Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting. |
languageCode | string | Optional | The code for the language version of the disclosure. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`. |
mustAgreeToEsign | string | Optional | When **true,** the recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions. |
pdfId | string | Optional | **Deprecated.** The `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. |
useBrand | string | Optional | When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. When **false** (default), or if the signing brand does not specify a company name, the account name is used instead. **Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. |
useConsumerDisclosureWithinAccount | string | Optional | When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement. |
useConsumerDisclosureWithinAccountMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. |
withdrawAddressLine1 | string | Optional | Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. |
withdrawAddressLine2 | string | Optional | Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. |
withdrawByEmail | string | Optional | When **true** (default), indicates that the customer can withdraw consent by email. |
withdrawByMail | string | Optional | When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.** |
withdrawByPhone | string | Optional | When **true,** indicates that the customer can withdraw consent by phone. The default is **false.** |
withdrawCity | string | Optional | Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. |
withdrawConsequences | string | Optional | Text indicating the consequences of withdrawing consent. Maximum length: 255 characters. |
withdrawEmail | string | Optional | Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. |
withdrawOther | string | Optional | Contains any other information needed to withdraw consent. Maximum length: 255 characters. Example: `We do not need any other information from you to withdraw consent.` |
withdrawPhone | string | Optional | Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string. Maximum length: 20 characters. |
withdrawPostalCode | string | Optional | Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. |
withdrawState | string | Optional | Contains the state of the postal address to which a customer can send a consent withdrawal notification. Example: `PA` |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets the available signature providers for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
signatureProviders | array | Optional | Names of electronic or digital signature providers that can be used. |
signatureProviders[] | Model | Each item | Expand Gets the available signature providers for an account — response body — signature Providers item |
Referenced models: Gets the available signature providers for an account — response body — signature Providers item
Gets the available signature providers for an account — response body — signature Providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers. |
isRequired | string | Optional | Reserved for Docusign. |
priority | string | Optional | Reserved for Docusign. |
signatureProviderDisplayName | string | Optional | Reserved for Docusign. |
signatureProviderId | string | Optional | Reserved for Docusign. |
signatureProviderName | string | Optional | The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method. Example: `universalsignaturepen_default` |
signatureProviderOptionsMetadata | array | Optional | Reserved for Docusign. |
signatureProviderOptionsMetadata[] | Model | Each item | Expand Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item |
signatureProviderRequiredOptions | array | Optional | Reserved for Docusign. |
signatureProviderRequiredOptions[] | Model | Each item | Expand Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item |
Referenced models: Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item, Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item
Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reserved for Docusign. |
signatureProviderOptionDisplayName | string | Optional | Reserved for Docusign. |
signatureProviderOptionHintOverrideValue | string | Optional | |
signatureProviderOptionId | string | Optional | Reserved for Docusign. |
signatureProviderOptionName | string | Optional | Reserved for Docusign. |
signatureProviderOptionRegexValidationPattern | string | Optional |
Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional information that a specific signature provider requires. |
requiredSignatureProviderOptionIds | array | Optional | Reserved for Docusign. |
requiredSignatureProviderOptionIds[] | string | Each item | |
signerType | string | Optional | Reserved for Docusign. |
Gets the custom field information for the specified envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
listCustomFields | array | Optional | An array of list custom fields. |
listCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — list Custom Fields item |
textCustomFields | array | Optional | An array of text custom fields. |
textCustomFields[] | Model | Each item | Expand Gets a list of custom fields — response body — text Custom Fields item |
Referenced models: Gets a list of custom fields — response body — list Custom Fields item, Gets a list of custom fields — response body — text Custom Fields item
Gets the envelope audit events for an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auditEvents | array | Optional | Reserved for Docusign. |
auditEvents[] | Model | Each item | Expand Gets the envelope audit events for an envelope — response body — audit Events item |
Referenced models: Gets the envelope audit events for an envelope — response body — audit Events item
Gets the envelope audit events for an envelope — response body — audit Events item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
eventFields | array | Optional | |
eventFields[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
Referenced models: Updates an existing brand — response body — colors item
Gets the envelope purge configuration for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). |
purgeEnvelopes | string | Optional | When **true,** purging is enabled. |
redactPII | string | Optional | When **true,** the system also redacts personally identifiable information (PII). **Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.** |
removeTabsAndEnvelopeAttachments | string | Optional | When **true,** the system also purges the tabs and attachments associated with the envelopes. |
retentionDays | string | Optional | The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`. |
Gets the list of templates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about templates. |
endPosition | string | Optional | The last index position in the result set. |
envelopeTemplates | array | Optional | The list of requested templates. |
envelopeTemplates[] | Model | Each item | Expand Gets a specific template associated with a specified account — response body |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | 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 | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Gets a specific template associated with a specified account — response body, Gets the list of templates — response body — folders item
Gets the list of templates — response body — folders item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a folder. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
filter | Model | Optional | Expand Gets the list of templates — response body — folders item filter An object used to present a filtered view of the items in a folder. |
folderId | string | Optional | The ID of the folder. |
folderItems | array | Optional | A list of envelopes and templates that the folder contains. |
folderItems[] | Model | Each item | Expand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item |
folders | array | Optional | A collection of folder objects returned in a response. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
hasAccess | string | Optional | When **true,** the current user has access to the folder. |
hasSubFolders | string | Optional | When **true,** the folder has subfolders. |
itemCount | string | Optional | The number of items in the folder. |
name | string | Optional | The name of the folder. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the folder. |
parentFolderId | string | Optional | The ID of the parent folder, or the special value `root` for the root folder. |
parentFolderUri | string | Optional | The URI of the parent folder. |
subFolderCount | string | Optional | The number of subfolders. |
type | string | Optional | The type of folder. Possible values include: - `draft` - `inbox` - `normal` (a system-generated folder) - `recyclebin` - `sentitems` - `custom` (a custom folder created by a user) |
uri | string | Optional | The URI for the folder. |
Referenced models: Locks a template — response body — error Details, Gets the list of templates — response body — folders item filter, Gets the list of templates — response body — folders item, Deprecated. Use Envelopes: list Status Changes — response body — folder Items item, Gets a specific template associated with a specified account — response body — owner
Gets the list of templates — response body — folders item filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Use this object to create a filtered view of the items in a folder. |
actionRequired | string | Optional | When **true,** the current user needs to take action on the item. |
expires | string | Optional | The number of days a sent envelope remains active before it expires. |
folderIds | string | Optional | Filters for any combination of folder IDs and folder types. The possible folder types are: - `awaiting_my_signature` - `completed` - `draft` - `drafts` - `expiring_soon` - `inbox` - `out_for_signature` - `recyclebin` - `sentitems` - `waiting_for_others` |
fromDateTime | string | Optional | The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days. |
isTemplate | string | Optional | When **true,** the item is a template. |
order | string | Optional | The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order. |
orderBy | string | Optional | The field used to sort the results. Example: `Created` |
searchTarget | string | Optional | Reserved for Docusign. |
searchText | string | Optional | A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject. |
status | string | Optional | The status of the envelope. By default, all statuses are returned. For details, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/). |
toDateTime | string | Optional | The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date. |
Gets the password rules for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expirePassword | string | Optional | When **true,** passwords expire. The default value is `false`. |
expirePasswordDays | string | Optional | The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.** |
expirePasswordDaysMetadata | Model | Optional | Expand Gets the password rules for an account — response body — expire Password Days Metadata Metadata that indicates whether the `expirePasswordDays` property is editable. |
lockoutDurationMinutes | string | Optional | The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`. |
lockoutDurationMinutesMetadata | Model | Optional | Expand Gets the password rules for an account — response body — lockout Duration Minutes Metadata Metadata that indicates whether the `lockoutDurationMinutes` property is editable. |
lockoutDurationType | string | Optional | The interval associated with the user lockout after a failed login attempt. Possible values are: - `minutes` (default) - `hours` - `days` |
lockoutDurationTypeMetadata | Model | Optional | Expand Gets the password rules for an account — response body — lockout Duration Type Metadata Metadata that indicates whether the `lockoutDurationType` property is editable. |
minimumPasswordAgeDays | string | Optional | The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`. |
minimumPasswordAgeDaysMetadata | Model | Optional | Expand Gets the password rules for an account — response body — minimum Password Age Days Metadata Metadata that indicates whether the `minimumPasswordAgeDays` property is editable. |
minimumPasswordLength | string | Optional | The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`. |
minimumPasswordLengthMetadata | Model | Optional | Expand Gets the password rules for an account — response body — minimum Password Length Metadata Metadata that indicates whether the `minimumPasswordLength` property is editable. |
passwordIncludeDigit | string | Optional | When **true,** passwords must include a digit. The default value is `false`. |
passwordIncludeDigitOrSpecialCharacter | string | Optional | When **true,** passwords must include either a digit or a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces. |
passwordIncludeLowerCase | string | Optional | When **true,** passwords must include a lowercase letter. The default value is `false`. |
passwordIncludeSpecialCharacter | string | Optional | When **true,** passwords must include a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces. |
passwordIncludeUpperCase | string | Optional | When **true,** passwords must include an uppercase letter. The default value is `false`. |
passwordStrengthType | string | Optional | The type of password strength. Possible values are: - `basic`: The minimum password length is 6 characters with no other password requirements. - `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character. - `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character. - `custom`: This option enables you to customize password requirements, including the following properties: - `minimumPasswordLength` - `minimumPasswordAgeDays` - `passwordIncludeDigit` - `passwordIncludeDigitOrSpecialCharacter` - `passwordIncludeLowerCase` - `passwordIncludeSpecialCharacter` - `passwordIncludeUpperCase` - `questionsRequired` |
passwordStrengthTypeMetadata | Model | Optional | Expand Gets the password rules for an account — response body — password Strength Type Metadata Metadata that indicates whether the `passwordStrengthType` property is editable. |
questionsRequired | string | Optional | The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`. |
questionsRequiredMetadata | Model | Optional | Expand Gets the password rules for an account — response body — questions Required Metadata Metadata that indicates whether the `questionsRequired` property is editable. |
Referenced models: Gets the password rules for an account — response body — minimum Password Length Metadata, Gets the password rules for an account — response body — expire Password Days Metadata, Gets the password rules for an account — response body — lockout Duration Minutes Metadata, Gets the password rules for an account — response body — lockout Duration Type Metadata, Gets the password rules for an account — response body — minimum Password Age Days Metadata, Gets the password rules for an account — response body — questions Required Metadata, Gets the password rules for an account — response body — password Strength Type Metadata
Gets the password rules for an account — response body — expire Password Days Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumDays | string | Optional | |
minimumDays | string | Optional |
Gets the password rules for an account — response body — lockout Duration Minutes Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumMinutes | string | Optional | |
minimumMinutes | string | Optional |
Gets the password rules for an account — response body — lockout Duration Type Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item |
Gets the password rules for an account — response body — minimum Password Age Days Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumAge | string | Optional | |
minimumAge | string | Optional |
Gets the password rules for an account — response body — minimum Password Length Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumLength | string | Optional | The maximum number of entry characters supported by the custom tab. |
minimumLength | string | Optional | Minimum length of the access code string. |
Gets the password rules for an account — response body — password Strength Type Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | array | Optional | An array of option strings supported by this setting. |
options[] | Model | Each item | Expand Gets the password rules for an account — response body — password Strength Type Metadata options item |
Referenced models: Gets the password rules for an account — response body — password Strength Type Metadata options item
Gets the password rules for an account — response body — password Strength Type Metadata options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
minimumLength | string | Optional | Minimum length of the access code string. |
name | string | Optional | |
passwordIncludeDigit | string | Optional | When **true,** passwords must include a digit. The default value is `false`. |
passwordIncludeDigitOrSpecialCharacter | string | Optional | When **true,** passwords must include either a digit or a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces. |
passwordIncludeLowerCase | string | Optional | When **true,** passwords must include a lowercase letter. The default value is `false`. |
passwordIncludeSpecialCharacter | string | Optional | When **true,** passwords must include a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces. |
passwordIncludeUpperCase | string | Optional | When **true,** passwords must include an uppercase letter. The default value is `false`. |
Gets the password rules for an account — response body — questions Required Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password. |
maximumQuestions | string | Optional | The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`. |
minimumQuestions | string | Optional | The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`. |
Gets the status of a single envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accessControlListBase64 | string | Optional | Reserved for Docusign. |
allowComments | string | Optional | When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document. |
allowMarkup | string | Optional | When **true,** the Document Markup feature is enabled. **Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level. |
allowReassign | string | Optional | When **true,** the recipient can redirect an envelope to a more appropriate recipient. |
allowViewHistory | string | Optional | When **true,** recipients can view the history of the envelope. |
anySigner | string | Optional | Deprecated. This feature has been replaced by signing groups. |
asynchronous | string | Optional | When **true,** the envelope is queued for processing and the value of the `status` property is set to `Processing`. Additionally, GET status calls return `Processing` until completed. **Note:** A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the [transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the Connect notification. |
attachmentsUri | string | Optional | Contains a URL for retrieving the attachments that are associated with the envelope. |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
authoritativeCopyDefault | string | Optional | The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`. |
autoNavigation | string | Optional | When **true,** autonavigation is set for the recipient. |
brandId | string | Optional | The ID of the brand. |
brandLock | string | Optional | When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. |
burnDefaultTabData | string | Optional | |
certificateUri | string | Optional | The URI for retrieving certificate information. |
completedDateTime | string | Optional | Specifies the date and time this item was completed. |
copyRecipientData | string | Optional | |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customFields | Model | Optional | Expand Gets a list of custom fields — response body An optional array of strings that enables the sender to provide custom data about the envelope. This information is returned in the envelope status but otherwise not used by Docusign. Each `customField` string can be a maximum of 100 characters. |
customFieldsUri | string | Optional | The URI for retrieving custom fields. |
declinedDateTime | string | Optional | The date and time the recipient declined the document. This property is read-only. |
deletedDateTime | string | Optional | Reserved for Docusign. |
deliveredDateTime | string | Optional | The date and time that the envelope was delivered to the recipient. This property is read-only. |
disableResponsiveDocument | string | Optional | When **true,** responsive documents are disabled for the envelope. |
documentBase64 | string | Optional | The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. |
documentsCombinedUri | string | Optional | The URI for retrieving all of the documents associated with the envelope as a single PDF file. |
documentsUri | string | Optional | The URI for retrieving all of the documents associated with the envelope as separate files. |
emailBlurb | string | Optional | This is the same as the email body. If specified it is included in email body for all envelope recipients. |
emailSettings | Model | Optional | Expand Adds email setting overrides to an envelope — response body A complex type that contains email settings. |
emailSubject | string | Optional | The subject line of the email message that is sent to all recipients. For 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). **Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters. |
enableWetSign | string | Optional | When **true,** the signer is allowed to print the document and sign it on paper. |
enforceSignerVisibility | string | Optional | When **true,** the option selected in the **Document Visibility** section in your account [Sending Settings][sendingsettings] will be enforced for the envelope. See [Fields and Properties][fieldsproperties] for details about document visibility options. Setting `enforceSignerVisibility` to **true** also enables you to omit documents from the specified recipients' envelopes by using the [`excludedDocuments`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_recipients_signers_excludeddocuments) array. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by using the `excludedDocuments` setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are excluded by using the `excludedDocuments` setting. **Note:** To use this functionality, [document visibility][docviz] must be enabled for the account. The document visibility feature is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support][support] or your account manager to find out whether document visibility is available for your production account plan. [docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/ [sendingsettings]: https://admindemo.docusign.com/authenticate?goTo=sending [fieldsproperties]: https://support.docusign.com/s/document-item?rsc_301&bundleId=pik1583277475390&topicId=xgg1583277350154.html [support]: https://support.docusign.com/en/contactSupport# |
envelopeAttachments | array | Optional | An array of attachment objects that provide information about the attachments that are associated with the envelope. |
envelopeAttachments[] | Model | Each item | Expand Updates an envelope attachment in a draft or in-process envelope — request body — body |
envelopeCustomMetadata | Model | Optional | Expand Gets the status of a single envelope — response body — envelope Custom Metadata |
envelopeDocuments | array | Optional | An array containing information about the documents that are included in the envelope. |
envelopeDocuments[] | Model | Each item | Expand Updates a template document — response body |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
envelopeIdStamping | string | Optional | When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed. |
envelopeLocation | string | Optional | Reserved for Docusign. |
envelopeMetadata | Model | Optional | Expand Gets the status of a single envelope — response body — envelope Metadata Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and Docusign eNotary service. |
envelopeUri | string | Optional | The URI for retrieving the envelope or envelopes. |
expireAfter | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
expireDateTime | string | Optional | The date and time that the envelope is set to expire. This value is determined by the `InitialSentDateTime` of the envelope and the `expireAfter` property of the `notification` object. (Note that the `expireAfter` property of the envelope itself is not used.) |
expireEnabled | string | Optional | Not used. Use the [`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations) property in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead. |
externalEnvelopeId | string | Optional | May contain an external identifier for the envelope. |
folders | array | Optional | A list of folder objects. |
folders[] | Model | Each item | Expand Gets the list of templates — response body — folders item |
hasComments | string | Optional | When **true,** indicates that users have added comments to the envelope. |
hasFormDataChanged | string | Optional | When **true,** indicates that the data collected through form fields on a document has changed. |
hasWavFile | string | Optional | When **true,** indicates that a .wav file used for voice authentication is included in the envelope. |
holder | string | Optional | Reserved for Docusign. |
initialSentDateTime | string | Optional | The date and time the envelope was initially sent. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
isDynamicEnvelope | string | Optional | When **true,** indicates that the envelope is a dynamic envelope. |
isSignatureProviderEnvelope | string | Optional | When **true,** indicates that the envelope is a signature-provided envelope. |
isTicketRelatedEnvelope | string | Optional | |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
location | string | Optional | Reserved for Docusign. |
lockInformation | Model | Optional | Expand Locks an envelope — response body Provides lock information about an envelope that a user has locked. |
messageLock | string | Optional | When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. |
notification | Model | Optional | Expand Gets envelope notification information — response body |
notificationUri | string | Optional | The URI for retrieving notifications. |
powerForm | Model | Optional | Expand Creates a new Power Form — response body Information about any PowerForms that are included in the envelope. |
purgeCompletedDate | string | Optional | The date that a purge was completed. |
purgeRequestDate | string | Optional | The date that a purge was requested. |
purgeState | string | Optional | Shows the current purge state for the envelope. Valid values: - `unpurged`: There has been no successful request to purge documents. - `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. - `documents_dequeued`: The envelope documents have been taken out of the purge queue. - `documents_purged`: The envelope documents have been successfully purged. - `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. - `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. - `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted. - `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted. **Related topics** - [Purging documents (eSingature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/) - [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope) |
recipients | Model | Optional | Expand Deletes recipients from an envelope — response body An array of recipient objects that provides details about the recipients of the envelope. |
recipientsLock | string | Optional | When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope. |
recipientsUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve the recipients. |
sender | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the sender of the envelope. |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
signerCanSignOnMobile | string | Optional | When **true,** recipients can sign on a mobile device. **Note:** Only Admin users can change this setting. |
signingLocation | string | Optional | Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. |
status | string | Optional | Indicates the envelope status. Valid values are: * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. * `created`: The envelope is created as a draft. It can be modified and sent later. * `declined`: The envelope has been declined by the recipients. * `delivered`: The envelope has been delivered to the recipients. * `sent`: The envelope will be sent to the recipients after the envelope is created. * `signed`: The envelope has been signed by the recipients. * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. |
statusChangedDateTime | string | Optional | The data and time that the status changed. |
templatesUri | string | Optional | The URI for retrieving the templates. |
transactionId | string | Optional | Used to identify an envelope. The ID is a sender-generated value and is valid in the Docusign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet c onnection was lost before the envelope status was returned. |
uSigState | string | Optional | |
useDisclosure | string | Optional | When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. |
voidedDateTime | string | Optional | The date and time the envelope or template was voided. |
voidedReason | string | Optional | The reason the envelope or template was voided. **Note:** The string is truncated to the first 200 characters. |
workflow | Model | Optional | Expand Returns the workflow definition for a template — response body |
Referenced models: Gets a list of custom fields — response body, Locks an envelope — response body, Deletes recipients from an envelope — response body, Updates an envelope attachment in a draft or in-process envelope — request body — body, Adds email setting overrides to an envelope — response body, Gets the status of a single envelope — response body — envelope Custom Metadata, Updates a template document — response body, Gets the status of a single envelope — response body — envelope Metadata, Gets the list of templates — response body — folders item, Gets envelope notification information — response body, Creates a new Power Form — response body, Gets a specific template associated with a specified account — response body — owner, Returns the workflow definition for a template — response body
Gets the status of a single envelope — response body — envelope Custom Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
envelopeCustomMetadataDetails | array | Optional | |
envelopeCustomMetadataDetails[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
Referenced models: Updates an existing brand — response body — colors item
Gets the status of a single envelope — response body — envelope Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowAdvancedCorrect | string | Optional | Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature. |
allowCorrect | string | Optional | Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information. |
enableSignWithNotary | string | Optional | Specifies if Docusign eNotary service is enabled for the envelope. |
Gets the supported languages for envelope recipients — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of supported languages. |
languages | array | Optional | A list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** Setting a language for a recipient affects only the Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. Example: ``` { "languages": [ { "name": "Arabic (ar)", "value": "ar" }, { "name": "Bulgarian (bg)", "value": "bg" }, . . . } ``` |
languages[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
Referenced models: Updates an existing brand — response body — colors item