Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootObject specifying the format of the string provided to a recipient in order to access an envelope.
formatRequiredstringOptionalBoolean specifying whether this format configuration is required.
formatRequiredMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `formatRequired` property is editable.
letterRequiredstringOptionalBoolean specifying whether alphabetical characters are required in the access code string.
letterRequiredMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `letterRequired` property is editable.
minimumLengthstringOptionalMinimum length of the access code string.
minimumLengthMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `minimumLength` property is editable.
numberRequiredstringOptionalBoolean specifying whether numerical characters (0-9) are required in the access code string.
numberRequiredMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `numberRequired` property is editable.
specialCharacterRequiredstringOptionalBoolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'.
specialCharacterRequiredMetadataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies notifications (expirations and reminders) for the envelope.
expirationsModelOptionalExpand Gets envelope notification information — response body — expirations
A complex element that specifies the expiration settings for the envelope.
remindersModelOptionalExpand Gets envelope notification information — response body — reminders
A complex element that specifies reminder settings for the envelope.
userOverrideEnabledstringOptionalWhen **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

FieldTypePresenceDescription and constraints
$objectRootAn object that defines the options that are available to non-administrators in the UI.
adminMessageModelOptionalExpand Gets account settings information — response body — account UI Settings admin Message
allowUsersToEditSharedAccessstringOptional
allowUsersToEditSharedAccessMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
askAnAdminModelOptionalExpand Gets account settings information — response body — account UI Settings ask An Admin
clickwrapSchemaVersionstringOptional
clickwrapSchemaVersionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
disableWebAppAccessstringOptional
disableWebAppAccessMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableAdminMessagestringOptional
enableAdminMessageMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableEasySignCanUseMultiTemplateApplystringOptional
enableEasySignCanUseMultiTemplateApplyMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableEasySignTemplateUploadstringOptional
enableEasySignTemplateUploadMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableEnvelopeCopyWithDatastringOptional
enableEnvelopeCopyWithDataMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableEnvelopeTypesstringOptional
enableEnvelopeTypesMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableLegacySendflowLinkstringOptional
enableLegacySendflowLinkMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
hasExternalLinkedAccountsstringOptional
hasExternalLinkedAccountsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
hideSendAnEnvelopestringOptional
hideSendAnEnvelopeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
hideUseATemplatestringOptionalWhen **true,** the **Templates** menu is hidden from account users who are not Admins. The default value is **false.**
hideUseATemplateInPreparestringOptional
hideUseATemplateInPrepareMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
hideUseATemplateMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
orderBasedRecipientIdGenerationstringOptional
orderBasedRecipientIdGenerationMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
removeEnvelopeForwardingstringOptional
removeEnvelopeForwardingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
shouldRedactAccessCodestringOptional
shouldRedactAccessCodeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
uploadNewImageToSignOrInitialstringOptional
uploadNewImageToSignOrInitialMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata

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

FieldTypePresenceDescription and constraints
$objectRoot
baseMessagestringOptional
moreInformationstringOptional

Gets account settings information — response body — account UI Settings ask An Admin

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptional
messagestringOptional
namestringOptional
phonestringOptional

Gets account settings information — response body — additional Settings item

FieldTypePresenceDescription and constraints
$objectRoot
metadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
namestringOptional
valuestringOptionalSpecifies 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

FieldTypePresenceDescription and constraints
$objectRootA complex object specifying the external document sources.
boxnetEnabledstringOptionalThe account is enabled to allow external documents to be attached from BoxNet.
boxnetMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `boxnetEnabled` property is editable.
dropboxEnabledstringOptionalThe account is enabled to allow external documents to be attached from DropBox.
dropboxMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `dropboxEnabled` property is editable.
googleDriveEnabledstringOptionalThe account is enabled to allow external documents to be attached from Google Drive.
googleDriveMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `googleDriveEnabled` property is editable.
oneDriveEnabledstringOptionalThe account is enabled to allow external documents to be attached from OneDrive.
oneDriveMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `oneDriveEnabled` property is editable.
salesforceEnabledstringOptionalThe account is enabled to allow external documents to be attached from Salesforce.
salesforceMetadataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootA complex object specifying ID check configuration.
authStepsarrayOptionalA list of ID check security steps, each specifying an authorization type.
authSteps[]ModelEach itemExpand Gets account settings information — response body — id Check Configurations item auth Steps item
isDefaultstringOptionalBoolean that specifies whether the signature is the default signature for the user.
namestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
authTypestringOptionalType of authorization used for the security check.

Gets account settings information — response body — identity Verification item

FieldTypePresenceDescription and constraints
$objectRootSpecifies an Identity Verification workflow.
defaultDescriptionstringOptionalText describing the purpose of the Identity Verification workflow.
defaultNamestringOptionalThe name of the Identity Verification workflow.
displayOrderstringOptionalThe position on the page where the display section appears.
Format: int32
inputOptionsarrayOptional
inputOptions[]ModelEach itemExpand Gets account settings information — response body — identity Verification item input Options item
isDisabledstringOptionalWhen **true,** the workflow is disabled.
ownerTypestringOptional
signatureProviderModelOptionalExpand Gets the available signature providers for an account — response body — signature Providers item
The signature provider associated with the Identity Verification workflow.
workflowIdstringOptionalWorkflow 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)
workflowLabelstringOptional
workflowResourceKeystringOptionalReserved 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

FieldTypePresenceDescription and constraints
$objectRoot
isRequiredbooleanOptional
optionNamestringOptional
valueTypestringOptional

Gets account settings information — response body — linked External Primary Accounts item

FieldTypePresenceDescription and constraints
$objectRoot
accountNamestringOptionalThe name on the account.
configurationIdstringOptional
emailstringOptional
exemptMembersOfSameAccountFromAuthstringOptional
linkIdstringOptional
pdfFieldHandlingOptionstringOptional
pdfFieldHandlingPrefillTabPermissionstringOptional
pdfFieldHandlingStandardInputTabPermissionstringOptional
pdfFieldHandlingStandardTabPermissionstringOptional
recipientAuthRequirementsModelOptionalExpand Gets account settings information — response body — linked External Primary Accounts item recipient Auth Requirements
statusstringOptionalIndicates 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.
userIdstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
accessCodestringOptionalIf 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.
idVerificationstringOptional
kbastringOptional
phonestringOptional

Gets billing payment information for a specific payment — response body

FieldTypePresenceDescription and constraints
$objectRootDefines a billing payment request object.
amountstringOptionalThe total amount of the purchase.
descriptionstringOptionalA sender-defined description of the line item.
paymentDatestringOptional
paymentIdstringOptionalThe ID of the payment.
paymentNumberstringOptionalWhen **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

FieldTypePresenceDescription and constraints
$objectRootDefines a billing plan response object.
billingPlanModelOptionalExpand Gets billing plan details — response body — billing Plan
An object that contains details about the billing plan.
successorPlansarrayOptionalA list of billing plans that the current billing plan can be rolled into.
successorPlans[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains information about a billing plan.
appStoreProductsarrayOptionalReserved for Docusign.
appStoreProducts[]ModelEach itemExpand Gets billing plan details — response body — billing Plan app Store Products item
currencyPlanPricesarrayOptionalContains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set.
currencyPlanPrices[]ModelEach itemExpand Gets billing plan details — response body — billing Plan currency Plan Prices item
enableSupportstringOptionalWhen **true,** customer support is provided as part of the account plan.
includedSeatsstringOptionalThe number of seats (users) included in the plan.
otherDiscountPercentstringOptionalAny other percentage discount for the plan.

Example: `"0.00"`
paymentCyclestringOptionalThe payment cycle associated with the plan. Valid values: Monthly or Annually.
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
perSeatPricestringOptionalThe per seat price for the plan.
planClassificationstringOptionalIdentifies the type of plan. Examples include:

- `business`
- `corporate`
- `enterprise`
- `free`
planFeatureSetsarrayOptionalReserved for Docusign.
planFeatureSets[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan plan Feature Sets item
planIdstringOptionalDocusign's ID for the account plan.
planNamestringOptionalThe name of the billing plan.
seatDiscountsarrayOptionalA complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`.
seatDiscounts[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan seat Discounts item
supportIncidentFeestringOptionalThe support incident fee charged for each support incident.

Example: `"$0.00"`
supportPlanFeestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootContains information about an APP store product.
marketPlacestringOptional
productIdstringOptionalThe Product ID from the AppStore.

Gets billing plan details — response body — billing Plan currency Plan Prices item

FieldTypePresenceDescription and constraints
$objectRoot
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
currencySymbolstringOptionalSpecifies 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> "$"
perSeatPricestringOptionalThe per-seat price associated with the plan.

Example: `"456.0000"`
supportIncidentFeestringOptionalThe support incident fee charged for each support incident.

Example: `"$0.00"`
supportPlanFeestringOptionalThe support plan fee charged for this plan.

Example: `"$0.00"`
supportedCardTypesModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
cardTypesarrayOptionalAn array containing supported credit card types.
cardTypes[]stringEach item

Gets bulk send lists — response body

FieldTypePresenceDescription and constraints
$objectRootThis complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.
bulkListSummariesarrayOptionalAn array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user.
bulkListSummaries[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootThis object contains basic information about a bulk send list.
bulkSendListIdstringOptionalThe GUID of the bulk send list. This property is created after you post a new bulk send list.
createdByUserstringOptionalThe GUID of the user who created the bulk send list.
createdDatestringOptionalThe UTC DateTime that the bulk send list was created.
namestringOptionalThe name of the bulk send list.

Gets envelope notification defaults — response body

FieldTypePresenceDescription and constraints
$objectRoot
apiEmailNotificationsModelOptionalExpand Gets envelope notification defaults — response body — email Notifications
The default notification settings for envelopes sent by using the console.
emailNotificationsModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains details about the default notification settings for the envelope notifications that senders and signers receive.
senderEmailNotificationsModelOptionalExpand 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
signerEmailNotificationsModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies the notification settings for the envelope.
expirationsModelOptionalExpand Gets envelope notification information — response body — expirations
A complex element that specifies the expiration settings for the envelope.
remindersModelOptionalExpand Gets envelope notification information — response body — reminders
A complex element that specifies reminder settings for the envelope.
useAccountDefaultsstringOptionalWhen **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

FieldTypePresenceDescription and constraints
$objectRootA 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.
expireAfterstringOptionalAn integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**
expireEnabledstringOptionalWhen **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).
expireWarnstringOptionalAn 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

FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies reminder settings for the envelope.
maximumReminderCountstringOptional
reminderDelaystringOptionalAn 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.
reminderEnabledstringOptionalWhen **true,** reminders are enabled. The default value is **false.**
reminderFrequencystringOptionalAn integer specifying the interval in days between reminder emails. The default value is 0.
smartReminderEnabledstringOptional

Gets envelope statuses for a set of envelopes — request body — body

FieldTypePresenceDescription and constraints
$objectRootLists 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`
envelopeIdsarrayOptionalA comma-separated list of envelope IDs to include in the results.
envelopeIds[]stringEach item
transactionIdsarrayOptionalA comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days.
transactionIds[]stringEach item

Gets envelope statuses for a set of envelopes — response body

FieldTypePresenceDescription and constraints
$objectRootResult set for the Envelopes: listStatusChanges method
continuationTokenstringOptionalReserved for Docusign.
endPositionstringOptionalThe last index position in the result set.
envelopeSearchSourcestringOptional
envelopeTransactionStatusesarrayOptionalArray of envelope statuses and transaction IDs in the result set.
envelopeTransactionStatuses[]ModelEach itemExpand Gets envelope statuses for a set of envelopes — response body — envelope Transaction Statuses item
envelopesarrayOptionalArray of envelope information.
envelopes[]ModelEach itemExpand Gets the status of a single envelope — response body
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
lastQueriedDateTimestringOptionalThe last time that a query was performed.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
statusstringOptionalIndicates 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.
transactionIdstringOptionalUsed 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

FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
envelopeTransferRulesarrayOptionalContains information about a specific envelope transfer rule.
envelopeTransferRules[]ModelEach itemExpand Gets envelope transfer rules — response body — envelope Transfer Rules item
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThis object contains details about an envelope transfer rule.
carbonCopyOriginalOwnerstringOptionalWhen **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**
enabledstringOptionalWhen **true,** the envelope transfer rule is active.
envelopeTransferRuleIdstringOptionalThe ID of the envelope transfer rule. The system generates this ID when the rule is first created.
eventTypestringOptionalThe type of envelope event that triggers the transfer. Valid values are:

- `sent`
- `before sent`
- `completed`
fromGroupModelOptionalExpand Deletes an existing user group — response body — groups item
Information about the group that triggers the transfer.
fromUserModelOptionalExpand 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.
modifiedDatestringOptionalThe UTC DateTime when the envelope transfer rule was last modified. This property is read-only.
modifiedUserModelOptionalExpand 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.
toFolderModelOptionalExpand Gets the list of templates — response body — folders item
Information about the destination folder to which the envelope is transferred.
toUserModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootDefines a billing charge response object.
billingChargeItemsarrayOptionalReserved for Docusign.
billingChargeItems[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains information about a billing charge.
allowedQuantitystringOptionalReserved for Docusign.
blockedstringOptionalReserved for Docusign.
chargeNamestringOptionalProvides 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 |
chargeTypestringOptionalReserved for Docusign.
chargeUnitOfMeasurestringOptionalReserved for Docusign.
discountsarrayOptional
discounts[]ModelEach itemExpand Gets list of recurring and usage charges for the account — response body — billing Charge Items item discounts item
firstEffectiveDatestringOptional
includedQuantitystringOptional
incrementalQuantitystringOptionalReserved for Docusign.
lastEffectiveDatestringOptional
pricesarrayOptional
prices[]ModelEach itemExpand Gets list of recurring and usage charges for the account — response body — billing Charge Items item prices item
unitPricestringOptionalReserved for Docusign.
usedQuantitystringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
beginQuantitystringOptionalReserved for Docusign.
discountstringOptional
endQuantitystringOptional

Gets list of recurring and usage charges for the account — response body — billing Charge Items item prices item

FieldTypePresenceDescription and constraints
$objectRoot
beginQuantitystringOptionalReserved for Docusign.
endQuantitystringOptional
unitPricestringOptionalReserved for Docusign.

Gets membership account password rules — response body

FieldTypePresenceDescription and constraints
$objectRootContains details about the password rules for a user.
passwordRulesModelOptionalExpand Gets the password rules for an account — response body
Contains details about the password rules for the user.
userIdstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
notaryJournalsarrayOptional
notaryJournals[]ModelEach itemExpand Gets notary jurisdictions for a user — response body — notary Journals item
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
createdDatestringOptionalThe creation date of the account in UTC timedate format.
documentNamestringOptionalThe name of the document.
jurisdictionModelOptionalExpand Creates a jurisdiction object — response body — jurisdiction
The notary's jurisdiction.
notaryJournalIdstringOptionalA unique GUID for this journal entry.
notaryJournalMetaDataModelOptionalExpand 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.
signerNamestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
commentstringOptionalA freeform comment that the notary can add to the journal entry.
credibleWitnessesarrayOptionalAn array of witnesses.
credibleWitnesses[]ModelEach itemExpand Gets notary jurisdictions for a user — response body — notary Journals item notary Journal Meta Data credible Witnesses item
signatureImagestringOptionalA base64-encoded image of the signature.
signerIdTypestringOptionalA 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

FieldTypePresenceDescription and constraints
$objectRoot
addressstringOptionalThe address of the witness.
namestringOptionalThe name of the witness.
signatureImagestringOptionalA base64-encoded image of the signature.

Gets one or more contacts — response body

FieldTypePresenceDescription and constraints
$objectRootThis response object contains information about the contacts associated with an account.
contactsarrayOptionalA list of contacts.
contacts[]ModelEach itemExpand Deletes a contact — response body — contacts item
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootDefines a billing payments response object.
billingPaymentsarrayOptionalReserved for Docusign.
billingPayments[]ModelEach itemExpand Gets billing payment information for a specific payment — response body
nextUristringOptionalThe 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.
previousUristringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootDescribes a single notary jurisdiction.
jurisdictionsarrayOptional
jurisdictions[]ModelEach itemExpand Creates a jurisdiction object — response body — jurisdiction
notaryModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
templatesarrayOptionalAn array of `templateSummary` objects that contain information about templates.
templates[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains information about multiple API request logs.
apiRequestLogsarrayOptionalReserved for Docusign.
apiRequestLogs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains API request log information.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
descriptionstringOptionalThe API endpoint that was called.
requestLogIdstringOptionalThe ID of the log entry.
statusstringOptionalThe status of the API request.

Gets the API request logging settings — response body

FieldTypePresenceDescription and constraints
$objectRoot
apiRequestLogMaxEntriesstringOptionalSpecifies the maximum number of API requests to log.
apiRequestLogRemainingEntriesstringOptionalIndicates the remaining number of API requests that can be logged.
apiRequestLoggingstringOptionalWhen **true,** enables API request logging for the user.

Gets the BCC email archive configurations for an account — response body

FieldTypePresenceDescription and constraints
$objectRootContains a list of BCC email archive configurations.
bccEmailArchivesarrayOptionalA list of BCC email archive configurations.
bccEmailArchives[]ModelEach itemExpand Creates a BCC email archive configuration — response body
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
failuresarrayOptionalAn array of containing failure information from the Connect failure log.
failures[]ModelEach itemExpand Gets a Connect log entry — response body
logsarrayOptionalA list of Connect general logs.
logs[]ModelEach itemExpand Gets a Connect log entry — response body
totalRecordsstringOptionalThe count of records in the log list.
typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootDetails about account consumer disclosures.
accountEsignIdstringOptionalThe GUID of the account associated with the consumer disclosure.
allowCDWithdrawstringOptionalWhen **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.
allowCDWithdrawMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `allowCDWithdraw` property is editable.
changeEmailstringOptionalIf the customer needs to change their email address, this is the email address to which they should the change request.

Maximum length: 100 characters.
changeEmailOtherstringOptionalOther 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.`
companyNamestringOptionalSpecifies 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.**
companyPhonestringOptionalThe phone number of the company associated with the consumer disclosure, as a free-formatted string.
copyCostPerPagestringOptionalThe cost per page if the customer requests paper copies.

Example:

`0.0000`
copyFeeCollectionMethodstringOptionalSpecifies 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.`
copyRequestEmailstringOptionalThe email address to which the customer should send a request for copies of a document.

Maximum length: 100 characters.
customstringOptionalWhen **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**
enableEsignstringOptionalWhen **true** (default), indicates that eSign is enabled.
esignAgreementstringOptionalThe 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.
esignTextstringOptionalThe 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.
languageCodestringOptionalThe 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`.
mustAgreeToEsignstringOptionalWhen **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.
pdfIdstringOptional**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.
useBrandstringOptionalWhen **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.
useConsumerDisclosureWithinAccountstringOptionalWhen **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
useConsumerDisclosureWithinAccountMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.
withdrawAddressLine1stringOptionalContains the first address line of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.
withdrawAddressLine2stringOptionalContains the second address line of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.
withdrawByEmailstringOptionalWhen **true** (default), indicates that the customer can withdraw consent by email.
withdrawByMailstringOptionalWhen **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**
withdrawByPhonestringOptionalWhen **true,** indicates that the customer can withdraw consent by phone. The default is **false.**
withdrawCitystringOptionalContains the city of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 50 characters.
withdrawConsequencesstringOptionalText indicating the consequences of withdrawing consent.

Maximum length: 255 characters.
withdrawEmailstringOptionalContains the email address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.
withdrawOtherstringOptionalContains any other information needed to withdraw consent.

Maximum length: 255 characters.

Example:

`We do not need any other information from you to withdraw consent.`
withdrawPhonestringOptionalContains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.

Maximum length: 20 characters.
withdrawPostalCodestringOptionalContains the postal code of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 20 characters.
withdrawStatestringOptionalContains 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

FieldTypePresenceDescription and constraints
$objectRoot
signatureProvidersarrayOptionalNames of electronic or digital signature providers that can be used.
signatureProviders[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains information about the signature provider associated with the Identity Verification workflow.
If empty, then this specific workflow is not intended for signers.
isRequiredstringOptionalReserved for Docusign.
prioritystringOptionalReserved for Docusign.
signatureProviderDisplayNamestringOptionalReserved for Docusign.
signatureProviderIdstringOptionalReserved for Docusign.
signatureProviderNamestringOptionalThe 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`

signatureProviderOptionsMetadataarrayOptionalReserved for Docusign.
signatureProviderOptionsMetadata[]ModelEach itemExpand Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item
signatureProviderRequiredOptionsarrayOptionalReserved for Docusign.
signatureProviderRequiredOptions[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootReserved for Docusign.
signatureProviderOptionDisplayNamestringOptionalReserved for Docusign.
signatureProviderOptionHintOverrideValuestringOptional
signatureProviderOptionIdstringOptionalReserved for Docusign.
signatureProviderOptionNamestringOptionalReserved for Docusign.
signatureProviderOptionRegexValidationPatternstringOptional

Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item

FieldTypePresenceDescription and constraints
$objectRootContains additional information that a specific signature provider requires.
requiredSignatureProviderOptionIdsarrayOptionalReserved for Docusign.
requiredSignatureProviderOptionIds[]stringEach item
signerTypestringOptionalReserved for Docusign.

Gets the custom field information for the specified envelope — response body

FieldTypePresenceDescription and constraints
$objectRoot
listCustomFieldsarrayOptionalAn array of list custom fields.
listCustomFields[]ModelEach itemExpand Gets a list of custom fields — response body — list Custom Fields item
textCustomFieldsarrayOptionalAn array of text custom fields.
textCustomFields[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
auditEventsarrayOptionalReserved for Docusign.
auditEvents[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
eventFieldsarrayOptional
eventFields[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootContains 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`).
purgeEnvelopesstringOptionalWhen **true,** purging is enabled.
redactPIIstringOptionalWhen **true,** the system also redacts personally identifiable information (PII).

**Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.**
removeTabsAndEnvelopeAttachmentsstringOptionalWhen **true,** the system also purges the tabs and attachments associated with the envelopes.
retentionDaysstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootInformation about templates.
endPositionstringOptionalThe last index position in the result set.
envelopeTemplatesarrayOptionalThe list of requested templates.
envelopeTemplates[]ModelEach itemExpand Gets a specific template associated with a specified account — response body
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a folder.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
filterModelOptionalExpand Gets the list of templates — response body — folders item filter
An object used to present a filtered view of the items in a folder.
folderIdstringOptionalThe ID of the folder.
folderItemsarrayOptionalA list of envelopes and templates that the folder contains.
folderItems[]ModelEach itemExpand Deprecated. Use Envelopes: list Status Changes — response body — folder Items item
foldersarrayOptionalA collection of folder objects returned in a response.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
hasAccessstringOptionalWhen **true,** the current user has access to the folder.
hasSubFoldersstringOptionalWhen **true,** the folder has subfolders.
itemCountstringOptionalThe number of items in the folder.
namestringOptionalThe name of the folder.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the folder.
parentFolderIdstringOptionalThe ID of the parent folder, or the special value `root` for the root folder.
parentFolderUristringOptionalThe URI of the parent folder.
subFolderCountstringOptionalThe number of subfolders.
typestringOptionalThe type of folder. Possible values include:

- `draft`
- `inbox`
- `normal` (a system-generated folder)
- `recyclebin`
- `sentitems`
- `custom` (a custom folder created by a user)
uristringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootUse this object to create a filtered view of the items in a folder.
actionRequiredstringOptionalWhen **true,** the current user needs to take action on the item.
expiresstringOptionalThe number of days a sent envelope remains active before it expires.
folderIdsstringOptionalFilters 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`
fromDateTimestringOptionalThe UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days.
isTemplatestringOptionalWhen **true,** the item is a template.
orderstringOptionalThe order in which to sort the results.

Valid values are:


* `asc`: Ascending order.
* `desc`: Descending order.
orderBystringOptionalThe field used to sort the results.

Example: `Created`
searchTargetstringOptionalReserved for Docusign.
searchTextstringOptionalA 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.
statusstringOptionalThe 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/).
toDateTimestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
expirePasswordstringOptionalWhen **true,** passwords expire. The default value is `false`.
expirePasswordDaysstringOptionalThe number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**
expirePasswordDaysMetadataModelOptionalExpand Gets the password rules for an account — response body — expire Password Days Metadata
Metadata that indicates whether the `expirePasswordDays` property is editable.
lockoutDurationMinutesstringOptionalThe number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`.
lockoutDurationMinutesMetadataModelOptionalExpand Gets the password rules for an account — response body — lockout Duration Minutes Metadata
Metadata that indicates whether the `lockoutDurationMinutes` property is editable.
lockoutDurationTypestringOptionalThe interval associated with the user lockout after a failed login attempt.

Possible values are:

- `minutes` (default)
- `hours`
- `days`
lockoutDurationTypeMetadataModelOptionalExpand Gets the password rules for an account — response body — lockout Duration Type Metadata
Metadata that indicates whether the `lockoutDurationType` property is editable.
minimumPasswordAgeDaysstringOptionalThe 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`.
minimumPasswordAgeDaysMetadataModelOptionalExpand Gets the password rules for an account — response body — minimum Password Age Days Metadata
Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.
minimumPasswordLengthstringOptionalThe minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`.
minimumPasswordLengthMetadataModelOptionalExpand Gets the password rules for an account — response body — minimum Password Length Metadata
Metadata that indicates whether the `minimumPasswordLength` property is editable.
passwordIncludeDigitstringOptionalWhen **true,** passwords must include a digit. The default value is `false`.
passwordIncludeDigitOrSpecialCharacterstringOptionalWhen **true,** passwords must include either a digit or a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeLowerCasestringOptionalWhen **true,** passwords must include a lowercase letter. The default value is `false`.
passwordIncludeSpecialCharacterstringOptionalWhen **true,** passwords must include a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeUpperCasestringOptionalWhen **true,** passwords must include an uppercase letter. The default value is `false`.
passwordStrengthTypestringOptionalThe 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`
passwordStrengthTypeMetadataModelOptionalExpand Gets the password rules for an account — response body — password Strength Type Metadata
Metadata that indicates whether the `passwordStrengthType` property is editable.
questionsRequiredstringOptionalThe number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`.
questionsRequiredMetadataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
maximumDaysstringOptional
minimumDaysstringOptional

Gets the password rules for an account — response body — lockout Duration Minutes Metadata

FieldTypePresenceDescription and constraints
$objectRoot
maximumMinutesstringOptional
minimumMinutesstringOptional

Gets the password rules for an account — response body — lockout Duration Type Metadata

FieldTypePresenceDescription and constraints
$objectRoot
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item

Gets the password rules for an account — response body — minimum Password Age Days Metadata

FieldTypePresenceDescription and constraints
$objectRoot
maximumAgestringOptional
minimumAgestringOptional

Gets the password rules for an account — response body — minimum Password Length Metadata

FieldTypePresenceDescription and constraints
$objectRoot
maximumLengthstringOptionalThe maximum number of entry characters supported by the custom tab.
minimumLengthstringOptionalMinimum length of the access code string.

Gets the password rules for an account — response body — password Strength Type Metadata

FieldTypePresenceDescription and constraints
$objectRoot
optionsarrayOptionalAn array of option strings supported by this setting.
options[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
minimumLengthstringOptionalMinimum length of the access code string.
namestringOptional
passwordIncludeDigitstringOptionalWhen **true,** passwords must include a digit. The default value is `false`.
passwordIncludeDigitOrSpecialCharacterstringOptionalWhen **true,** passwords must include either a digit or a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeLowerCasestringOptionalWhen **true,** passwords must include a lowercase letter. The default value is `false`.
passwordIncludeSpecialCharacterstringOptionalWhen **true,** passwords must include a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeUpperCasestringOptionalWhen **true,** passwords must include an uppercase letter. The default value is `false`.

Gets the password rules for an account — response body — questions Required Metadata

FieldTypePresenceDescription and constraints
$objectRootInformation about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.
maximumQuestionsstringOptionalThe 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`.
minimumQuestionsstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
accessControlListBase64stringOptionalReserved for Docusign.
allowCommentsstringOptionalWhen **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.
allowMarkupstringOptionalWhen **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.
allowReassignstringOptionalWhen **true,** the recipient can redirect an envelope to a more appropriate recipient.
allowViewHistorystringOptionalWhen **true,** recipients can view the history of the envelope.
anySignerstringOptionalDeprecated. This feature has been replaced by signing groups.
asynchronousstringOptionalWhen **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.
attachmentsUristringOptionalContains a URL for retrieving the attachments that are associated with the envelope.
authoritativeCopystringOptionalWhen **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.**
authoritativeCopyDefaultstringOptionalThe 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`.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
brandIdstringOptionalThe ID of the brand.
brandLockstringOptionalWhen **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.
burnDefaultTabDatastringOptional
certificateUristringOptionalThe URI for retrieving certificate information.
completedDateTimestringOptionalSpecifies the date and time this item was completed.
copyRecipientDatastringOptional
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customFieldsModelOptionalExpand 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.
customFieldsUristringOptionalThe URI for retrieving custom fields.
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
deletedDateTimestringOptionalReserved for Docusign.
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
disableResponsiveDocumentstringOptionalWhen **true,** responsive documents are disabled for the envelope.
documentBase64stringOptionalThe 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.
documentsCombinedUristringOptionalThe URI for retrieving all of the documents associated with the envelope as a single PDF file.
documentsUristringOptionalThe URI for retrieving all of the documents associated with the envelope as separate files.
emailBlurbstringOptionalThis is the same as the email body. If specified it is included in email body for all envelope recipients.
emailSettingsModelOptionalExpand Adds email setting overrides to an envelope — response body
A complex type that contains email settings.
emailSubjectstringOptionalThe 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.
enableWetSignstringOptionalWhen **true,** the signer is allowed to print the document and sign it on paper.
enforceSignerVisibilitystringOptionalWhen **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#
envelopeAttachmentsarrayOptionalAn array of attachment objects that provide information about the attachments that are associated with the envelope.
envelopeAttachments[]ModelEach itemExpand Updates an envelope attachment in a draft or in-process envelope — request body — body
envelopeCustomMetadataModelOptionalExpand Gets the status of a single envelope — response body — envelope Custom Metadata
envelopeDocumentsarrayOptionalAn array containing information about the documents that are included in the envelope.
envelopeDocuments[]ModelEach itemExpand Updates a template document — response body
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
envelopeIdStampingstringOptionalWhen **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.
envelopeLocationstringOptionalReserved for Docusign.
envelopeMetadataModelOptionalExpand 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.
envelopeUristringOptionalThe URI for retrieving the envelope or envelopes.
expireAfterstringOptionalNot 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.
expireDateTimestringOptionalThe 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.)
expireEnabledstringOptionalNot 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.
externalEnvelopeIdstringOptionalMay contain an external identifier for the envelope.
foldersarrayOptionalA list of folder objects.
folders[]ModelEach itemExpand Gets the list of templates — response body — folders item
hasCommentsstringOptionalWhen **true,** indicates that users have added comments to the envelope.
hasFormDataChangedstringOptionalWhen **true,** indicates that the data collected through form fields on a document has changed.
hasWavFilestringOptionalWhen **true,** indicates that a .wav file used for voice authentication is included in the envelope.
holderstringOptionalReserved for Docusign.
initialSentDateTimestringOptionalThe date and time the envelope was initially sent.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
isDynamicEnvelopestringOptionalWhen **true,** indicates that the envelope is a dynamic envelope.
isSignatureProviderEnvelopestringOptionalWhen **true,** indicates that the envelope is a signature-provided envelope.
isTicketRelatedEnvelopestringOptional
lastModifiedDateTimestringOptionalThe date and time that the item was last modified.
locationstringOptionalReserved for Docusign.
lockInformationModelOptionalExpand Locks an envelope — response body
Provides lock information about an envelope that a user has locked.
messageLockstringOptionalWhen **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.
notificationModelOptionalExpand Gets envelope notification information — response body
notificationUristringOptionalThe URI for retrieving notifications.
powerFormModelOptionalExpand Creates a new Power Form — response body
Information about any PowerForms that are included in the envelope.
purgeCompletedDatestringOptionalThe date that a purge was completed.
purgeRequestDatestringOptionalThe date that a purge was requested.
purgeStatestringOptionalShows 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)

recipientsModelOptionalExpand Deletes recipients from an envelope — response body
An array of recipient objects that provides details about the recipients of the envelope.
recipientsLockstringOptionalWhen **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipientsUristringOptionalContains a URI for an endpoint that you can use to retrieve the recipients.
senderModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the sender of the envelope.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
signerCanSignOnMobilestringOptionalWhen **true,** recipients can sign on a mobile device.

**Note:** Only Admin users can change this setting.
signingLocationstringOptionalSpecifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`.
statusstringOptionalIndicates 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.
statusChangedDateTimestringOptionalThe data and time that the status changed.
templatesUristringOptionalThe URI for retrieving the templates.
transactionIdstringOptionalUsed 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.
uSigStatestringOptional
useDisclosurestringOptionalWhen **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.
voidedDateTimestringOptionalThe date and time the envelope or template was voided.
voidedReasonstringOptionalThe reason the envelope or template was voided.

**Note:** The string is truncated to the first 200 characters.
workflowModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
envelopeCustomMetadataDetailsarrayOptional
envelopeCustomMetadataDetails[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
allowAdvancedCorrectstringOptionalSpecifies 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.
allowCorrectstringOptionalSpecifies 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.
enableSignWithNotarystringOptionalSpecifies if Docusign eNotary service is enabled for the envelope.

Gets the supported languages for envelope recipients — response body

FieldTypePresenceDescription and constraints
$objectRootA list of supported languages.
languagesarrayOptionalA 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[]ModelEach itemExpand Updates an existing brand — response body — colors item

Referenced models: Updates an existing brand — response body — colors item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.