Skip to content

DocuSign: Esignature schemas (part 22)

53 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Gets the user account settings for a specified user — response body

FieldTypePresenceDescription and constraints
$objectRootProperties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:
- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)
- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)
- `options`: The values supported for this setting (not all settings have this element)
accountAgreementsAccessTypestringOptional
accountAgreementsAccessTypeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
accountManagementGranularModelOptionalExpand Gets the user account settings for a specified user — response body — account Management Granular
Describes which account management capabilities a user has.
adminOnlystringOptionalReserved for Docusign.
adminOnlyMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
allowAccessToAllAccountAgreementsstringOptional
allowAccessToAllAccountAgreementsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowAutoTaggingstringOptionalWhen **true,** the API returns suggested tabs for documents for this user.
allowEnvelopeTransferTostringOptionalWhen **true,** this user can participate in envelope transfers on the account.
allowEnvelopeTransferToMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
allowEsealRecipientsstringOptionalWhen **true,** this user can create [electronic seal recipients][eseal].

[eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
allowEsealRecipientsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `allowEsealRecipientsMetadata` property.
allowPowerFormsAdminToAccessAllPowerFormEnvelopestringOptionalWhen **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property.
allowRecipientLanguageSelectionstringOptionalWhen **true,** this user can set the language used in the standard email format for a recipient when creating an envelope.
allowRecipientLanguageSelectionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata for allowRecipientLanguageSelection.
allowSendOnBehalfOfstringOptionalWhen **true,** this user can send envelopes "on behalf of" other users through the API.
allowSendOnBehalfOfMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata for allowSendOnBehalfOf.
allowSupplementalDocumentsstringOptionalWhen **true,** this user can include supplemental documents.
allowSupplementalDocumentsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `allowSupplementalDocuments` property is editable.
allowTransactionsstringOptional
allowTransactionsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowedDocumentTemplateLibraryAccessstringOptional
allowedDocumentTemplateLibraryAccessMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
allowedOrchestrationAccessstringOptional
allowedOrchestrationAccessMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
anchorTagVersionedPlacementEnabledstringOptionalReserved for Docusign.
apiAccountWideAccessstringOptionalWhen **true,** indicates that this user can send envelope-specific API requests on the account.
apiAccountWideAccessMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata for apiAccountWideAccess.
apiCanExportACstringOptionalWhen **true,** this user can export authoritative copy for the account.
apiCanExportACMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `apiCanExportACMetadata` property.
bulkSendstringOptionalWhen **true,** this user can use the bulk send feature for the account.
bulkSendMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `bulkSend` property is editable.
canBulkUploadAgreementsstringOptional
canBulkUploadAgreementsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canChargeAccountstringOptionalReserved for Docusign.
canChargeAccountMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
canCreateTransactionstringOptional
canCreateTransactionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canDeleteDocumentsInTransactionstringOptional
canDeleteDocumentsInTransactionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canDeleteTransactionstringOptional
canDeleteTransactionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canEditSharedAddressbookstringOptionalWhen true, this user can edit the shared address book for the account.
canEditSharedAddressbookMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canEditSharedAddressbookMetadata` property.
canLockEnvelopesstringOptionalReserved for Docusign.
canLockEnvelopesMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
canManageAccountstringOptionalWhen **true,** this user is an administrator for the account.
canManageAccountMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canManageAccountMetadata` property.
canManageAgreementPartiesstringOptional
canManageAgreementPartiesMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageDistributorstringOptionalReserved for Docusign.
canManageDistributorMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canManageDistributor` property.
canManageTemplatesstringOptionalWhen **true,** this user can manage templates for the account.
canManageTemplatesMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canManageTemplates` property.
canSendAPIRequestsstringOptionalWhen **true,** this user can send API requests on the account.
canSendAPIRequestsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canSendAPIRequests` property.
canSendEnvelopestringOptionalWhen **true,** this user can send envelopes on the account.
canSendEnvelopeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canSendEnvelope` property.
canSendEnvelopesViaSMSstringOptional
canSendEnvelopesViaSMSMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canSignEnvelopestringOptionalWhen **true,** this user can sign envelopes.
canSignEnvelopeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canSignEnvelope` property.
canUseScratchpadstringOptionalWhen **true,** this user can use a scratchpad to edit information.
canUseScratchpadMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `canUseScratchpad` property.
canUseSmartContractsstringOptionalReserved for Docusign.
canUseSmartContractsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
disableDocumentUploadstringOptionalWhen **true,** this user is prohibited from uploading documents during sending.
disableDocumentUploadMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `disableDocumentUpload` property is editable.
disableOtherActionsstringOptionalWhen **true,** this user can access the **Other Actions** menu.
disableOtherActionsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `disableOtherActions` property is editable.
enableDSProstringOptionalReserved for Docusign.
enableDSProMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `enableDSPro` property is editable.
enableKeyTermsSuggestionsByDocumentTypestringOptional
enableKeyTermsSuggestionsByDocumentTypeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableSequentialSigningAPIstringOptionalWhen **true,** the account can define the routing
order of recipients for envelopes sent by using the eSignature API.

**Note:** Only SysAdmin users can change this setting.
enableSequentialSigningAPIMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `enableSequentialSigningAPI` property is editable.
enableSequentialSigningUIstringOptionalWhen **true,** the account can define the routing order
of recipients for envelopes sent by using the Docusign application.

**Note:** Only SysAdmin users can change this setting.
enableSequentialSigningUIMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `enableSequentialSigningUI` property is editable.
enableSignOnPaperOverridestringOptionalWhen **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.

**Note:** Only Admin users can change this setting.
enableSignOnPaperOverrideMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `enableSignOnPaperOverride` property is editable.
enableSignerAttachmentsstringOptionalWhen **true,** this user can use the signing attachments feature.
enableSignerAttachmentsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `enableSignerAttachments` property is editable.
enableTransactionPointstringOptionalReserved for Docusign.
enableTransactionPointMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
enableVaultingstringOptionalWhen **true,** Vaulting is enabled for the account.
enableVaultingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `enableVaulting` property is editable.
expressSendOnlystringOptionalWhen **false,** this user can apply tabs to documents during the sending experience.
isManagedByScimstringOptional
isManagedByScimMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
isMembershipManagedByScimstringOptional
isMembershipManagedByScimMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
localestringOptionalThe user's locale code. Valid values are:
- `zh_CN`
- `zh_TW`
- `nl`
- `en`
- `fr`
- `de`
- `it`
- `ja`
- `ko`
- `pt`
- `pt_BR`
- `ru`
- `es`
localeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `locale` property.
localePolicyModelOptionalExpand Gets the user account settings for a specified user — response body — locale Policy
Locale-specific settings.
manageClickwrapsModestringOptionalWhen **true,** this user can create and manage [Clickwraps](/docs/click-api/).
manageClickwrapsModeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `manageClickwrapsMode` property.
modifiedBystringOptionalThe user ID (GUID) of the user who last modified this user record. This property is read-only.
modifiedByMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `modifiedBy` property.
modifiedDatestringOptionalThe date on which this user record was last modified.
modifiedDateMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `modifiedDate` property.
modifiedPagestringOptionalNote referencing the page that modified this user record.
modifiedPageMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `modifiedPage` property.
newSendUIstringOptionalReserved for Docusign.
newSendUIMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `newSendUI` property.
powerFormModestringOptionalIndicates the Power Form mode setting for the user:
- `none`
- `admin`
- `user`
powerFormModeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `powerFormMode` property.
recipientViewedNotificationstringOptionalWhen **true,** this user receives notifications when envelopes are viewed.
recipientViewedNotificationMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `recipientViewedNotification` property.
sealIdentifiersarrayOptionalInformation about the seals associated with this user.
sealIdentifiers[]ModelEach itemExpand Returns available seals for specified account — response body — seals item
selfSignedRecipientEmailDocumentstringOptionalSets how self-signed documents are presented to the email recipients.
Valid values are:

- `include_pdf`: A PDF of the completed document is attached to the email.
- `include_link`: A secure link to the self-signed documents is included
in the email.

**Note:** Only Admin users can change this setting.
selfSignedRecipientEmailDocumentMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable.
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.
supplementalDocumentIncludeInDownloadstringOptionalWhen **true,** this user gets supplemental documents when downloading documents.
supplementalDocumentsMustAcceptstringOptionalWhen **true,** this user must accept supplemental documents.
supplementalDocumentsMustAcceptMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.
supplementalDocumentsMustReadstringOptionalWhen **true,** this user must both view and accept supplemental documents.
supplementalDocumentsMustReadMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.
supplementalDocumentsMustViewstringOptionalWhen **true,** this user must view supplemental documents.
supplementalDocumentsMustViewMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.
templateActiveCreationstringOptionalWhen **true,** a new template is created each time the user sends an envelope.
templateActiveCreationMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `templateActiveCreation` property.
templateApplyNotifystringOptionalWhen **true,** the system notifies this user before applying a matching template.
templateApplyNotifyMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `templateApplyNotify` property.
templateAutoMatchingstringOptionalWhen **true,** the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.
templateAutoMatchingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `templateAutoMatching` property.
templateMatchingSensitivitystringOptionalPercentage used when matching templates.
templateMatchingSensitivityMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `tempalteMatchingSensitivity` property.
templatePageLevelMatchingstringOptionalWhen **true,** users see template matching functionality.
templatePageLevelMatchingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `templatePageLevelMatching` property.
timezoneDSTstringOptionalWhen true, daylight savings time is in effect for this user's time zone.
timezoneDSTMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `timezoneDST` property.
timezoneMaskstringOptionalThe custom DateTime format setting for this user.
timezoneMaskMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `timezoneMask` property.
timezoneOffsetstringOptionalThe timezone offset for the user. Valid values:
- `tz_01_afghanistan`
- `tz_02_alaskan`
- `tz_03_arab`
- `tz_04_arabian`
- `tz_05_arabic`
- `tz_06_argentina`
- `tz_07_atlantic`
- `tz_08_aus_central`
- `tz_09_aus_eastern`
- `tz_10_azerbaijan`
- `tz_11_azores`
- `tz_12_bangladesh`
- `tz_13_canada_central`
- `tz_14_cape_verde`
- `tz_15_caucasus`
- `tz_16_central_australia`
- `tz_17_central_america`
- `tz_18_central_asia`
- `tz_19_central_brazilian`
- `tz_20_central_europe`
- `tz_21_central_european`
- `tz_22_central_pacific`
- `tz_23_central`
- `tz_24_central_mexico`
- `tz_25_china`
- `tz_26_dateline`
- `tz_27_east_africa`
- `tz_28_east_australia`
- `tz_29_east_europe`
- `tz_30_east_south_america`
- `tz_31_eastern`
- `tz_32_egypt`
- `tz_33_ekaterinburg`
- `tz_34_fiji`
- `tz_35_fli`
- `tz_36_georgian`
- `tz_37_gmt`
- `tz_38_greenland`
- `tz_39_greenwich`
- `tz_40_gtb`
- `tz_41_hawaiian`
- `tz_42_india`
- `tz_43_iran`
- `tz_44_israel`
- `tz_45_jordan`
- `tz_46_kaliningrad`
- `tz_47_kamchatka`
- `tz_48_korea`
- `tz_49_magadan`
- `tz_50_mauritius`
- `tz_51_mid_atlantic`
- `tz_52_middle_east`
- `tz_53_montevideo`
- `tz_54_morocco`
- `tz_55_mountain`
- `tz_56_mountain_mexico`
- `tz_57_myanmar`
- `tz_58_north_central_asia`
- `tz_59_namibia`
- `tz_60_nepal`
- `tz_61_new_zealand`
- `tz_62_new_foundland`
- `tz_63_north_asia_east`
- `tz_64_north_asia`
- `tz_65_pacific_sa`
- `tz_66_pacific`
- `tz_67_pacific_mexico`
- `tz_68_pakistan`
- `tz_69_paraguay`
- `tz_70_romance`
- `tz_71_russian`
- `tz_72_sa_eastern`
- `tz_73_sa_pacific`
- `tz_74_sa_western`
- `tz_75_samoa`
- `tz_76_se_asia`
- `tz_77_singapore`
- `tz_78_south_africa`
- `tz_79_sriLanka`
- `tz_80_syria`
- `tz_81_taipei`
- `tz_82_tasmania`
- `tz_83_tokyo`
- `tz_84_tonga`
- `tz_85_turkey`
- `tz_86_ulaanbaatar`
- `tz_87_us_eastern`
- `tz_88_us_mountain`
- `tz_89_venezuela`
- `tz_90_vladivostok`
- `tz_91_west_australia`
- `tz_92_west_central_africa`
- `tz_93_west_europe`
- `tz_94_west_asia`
- `tz_95_west_pacific`
- `tz_96_yakutsk`
timezoneOffsetMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `timezoneOffset` property.
timezoneSendingPrefstringOptionalReserved for Docusign.
timezoneSendingPrefMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
timezoneSigningPrefstringOptionalReserved for Docusign.
timezoneSigningPrefMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
transactionPointSiteNameURLstringOptionalReserved for Docusign.
transactionPointSiteNameURLMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
transactionPointUserNamestringOptionalReserved for Docusign.
transactionPointUserNameMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
vaultingModestringOptionalIndicates the specified Vaulting mode:
- `none`
- `estored`
- `electronic_original`
vaultingModeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata about the `vaultingMode` property.
webFormsstringOptional
webFormsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata

Referenced models: Gets the user account settings for a specified user — response body — locale Policy, Returns available seals for specified account — response body — seals item, 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 — locale Metadata, Gets the user account settings for a specified user — response body — signer Email Notifications, Gets the user account settings for a specified user — response body — account Management Granular

Gets the user account settings for a specified user — response body — account Management Granular

FieldTypePresenceDescription and constraints
$objectRootDescribes which account management capabilities a user has.
canManageAccountSecuritySettingsstringOptional**True** if the user can manage account security settings.
canManageAccountSecuritySettingsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageAccountSettingsstringOptional**True** if the user can manage account settings.
canManageAccountSettingsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageAdminsstringOptional**True** if the user can manage administrators.
canManageAdminsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `canManageAdmins` property is editable.
canManageConnectstringOptional
canManageConnectMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageDocumentRetentionstringOptional
canManageDocumentRetentionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageEnvelopeTransferstringOptional
canManageEnvelopeTransferMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageGroupsButNotUsersstringOptional
canManageGroupsButNotUsersMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageJointAgreementsstringOptional
canManageJointAgreementsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageReportingstringOptional**True** if the user can manage reporting.
canManageReportingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageSharingstringOptional**True** if the user can manage sharing.
canManageSharingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `canManageSharing` property is editable.
canManageSigningGroupsstringOptional**True** if the user can manage signing groups.
canManageSigningGroupsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageStampsstringOptional
canManageStampsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageUsersstringOptional**True** if the user can manage users.
canManageUsersMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `canManageUsers` property is editable.
canViewUsersstringOptional

Referenced models: Gets the user account settings for a specified user — response body — locale Metadata

Gets the user account settings for a specified user — response body — locale Metadata

FieldTypePresenceDescription and constraints
$objectRootMetadata that indicates whether a property is editable and describes setting-specific options.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`
uiHintstringOptionalReserved for Docusign.
uiOrderstringOptionalReserved for Docusign.
uiTypestringOptionalReserved for Docusign.

Gets the user account settings for a specified user — response body — locale Policy

FieldTypePresenceDescription and constraints
$objectRoot
addressFormatstringOptionalSpecifies the address format. Valid values:

- `en_us`
- `ja_jp`
- `zh_cn_tw`
addressFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates if the `addressFormat` property is editable.
allowRegionstringOptional
calendarTypestringOptionalSpecifies the type of calendar. Valid values:

- `gregorian`
- `japanese`
- `buddhist`
calendarTypeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `calendarType` property is editable.
cultureNamestringOptionalThe two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
cultureNameMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `cultureName` property is editable.
currencyCodestringOptionalThe [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
currencyCodeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `currencyCode` property is editable.
currencyNegativeFormatstringOptionalDetermines how negative currency values
are displayed.

In most cases, you should not need to change
this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).

Valid values:

- `Default`<br>
`0`
- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>
`($1,234,567.89)`
- `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>
`-$1,234,567.89`
- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>
`-$ 1.234.567,89`
- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>
`$ -1.234.567,89`
- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>
`-1.234.567,89 $`
- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>
`(1 234 567,89 $)`
- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>
`-1 234 567,89 $`
- `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>
`$-1'234'567.89`
- `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>
`-$1.234.567,89`
- `Minus_CSym_1_Comma_234_Comma_567`<br>
`-$1,234,567`
- `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>
`-$12,34,567.89`
- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>
`($ 1234,567.89)`
- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>
`$ -12,34,567.89`
- `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>
`$-1,234,567.89`
- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>
`$ -1 234 567,89`
- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>
`$ -1 234 567.89`
- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>
`-$ 1 234 567,89`
- `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>
`-1 234 567,89$`
- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>
`-1 234 567.89 $`
- `OPar_CSym_1_Period_234_Period_567_CPar`<br>
`(1.234.567)`
- `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>
`($1,234,567)`
- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>
`-1,234,567.89 $`
- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>
`-$ 1,234,567.89`
- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>
`($ 1.234.567,89)`
- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>
`($ 1'234'567.89)`
- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>
`($ 1 234 567,89)`
- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>
`($ 1 234 567.89)`
- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>
`($12,34,567.89)`
- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>
`($ 12,34,567.89)`
- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>
`(1,234,567.89 $)`
- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>
`(1.234.567,89 $)`
- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>
`(1 234 567,89$)`
- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>
`(1 234 567.89 $)`
- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>
`($ 1,234,567.89)`
- `Minus_CSym_1_Period_234_Period_567`<br>
`-$ 1.234.567`
- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>
`-$ 1'234'567.89`
- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>
`-$ 1 234 567.89`
- `CSym_Minus_1_Comma_234_Comma_567`<br>
`$-1,234,567`
- `CSym_Minus_1_Period_234_Period_567`<br>
`$-1.234.567`
- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>
`$ -1'234'567.89`
- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>
`$ -1,234,567.89`
- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>
`-$ 12,34,567.89`
- `Minus_1_Period_234_Period_567_Space_CSym`<br>
`-123.456.789 $`
- `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>
`$-123 456 789,00`
- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>
`-123'456'789.00 $`
- `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>
`$123,456,789.00-`
- `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>
`$-123.456.789,00`
- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>
`($123.456.789,00)`
- `Minus_CSym_1234_Comma_567_Period_89`<br>
`-$123456,789.00`
- `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>
`-$123 456 789,00`
currencyNegativeFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `currencyNegativeFormat` property is editable.
currencyPositiveFormatstringOptionalDetermines how positive currency values
are displayed.

In most cases, you should not need to change
this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).

Valid values:


- `Default`<br>
Uses the current locale.
- `CSym_1_Comma_234_Comma_567_Period_89`<br>
`$1,234,567.89`
- `CSym_Space_1_Period_234_Period_567_Comma_89`<br>
`$ 1.234.567,89`
- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>
`1.234.567,89 $`
- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>
`1 234 567,89 $`
- `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>
`$ 1'234'567.89`
- `CSym_1_Comma_234_Comma_567`<br>
`$1,234,567`
- `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>
`$ 12,34,567.89`
- `CSym_12_Comma_34_Comma_567_Period_89`<br>
`$12,34,567.89`
- `CSym_Space_1234_Comma_567_Period_89`<br>
`$ 1234,567.89`
- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>
`1 234 567.89 $`
- `CSym_Space_1_Space_234_Space_567_Comma_89`<br>
`$ 1 234 567,89`
- `CSym_Space_1_Space_234_Space_567_Period_89`<br>
`$ 1 234 567.89`
- `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>
`1 234 567,89$`
- `CSym_1_Period_234_Period_567`<br>
`$1.234.567`
- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>
`1,234,567. $` (New Armenian)
- `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>
`$ 1,234,567.89` (Persian)
- `CSym_1_Period_234_Period_567_Comma_89`<br>
`$123.456.789,00` (es-CO)
- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>
`123'456'789.00 $` (fr-ch)
- `CSym_1234_Comma_567_Period_89`<br>
`$123456,789.00` (es-PR)
- `Leading_1_Period_234_Period_567_Space_CSym`<br>
`123.456.789 $`
- `CSym_1_Space_234_Space_567_Comma_89`<br>
`$123 456 789,00` (en-ZA, es-CR)
currencyPositiveFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `currencyPositiveFormat` property is editable.
customDateFormatstringOptional
customSignDateFormatstringOptional
customSignTimeFormatstringOptional
customTimeFormatstringOptional
dateFormatstringOptionalSpecifies the date format. Valid values:

- `default` <br> used the UI's
- `longformat` <br> use the UI's long format
- `dd_mm_yy` <br> dd-MM-yy
- `dd_mmm_yy` <br> dd-MMM-yy
- `dd_mm_yyyy` <br> dd-MM-yyyy
- `dd_mmm_yyyy` <br> dd-MMM-yyyy
- `ddmmmmyyyy` <br> dd MMMM yyyy
- `ddmmyyyy` <br> dd/MM/yyyy
- `ddmmyyyy_de` <br> dd.MM.yyyy
- `dmyyyy` <br> d/M/yyyy
- `d_m_yyyy` <br> d-M-yyyy
- `mmmd_yyyy` <br> MMM d, yyyy
- `mmm_dd_yyyy` <br> MMM-dd-yyyy
- `mmmmd_yyyy` <br> MMMM d, yyyy
- `mm_dd_yyyy` <br> MM-dd-yyyy
- `mdyyyy` <br> M/d/yyyy
- `yyyy_mmm_dd` <br> yyyy-MMM-dd
- `yyyy_mm_dd` <br> yyyy-MM-dd
- `yyyymmdd` <br> yyyy/MM/dd
- `yyyymd` <br> yyyy/M/d
- `custom` <br> Customer set own value
- `mmddyyyy` <br> MM/dd/yyyy
- `mmddyy` <br> MM/dd/yy
- `yyyy_mmmm_d` <br> yyyy MMMM d
dateFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `dateFormat` property is editable.
effectiveAddressFormatstringOptional
effectiveCalendarTypestringOptional
effectiveCurrencyCodestringOptional
effectiveCurrencyNegativeFormatstringOptional
effectiveCurrencyPositiveFormatstringOptional
effectiveCustomDateFormatstringOptional
effectiveCustomTimeFormatstringOptional
effectiveDateFormatstringOptional
effectiveInitialFormatstringOptional
effectiveNameFormatstringOptional
effectiveTimeFormatstringOptional
effectiveTimeZonestringOptional
initialFormatstringOptionalWhen a user is required to enter their initials,
this property
specifies how initials are rendered.
The examples show the
initials for "William Henry Gates".


- `first1last1`<br> "WG"
- `last2`<br> "GA"
- `first2`<br> "WI"
- `last2_cjk`<br> first two characters from last name in CJK characters.

<!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
initialFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `initialFormat` property is editable.
nameFormatstringOptionalDescribes how names are displayed. Valid values:

- `first_middle_last`<br>William Henry Gates
- `full`<br>Mr William Henry Gates III
- `last_first`<br>Gates William
- `lastfirst`<br>GatesWilliam
- `last_first_cjk`<br>Gates William only with CJK characters
- `lastfirst_cjk`<br>GatesWilliam only with CJK characters

<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
nameFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `nameFormat` property is editable.
signDateFormatstringOptionalThe format for the signature date. Valid values are:

- `d/M/yyyy`
- `dd-MM-yy`
- `dd-MMM-yy`
- `dd-MM-yyyy`
- `dd.MM.yyyy`
- `dd-MMM-yyyy`
- `dd MMMM yyyy`
- `M/d/yyyy`
- `MM-dd-yyyy`
- `MM/dd/yyyy`
- `MM/dd/yy`
- `MMM-dd-yyyy`
- `MMM d, yyyy`
- `MMMM d, yyyy`
- `yyyy-MM-dd`
- `yyyy-MMM-dd`
- `yyyy/MM/dd`
- `yyyy MMMM d`

**Note:** Only Admin users can change this setting.
signDateFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `signDateFormat` property is editable.
signTimeFormatstringOptionalThe format for the signature time. Valid values are:

- `none`
- `HH:mm`
- `h:mm`
- `HH:mm:ss`
- `h:mm:ss`
signTimeFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `signTimeFormat` property is editable.
timeFormatstringOptionalSpecifies the time format. Valid values:

- `none` <br>None
- `hh_mm` <br>hh:mm
- `hhmm` <br>HH:mm
- `hhmmss` <br>HH:mm:ss
- `hhmmsstt` <br>HH:mm:ss tt
- `hhmmtt` <br> HH:mm tt
- `hmm` <br>h:mm
- `hmmss` <br>h:mm:ss
- `hmmsstt` <br>h:mm:ss tt
- `hmmtt` <br>h:mm tt
- `custom` <br>Customer-set format

<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
timeFormatMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `timeFormat` property is editable.
timeZonestringOptionalSpecifies the time zone. Valid values:

- `TZ_01_AfghanistanStandardTime`
- `TZ_02_AlaskanStandardTime`
- `TZ_03_ArabStandardTime`
- `TZ_04_ArabianStandardTime`
- `TZ_05_ArabicStandardTime`
- `TZ_06_ArgentinaStandardTime`
- `TZ_07_AtlanticStandardTime`
- `TZ_08_AUS_CentralStandardTime`
- `TZ_09_AUS_EasternStandardTime`
- `TZ_10_AzerbaijanStandardTime`
- `TZ_11_AzoresStandardTime`
- `TZ_12_BangladeshStandardTime`
- `TZ_13_CanadaCentralStandardTime`
- `TZ_14_CapeVerdeStandardTime`
- `TZ_15_CaucasusStandardTime`
- `TZ_16_CentralAustraliaStandardTime`
- `TZ_17_CentralAmericaStandardTime`
- `TZ_18_CentralAsiaStandardTime`
- `TZ_19_CentralBrazilianStandardTime`
- `TZ_20_CentralEuropeStandardTime`
- `TZ_21_CentralEuropeanStandardTime`
- `TZ_22_CentralPacificStandardTime`
- `TZ_23_CentralStandardTime`
- `TZ_24_CentralStandardTimeMexico`
- `TZ_25_ChinaStandardTime`
- `TZ_26_DatelineStandardTime`
- `TZ_27_E_AfricaStandardTime`
- `TZ_28_E_AustraliaStandardTime`
- `TZ_29_E_EuropeStandardTime`
- `TZ_30_E_SouthAmericaStandardTime`
- `TZ_31_EasternStandardTime`
- `TZ_32_EgyptStandardTime`
- `TZ_33_EkaterinburgStandardTime`
- `TZ_34_FijiStandardTime`
- `TZ_35_FLE_StandardTime`
- `TZ_36_GeorgianStandardTime`
- `TZ_37_GMT_StandardTime`
- `TZ_38_GreenlandStandardTime`
- `TZ_39_GreenwichStandardTime`
- `TZ_40_GTB_StandardTime`
- `TZ_41_HawaiianStandardTime`
- `TZ_42_IndiaStandardTime`
- `TZ_43_IranStandardTime`
- `TZ_44_IsraelStandardTime`
- `TZ_45_JordanStandardTime`
- `TZ_46_KaliningradStandardTime`
- `TZ_47_KamchatkaStandardTime`
- `TZ_48_KoreaStandardTime`
- `TZ_49_MagadanStandardTime`
- `TZ_50_MauritiusStandardTime`
- `TZ_51_MidAtlanticStandardTime`
- `TZ_52_MiddleEastStandardTime`
- `TZ_53_MontevideoStandardTime`
- `TZ_54_MoroccoStandardTime`
- `TZ_55_MountainStandardTime`
- `TZ_56_MountainStandardTimeMMexico`
- `TZ_57_MyanmarStandardTime`
- `TZ_58_N_CentralAsiaStandardTime`
- `TZ_59_NamibiaStandardTime`
- `TZ_60_NepalStandardTime`
- `TZ_61_NewZealandStandardTime`
- `TZ_62_NewfoundlandStandardTime`
- `TZ_63_NorthAsiaEastStandardTime`
- `TZ_64_NorthAsiaStandardTime`
- `TZ_65_PacificSAStandardTime`
- `TZ_66_PacificStandardTime`
- `TZ_67_PacificStandardTimeMexico`
- `TZ_68_PakistanStandardTime`
- `TZ_69_ParaguayStandardTime`
- `TZ_70_RomanceStandardTime`
- `TZ_71_RussianStandardTime`
- `TZ_72_SAEasternStandardTime`
- `TZ_73_SAPacificStandardTime`
- `TZ_74_SAWesternStandardTime`
- `TZ_75_SamoaStandardTime`
- `TZ_76_SE_AsiaStandardTime`
- `TZ_77_SingaporeStandardTime`
- `TZ_78_SouthAfricaStandardTime`
- `TZ_79_SriLankaStandardTime`
- `TZ_80_SyriaStandardTime`
- `TZ_81_TaipeiStandardTime`
- `TZ_82_TasmaniaStandardTime`
- `TZ_83_TokyoStandardTime`
- `TZ_84_TongaStandardTime`
- `TZ_85_TurkeyStandardTime`
- `TZ_86_UlaanbaatarStandardTime`
- `TZ_87_US_EasternStandardTime`
- `TZ_88_USMountainStandardTime`
- `TZ_89_VenezuelaStandardTime`
- `TZ_90_VladivostokStandardTime`
- `TZ_91_W_AustraliaStandardTime`
- `TZ_92_W_CentralAfricaStandardTime`
- `TZ_93_W_EuropeStandardTime`
- `TZ_94_WestAsiaStandardTime`
- `TZ_95_WestPacificStandardTime`
- `TZ_96_YakutskStandardTime`
timeZoneMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `timeZone` property is editable.

Referenced models: Gets the user account settings for a specified user — response body — locale Metadata

Gets the user account settings for a specified user — response body — sender Email Notifications

FieldTypePresenceDescription and constraints
$objectRootContains the settings for the email notifications that senders receive about the envelopes that they send.
changedSignerstringOptionalWhen **true,** the sender receives an email notification if the signer changes.
clickwrapResponsesLimitNotificationEmailstringOptional
commentsOnlyPrivateAndMentionstringOptionalWhen **true,** the user receives only comments that mention their own user name.
commentsReceiveAllstringOptionalWhen **true,** the user receives all comments.
deliveryFailedstringOptionalWhen **true,** the sender receives an email notification if envelope delivery fails.
envelopeCompletestringOptionalWhen **true,** the user receives an email notification when the envelope has been completed.
offlineSigningFailedstringOptionalWhen **true,** the user receives an email notification if offline signing failed.
powerformResponsesLimitNotificationEmailstringOptional
purgeDocumentsstringOptionalWhen **true,** the user receives an email notification when a document purge occurs.
recipientViewedstringOptionalWhen **true,** the sender receives notification that a recipient viewed the envelope.
senderEnvelopeDeclinedstringOptionalWhen **true,** the sender receives notification that the envelope was declined.
withdrawnConsentstringOptionalWhen **true,** the user receives an email notification if consent is withdrawn.

Gets the user account settings for a specified user — response body — signer Email Notifications

FieldTypePresenceDescription and constraints
$objectRootAn 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.
agentNotificationstringOptionalWhen **true,** the user receives agent notification emails.
carbonCopyNotificationstringOptionalWhen **true,** the user receives notifications of carbon copy deliveries.
certifiedDeliveryNotificationstringOptionalWhen **true,** the user receives notifications of certified deliveries.
commentsOnlyPrivateAndMentionstringOptionalWhen **true,** the user receives only comments that mention their own user name.
commentsReceiveAllstringOptionalWhen **true,** the user receives all comments.
documentMarkupActivationstringOptionalWhen **true,** the user receives notification that document markup has been activated.
envelopeActivationstringOptionalWhen **true,** the user receives notification that the envelope has been activated.
envelopeCompletestringOptionalWhen **true,** the user receives an email notification when the envelope has been completed.
envelopeCorrectedstringOptionalWhen **true,** the user receives notification that the envelope has been corrected.
envelopeDeclinedstringOptionalWhen **true,** the user receives notification that the envelope has been declined.
envelopeVoidedstringOptionalWhen **true,** the user receives notification that the envelope has been voided.
faxReceivedstringOptionalReserved for Docusign.
offlineSigningFailedstringOptionalWhen **true,** the user receives an email notification if offline signing failed.
purgeDocumentsstringOptionalWhen **true,** the user receives an email notification when a document purge occurs.
reassignedSignerstringOptionalWhen **true,** the user receives notification that the envelope has been reassigned.
whenSigningGroupMemberstringOptionalWhen **true,** the user receives notification that he or she is a member of the signing group.

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

FieldTypePresenceDescription and constraints
$objectRootUser information.
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
companystringOptionalThe name of the user's company.
connectConfigurationsarrayOptionalObject representing the user's custom Connect configuration.
connectConfigurations[]ModelEach itemExpand 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 — connect Configurations item
countryCodestringOptionalThe two-letter code for the user's country.
createdDateTimestringOptionalThe UTC DateTime when the item was created.
customSettingsarrayOptionalThe name/value pair information for the user custom setting.
customSettings[]ModelEach itemExpand Updates an existing brand — response body — colors item
defaultAccountIdstringOptionalThe default account ID associated with the user.
emailstringOptionalThe user's email address.

This property cannot be updated via `PUT` requests.
enableConnectForUserstringOptionalBoolean value that specifies whether the user is enabled for updates from Docusign Connect.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
firstNamestringOptionalThe user's first name.
Maximum Length: 50 characters.
forgottenPasswordInfoModelOptionalExpand 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 — forgotten Password Info
A complex element containing up to four Question/Answer pairs for forgotten password information.
groupListarrayOptionalA list of the group information for groups to add the user to.
Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups.

When setting a user's group, only the `groupId` is required.
groupList[]ModelEach itemExpand Deletes an existing user group — response body — groups item
hasRemoteNotarybooleanOptional
homeAddressModelOptionalExpand Get credit card information — response body — address
Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type.
Maximum Length: 100 characters.
initialsImageUristringOptionalThe URI for retrieving the image of the user's initials.
isAdminstringOptionalWhen **true,** the user is an administrator.
isAlternateAdminstringOptionalWhen **true,** the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed.
isManagedByScimstringOptional
isMembershipManagedByScimstringOptional
isNAREnabledstringOptionalWhen **true,** National Association of Realtors (NAR) signature logos are enabled for the user.
jobTitlestringOptionalThe user's job title.
lastLoginstringOptionalThis property has been deprecated.
lastNamestringOptionalThe user's last name.
Maximum Length: 50 characters.
licenseStatusstringOptional
licenseTypestringOptional
loginStatusstringOptionalBoolean value that indicates whether the user is currently logged in or not.
middleNamestringOptionalThe user's middle name.
Limit: 50 characters.
passwordstringOptionalThe user's password.

This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).

This property is not returned by `GET` requests and cannot be updated via `PUT` requests.
passwordExpirationstringOptionalIf password expiration is enabled, the date-time when the user's password expires.
permissionProfileIdstringOptionalThe ID of the permission profile.

Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)
to get a list of permission profiles and their IDs.

You can also download a CSV file of all permission profiles
and their IDs from the **Settings > Permission Profiles** page
of your eSignature account page.
permissionProfileNamestringOptionalThe name of the account permission profile.

Example: `Account Administrator`
profileImageUristringOptionalThe URL for retrieving the user's profile image.
sendActivationEmailstringOptionalThis field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
sendActivationOnInvalidLoginstringOptionalWhen **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated.
signatureImageUristringOptionalAn endpoint URI that you can use to retrieve the user's signature image.
subscribestringOptional
suffixNamestringOptionalThe suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.
titlestringOptionalThe title of the user.
uristringOptionalA URI containing the user ID.
userAddedToAccountDateTimestringOptionalThe date and time that the user was added to the account.
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.
userNamestringOptionalThe name of the user.
userProfileLastModifiedDatestringOptionalThe date and time that the user's profile was last modified.
userSettingsModelOptionalExpand Gets the user account settings for a specified user — response body
The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.
workAddressModelOptionalExpand Get credit card information — response body — address

Referenced models: Get credit card information — response body — address, 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 — connect Configurations item, Locks a template — response body — error Details, 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 — forgotten Password Info, Deletes an existing user group — response body — groups item, Updates an existing brand — response body — colors item, Gets the user account settings for a specified user — response body

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 — connect Configurations item

FieldTypePresenceDescription and constraints
$objectRoot
configurationtypestringOptionalThe type of custom Connect configuration being accessed.
connectIdstringOptionalThe ID of the custom Connect configuration being accessed.
enabledstringOptionalBoolean value that indicates whether the custom Connect configuration is enabled or not.
hasAccessstringOptional
senderSearchableItemsarrayOptional
senderSearchableItems[]stringEach 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 — forgotten Password Info

FieldTypePresenceDescription and constraints
$objectRootA complex element that has up to four Question/Answer pairs for forgotten password information.
forgottenPasswordAnswer1stringOptionalThe answer to the first forgotten password challenge question.
forgottenPasswordAnswer2stringOptionalThe answer to the second forgotten password challenge question.
forgottenPasswordAnswer3stringOptionalThe answer to the third forgotten password challenge question.
forgottenPasswordAnswer4stringOptionalThe answer to the fourth forgotten password challenge question.
forgottenPasswordQuestion1stringOptionalThe first challenge question presented to a user who has forgotten their password.
forgottenPasswordQuestion2stringOptionalThe second challenge question presented to a user who has forgotten their password.
forgottenPasswordQuestion3stringOptionalThe third challenge question presented to a user who has forgotten their password.
forgottenPasswordQuestion4stringOptionalThe fourth challenge question presented to a user who has forgotten their password.

Initiate a new chunked upload — request body — body

FieldTypePresenceDescription and constraints
$objectRootThis is the request object for uploading a chunked upload.
chunkedUploadIdstringOptionalThe ID of the chunked upload.

**Note:** This property is ignored in requests, and overridden with an auto-generated value in responses.
datastringOptionalA base64-encoded representation of the content that is used to upload the file.

Maximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size.

List File Pages — 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.
pagesarrayOptionalAn array of page objects.
pages[]ModelEach itemExpand Creates a workspace file — response body — thumbnail
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 workspace file — response body — thumbnail

List Workspaces — response body

FieldTypePresenceDescription and constraints
$objectRootThis object contains a list of available workspaces.
endPositionstringOptionalThe last index position in the result set.
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`.
workspacesarrayOptionalA list of workspaces.
workspaces[]ModelEach itemExpand Get Workspace — response body

Referenced models: Get Workspace — response body

List workspace folder contents — response body

FieldTypePresenceDescription and constraints
$objectRootThis object's properties describe the contents of a workspace folder.
endPositionstringOptionalThe last index position in the result set.
folderModelOptionalExpand Creates a workspace file — response body
The folder from which to return items. You can enter either the folder name or folder ID.
itemsarrayOptionalA list of workspace items.
items[]ModelEach itemExpand Creates a workspace file — response body
parentFoldersarrayOptional
parentFolders[]ModelEach itemExpand Creates a workspace file — response body
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`.
workspaceIdstringOptionalThe ID of the workspace, always populated.

Referenced models: Creates a workspace file — response body

Lists resources for REST version specified — response body

FieldTypePresenceDescription and constraints
$objectRoot
resourcesarrayOptional
resources[]ModelEach itemExpand Updates an existing brand — response body — colors item

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

Locks a template — request body — body

FieldTypePresenceDescription and constraints
$objectRootThis request object contains information about the lock that you want to create or update.
lockDurationInSecondsstringOptionalThe number of seconds to lock the envelope for editing. Must be greater than 0 seconds.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalA friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur.
templatePasswordstringOptionalThe [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes.
useScratchPadstringOptionalWhen **true,** a scratchpad is used to edit information.

Locks a template — response body

FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringOptionalThe number of seconds to lock the envelope for editing. This value must be greater than `0` seconds.
lockTokenstringOptionalA unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalThe human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.
lockedByUserModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
A complex type containing information about the user that has the envelope or template locked.
lockedUntilDateTimestringOptionalThe date and time that the lock expires.
useScratchPadstringOptionalWhen **true,** a scratchpad is used to edit information.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Locks a template — response body — error Details

FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

Locks an envelope — response body

FieldTypePresenceDescription and constraints
$objectRootEnvelope locks let you lock an envelope to prevent any changes while you are updating an envelope.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
lockDurationInSecondsstringOptional
The number of seconds until the lock expires when there is no activity on the envelope.

The default value is 300 seconds. The maximum value is 1,800 seconds.

The lock duration can be extended.
lockTokenstringOptionalA unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock.
lockTypestringOptionalThe type of lock. Currently `edit` is the only supported type.
lockedByAppstringOptionalThe human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur.
lockedByUserModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
A complex type containing information about the user that has the envelope or template locked.
lockedUntilDateTimestringOptionalThe date and time that the lock expires.
useScratchPadstringOptionalWhen **true,** a scratchpad is used to edit information.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Modifies tab settings for specified account — response body

FieldTypePresenceDescription and constraints
$objectRoot
allowTabOrderstringOptionalWhen **true,** account users can set a tab order for the signing process.

**Note:** Only Admin users can change this setting.
allowTabOrderMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `allowTabOrder` property is editable.
approveDeclineTabsEnabledstringOptionalWhen **true,** approve and decline tabs are enabled.
approveDeclineTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `approveDeclineTabs` property is editable.
calculatedFieldsEnabledstringOptionalWhen **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs.
calculatedFieldsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `calculatedFields` property is editable.
checkBoxTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `checkBoxTabs` property is editable.
checkboxTabsEnabledstringOptionalWhen **true,** checkbox tabs are enabled.
dataFieldRegexEnabledstringOptionalWhen **true,** regular expressions are enabled for tabs that contain data fields.
dataFieldRegexMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `dataFieldRegex` property is editable.
dataFieldSizeEnabledstringOptionalWhen **true,** setting character limits for input fields is enabled.
dataFieldSizeMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `dataFieldSize` property is editable.
drawTabsEnabledstringOptional
drawTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
enableTabAgreementDetailsstringOptional
enableTabAgreementDetailsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
firstLastEmailTabsEnabledstringOptionalReserved for Docusign.
firstLastEmailTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
listTabsEnabledstringOptionalWhen **true,** list tabs are enabled.
listTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `listTabs` property is editable.
noteTabsEnabledstringOptionalWhen **true,** note tabs are enabled.
noteTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `noteTabs` property is editable.
numericalTabsEnabledstringOptional
numericalTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
prefillTabsEnabledstringOptional
prefillTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
radioTabsEnabledstringOptionalWhen **true,** radio button tabs are enabled.
radioTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `radioTabs` property is editable.
savingCustomTabsEnabledstringOptionalWhen **true,** saving custom tabs is enabled.
savingCustomTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `savingCustomTabs` property is editable.
senderToChangeTabAssignmentsEnabledstringOptionalReserved for Docusign.
senderToChangeTabAssignmentsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
sharedCustomTabsEnabledstringOptionalWhen **true,** shared custom tabs are enabled.
sharedCustomTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `sharedCustomTabs` property is editable.
tabDataLabelEnabledstringOptionalWhen **true,** [data
labels](https://support.docusign.com/en/videos/Data-Labels) are enabled.

**Note:** Only Admin users can change this setting.
tabDataLabelMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `tabDataLabel` property is editable.
tabLocationEnabledstringOptionalReserved for Docusign.
tabLocationMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
tabLockingEnabledstringOptionalWhen **true,** tab locking is enabled.

**Note:** Only Admin users can change this setting.
tabLockingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `tabLocking` property is editable.
tabScaleEnabledstringOptionalReserved for Docusign.
tabScaleMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Reserved for Docusign.
tabTextFormattingEnabledstringOptionalWhen **true,** text formatting (such as font type, font size,
font color, bold, italic, and underline) is enabled for tabs that
support formatting.

**Note:** Only Admin users can change this setting.
tabTextFormattingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `tabTextFormatting` property is editable.
textTabsEnabledstringOptionalWhen **true,** text tabs are enabled.
textTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `textTabs` property is editable.
uriTabsEnabledstringOptional
uriTabsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata

Referenced models: Gets the user account settings for a specified user — response body — locale Metadata

Moves a set of envelopes from their current folder to another folder — request body — body

FieldTypePresenceDescription and constraints
$objectRootInformation for a folder request.
envelopeIdsarrayOptionalAn array of envelope ID GUIDs.
envelopeIds[]stringEach item
foldersarrayOptionalNot used.
folders[]ModelEach itemExpand Creates an envelope — request body — body folders item
fromFolderIdstringOptionalThe ID of the folder that the envelope is being moved from.

Referenced models: Creates an envelope — request body — body folders item

Posts a payment to a past due invoice — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
paymentAmountstringOptionalThe payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices.

Posts a payment to a past due invoice — response body

FieldTypePresenceDescription and constraints
$objectRootDefines an billing payment response object.
billingPaymentsarrayOptionalReserved for Docusign.
billingPayments[]ModelEach itemExpand Posts a payment to a past due invoice — response body — billing Payments item

Referenced models: Posts a payment to a past due invoice — response body — billing Payments item

Posts a payment to a past due invoice — response body — billing Payments item

FieldTypePresenceDescription and constraints
$objectRootContains information on a billing plan.
amountstringOptionalReserved for Docusign.
invoiceIdstringOptionalReserved for Docusign.
paymentIdstringOptionalThe ID of the payment.

Queues downgrade billing plan request for an account — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
downgradeEventTypestringOptional
planInformationModelOptionalExpand Updates an account billing plan — request body — body plan Information
An object used to identify the features and attributes of the account being created.
promoCodestringOptional
saleDiscountstringOptional
saleDiscountPeriodsstringOptionalReserved for Docusign.
saleDiscountTypestringOptional

Referenced models: Updates an account billing plan — request body — body plan Information

Queues downgrade billing plan request for an account — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountPaymentMethodstringOptionalThe type of payment method used for the account. Valid values are:

- `credit_card`
-
discountAppliedstringOptional
downgradeEffectiveDatestringOptional
downgradePaymentCyclestringOptional
downgradePlanIdstringOptional
downgradePlanNamestringOptional
downgradeRequestStatusstringOptional
messagestringOptional
productIdstringOptionalThe Product ID from the AppStore.
promoCodestringOptional
saleDiscountstringOptional
saleDiscountPeriodsstringOptionalReserved for Docusign.
saleDiscountTypestringOptional

Registers the current user as a notary — response body

FieldTypePresenceDescription and constraints
$objectRoot
createdDatestringOptionalThe creation date of the account in UTC timedate format.
enabledstringOptionalThe date the this object was created.
searchablestringOptionalWhen **true,** this notary is searchable.
userInfoModelOptionalExpand 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 registering to be a notary.

Referenced models: 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

Republishes Connect information for multiple envelopes — request body — body

FieldTypePresenceDescription and constraints
$objectRootA list of failed envelope IDs to retry.
envelopeIdsarrayOptionalAn array of envelope GUIDs.

Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
envelopeIds[]stringEach item
synchronousstringOptionalMust be **false.** Setting this property to any other value will result in errors.

Republishes Connect information for multiple envelopes — response body

FieldTypePresenceDescription and constraints
$objectRoot
retryQueuearrayOptionalDetails about a Connect failure result.
retryQueue[]ModelEach itemExpand Republishes Connect information for multiple envelopes — response body — retry Queue item

Referenced models: Republishes Connect information for multiple envelopes — response body — retry Queue item

Republishes Connect information for multiple envelopes — response body — retry Queue item

FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a Connect failure result.
configIdstringOptionalReserved for Docusign.
configUrlstringOptionalReserved for Docusign.
envelopeIdstringOptionalThe envelope ID of the envelope status that failed to post.
statusstringOptionalThe connection status.
statusMessagestringOptionalA human-readable message describing the connection status.

Reserved: Gets the shared item status for one or more users — response body

FieldTypePresenceDescription and constraints
$objectRootContains shared access information.
accountIdstringOptionalThe account ID associated with the envelope.
endPositionstringOptionalThe last index position in the result set.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
A complex type containing an errorCode and message identifying the error that occurred.
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`.
sharedAccessarrayOptionalA list of shared access information of envelope and templates for the users specified in the request.
sharedAccess[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item
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: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item

Reserved: Gets the shared item status for one or more users — response body — shared Access item

FieldTypePresenceDescription and constraints
$objectRootInformation about shared items.
envelopesarrayOptionalList of information about shared envelopes.
envelopes[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
foldersarrayOptionalList of information about shared folders.
folders[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item
templatesarrayOptionalList of information about shared templates.
templates[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item
userModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user requesting sharing information.

Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item, Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item, Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item, Gets a specific template associated with a specified account — response body — owner

Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item

FieldTypePresenceDescription and constraints
$objectRootInformation about the shared item.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
sharedstringOptionalHow the item is shared. One of:

- `not_shared`
- `shared_to`
- `shared_from`
- `shared_to_and_from`
userModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the shared item.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item

FieldTypePresenceDescription and constraints
$objectRoot
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
folderIdstringOptionalThe ID of 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.
parentFolderUristringOptionalThe URI for the parent folder.
sharedstringOptionalIndicates how the folder is shared. Valid values are:

- `not_shared`
- `shared_to`
sharedGroupsarrayOptionalA list of groups that share the folder.
sharedGroups[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item
sharedUsersarrayOptionalA list of users that share the folder.
sharedUsers[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
uristringOptionalA URI containing the user ID.
userModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user associated with the folder.

Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item, Gets a specific template associated with a specified account — response body — owner, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item

Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item

FieldTypePresenceDescription and constraints
$objectRootInformation about items shared among groups.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
groupModelOptionalExpand Deletes an existing user group — response body — groups item
The group sharing the item.
sharedstringOptionalHow the item is shared. One of:


- `not_shared`: The item is not shared.

- `shared_to`: The item is shared.

Referenced models: Locks a template — response body — error Details, Deletes an existing user group — response body — groups item

Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item

FieldTypePresenceDescription and constraints
$objectRootInformation about a shared item.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
sharedstringOptionalHow the item is shared. One of:

- `not_shared`
- `shared_to`
- `shared_from`
- `shared_to_and_from`
userModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
The user whose sharing information is being requested.

Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner

Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item

FieldTypePresenceDescription and constraints
$objectRootInformation about shared templates.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
ownerModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who owns the template.
passwordstringOptionalThe user's password.

This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).

This property is not returned by `GET` requests and cannot be updated via `PUT` requests.
sharedstringOptionalHow the template is shared. One of:

- `not_shared`
- `shared_to`
sharedGroupsarrayOptionalList of groups that share the template.
sharedGroups[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item
sharedUsersarrayOptionalList of users that share the template.
sharedUsers[]ModelEach itemExpand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
templateIdstringOptionalThe unique identifier of the template. If this is not provided, Docusign will generate a value.
templateNamestringOptionalThe name of the shared template.

Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item, Gets a specific template associated with a specified account — response body — owner, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item

Reserved: Purchase additional envelopes — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
amountstringOptionalThe total amount of the purchase.
appNamestringOptionalThe AppName of the client application.
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase.
platformstringOptionalThe Platform of the client application
productIdstringOptionalThe Product ID from the AppStore.
quantitystringOptionalThe quantity of envelopes to add to the account.
receiptDatastringOptionalThe encrypted Base64 encoded receipt data.
storeNamestringOptionalThe name of the AppStore.
transactionIdstringOptionalSpecifies the Transaction ID from the AppStore.

Retrieves a billing invoice — response body

FieldTypePresenceDescription and constraints
$objectRootContains information about a billing invoice.
amountstringOptionalThe total amount of the purchase.
balancestringOptionalReserved for Docusign.
dueDatestringOptionalReserved for Docusign.
invoiceIdstringOptionalReserved for Docusign.
invoiceItemsarrayOptionalReserved for Docusign.
invoiceItems[]ModelEach itemExpand Retrieves a billing invoice — response body — invoice Items item
invoiceNumberstringOptionalReserved for Docusign.
invoiceUristringOptionalContains a URI for an endpoint that you can use to retrieve invoice information.
nonTaxableAmountstringOptional
pdfAvailablestringOptional
taxableAmountstringOptional

Referenced models: Retrieves a billing invoice — response body — invoice Items item

Retrieves a billing invoice — response body — invoice Items item

FieldTypePresenceDescription and constraints
$objectRootContains information about an item on a billing invoice.
chargeAmountstringOptionalReserved for Docusign.
chargeNamestringOptionalReserved for Docusign.
invoiceItemIdstringOptionalReserved for Docusign.
quantitystringOptionalThe quantity of envelopes to add to the account.
taxAmountstringOptional
taxExemptAmountstringOptional
unitPricestringOptionalReserved for Docusign.

Retrieves the HTML definition used to generate a dynamically sized responsive document — response body

FieldTypePresenceDescription and constraints
$objectRoot
htmlDefinitionsarrayOptionalHolds the properties that define how to generate the responsive-formatted HTML for the document.
htmlDefinitions[]ModelEach itemExpand Retrieves the HTML definition used to generate a dynamically sized responsive document — response body — html Definitions item

Referenced models: Retrieves the HTML definition used to generate a dynamically sized responsive document — response body — html Definitions item

Retrieves the HTML definition used to generate a dynamically sized responsive document — response body — html Definitions item

FieldTypePresenceDescription and constraints
$objectRoot
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
documentIdGuidstringOptionalThe GUID of the document.
htmlDefinitionModelOptionalExpand Gets a specific template associated with a specified account — response body — documents item html Definition
Defines how to generate the responsive-formatted HTML for the document.

Referenced models: Gets a specific template associated with a specified account — response body — documents item html Definition

Retrieves the Identity Verification workflows available to an account — response body

FieldTypePresenceDescription and constraints
$objectRoot
identityVerificationarrayOptionalSpecifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
identityVerification[]ModelEach itemExpand Gets account settings information — response body — identity Verification item

Referenced models: Gets account settings information — response body — identity Verification item

Retrieves the account information for the specified account — response body

FieldTypePresenceDescription and constraints
$objectRootContains account Information.
accountIdGuidstringOptionalThe GUID associated with the account ID.
accountNamestringOptionalThe name of the current account.
accountSettingsModelOptionalExpand Gets account settings information — response body
The list of
account settings accountsettings
that determine
the features available for the account.
Note that some features are determined
by the plan used to create the account and cannot be overridden.

allowTransactionRoomsstringOptionalWhen **true,** the transaction rooms feature exposed through the Workspaces API is enabled.
billingPeriodDaysRemainingstringOptionalNumber of days remaining in the current billing period.
billingPeriodEndDatestringOptionalThe billing period end date in UTC timedate format.
billingPeriodEnvelopesAllowedstringOptionalThe number of envelopes that can be sent in the current billing period (can be unlimited).
billingPeriodEnvelopesSentstringOptionalThe number of envelopes that have been sent in the current billing period.
billingPeriodStartDatestringOptionalThe billing period start date in UTC timedate format.
billingProfilestringOptionalReserved for Docusign.
brandsModelOptionalExpand Gets a list of brands — response body
A list of brands.
canUpgradestringOptionalWhen **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response.
connectPermissionstringOptionalValue is "full" when Connect is enabled for this account.
createdDatestringOptionalThe creation date of the account in UTC timedate format.
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
currentPlanIdstringOptionalID of the plan used to create this account.
displayApplianceStartUrlstringOptional
displayApplianceUrlstringOptional
distributorCodestringOptionalThe code that identifies the billing plan groups and plans for the new account.
docuSignLandingUrlstringOptionalURL of the landing page used to create the account.
dssValuesobjectOptionalAdditional keys: see wildcard field
dssValues.*stringAdditional keys
envelopeSendingBlockedstringOptionalWhen **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent.
envelopeUnitPricestringOptionalThe price of sending an envelope, represented in the account's local currency.
externalAccountIdstringOptionalThe Account ID displayed on the user's Account page.
forgottenPasswordQuestionsCountstringOptionalA complex element that contains up to four Question/Answer pairs for forgotten password information for a user.
freeEnvelopeSendsRemainingForAdvancedDocGenJSONOptional
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 1)integerAlternativeFormat: int32
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
isDowngradestringOptionalWhen **true,** the account has been downgraded from a premium account type. Otherwise **false.**
isFreeToTrialEligiblestringOptional
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

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

- `business`
- `corporate`
- `enterprise`
- `free`
planEndDatestringOptionalThe date that the current plan will end.
planNamestringOptionalThe name of the Billing Plan.
planStartDatestringOptionalThe date that the Account started using the current plan.
recipientDomainsarrayOptional
recipientDomains[]ModelEach itemExpand Retrieves the account information for the specified account — response body — recipient Domains item
seatsAllowedstringOptionalThe number of active users the account can have at one time.
seatsInUsestringOptionalThe number of users currently active on the account.
status21CFRPart11stringOptionalThe status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy.
suspensionDatestringOptionalThe date on which the account was suspended.
suspensionStatusstringOptionalIndicates whether the account is currently suspended.
useDisplayAppliancebooleanOptional

Referenced models: Gets a list of brands — response body, Gets account settings information — response body, Retrieves the account information for the specified account — response body — recipient Domains item

Retrieves the account information for the specified account — response body — recipient Domains item

FieldTypePresenceDescription and constraints
$objectRoot
activestringOptional
domainCodestringOptional
domainNamestringOptional
recipientDomainIdstringOptional

Retrieves the account provisioning information for the account — response body

FieldTypePresenceDescription and constraints
$objectRoot
defaultConnectionIdstringOptional
defaultPlanIdstringOptional
distributorCodestringOptionalThe code that identifies the billing plan groups and plans for the new account.
distributorPasswordstringOptionalThe password for the `distributorCode`.
passwordRuleTextstringOptional
planPromotionTextstringOptional
purchaseOrderOrPromAllowedstringOptional

Retrieves the available REST API versions — response body

FieldTypePresenceDescription and constraints
$objectRoot
buildBranchstringOptionalReserved for Docusign.
buildBranchDeployedDateTimestringOptionalReserved for Docusign.
buildSHAstringOptionalReserved for Docusign.
buildVersionstringOptionalReserved for Docusign.
linkedSitesarrayOptional
linkedSites[]stringEach item
serviceVersionsarrayOptional
serviceVersions[]ModelEach itemExpand Retrieves the available REST API versions — response body — service Versions item

Referenced models: Retrieves the available REST API versions — response body — service Versions item

Retrieves the available REST API versions — response body — service Versions item

FieldTypePresenceDescription and constraints
$objectRoot
versionstringOptionalThe version of the rest API.
versionUrlstringOptional

Retrieves the list of users for the specified account You can filter the users list to get specific users — response body

FieldTypePresenceDescription and constraints
$objectRootContains a list of account users.
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`.
usersarrayOptionalUser management information.
users[]ModelEach itemExpand 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

Referenced models: 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

Retrieves the user profile for a specified user — response body

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Get credit card information — response body — address
The user's address.
authenticationMethodsarrayOptionalIndicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation.
authenticationMethods[]ModelEach itemExpand Retrieves the user profile for a specified user — response body — authentication Methods item
companyNamestringOptionalThe name of the user's company.
displayOrganizationInfostringOptionalWhen **true,** the user's company and title information display on the ID card.
displayPersonalInfostringOptionalWhen **true,** the user's address and phone number display on the ID card.
displayProfilestringOptionalWhen **true,** the user's ID card can be viewed from signed documents and envelope history.
displayUsageHistorystringOptionalWhen **true,** the user's usage information displays on the ID card.
profileImageUristringOptionalThe URL for retrieving the user's profile image.
titlestringOptionalThe title of the user.
usageHistoryModelOptionalExpand Retrieves the user profile for a specified user — response body — usage History
A complex element consisting of:

- `lastSentDateTime`: The date and time the user last sent an envelope.
- `lastSignedDateTime`: The date and time the user last signed an envelope.
- `sentCount`: The number of envelopes the user has sent.
- `signedCount`: The number of envelopes the user has signed.
userDetailsModelOptionalExpand 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
userProfileLastModifiedDatestringOptionalThe date and time that the user's profile was last modified.

Referenced models: Get credit card information — response body — address, Retrieves the user profile for a specified user — response body — authentication Methods item, Retrieves the user profile for a specified user — response body — usage History, 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

Retrieves the user profile for a specified user — response body — authentication Methods item

FieldTypePresenceDescription and constraints
$objectRootContains information about the method used for authentication.
authenticationTypestringOptionalIndicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth.
lastProviderstringOptionalThe last provider that authenticated the user.
lastTimestampstringOptionalThe data and time the user last used the authentication method.
totalCountstringOptionalThe number of times the authentication method was used.

Retrieves the user profile for a specified user — response body — usage History

FieldTypePresenceDescription and constraints
$objectRootA complex element consisting of:

* lastSentDateTime - the date and time the user last sent an envelope.
* lastSignedDateTime - the date and time the user last signed an envelope.
* sentCount - the number of envelopes the user has sent.
* signedCount - the number of envelopes the user has signed.
lastSentDateTimestringOptionalThe date and time the user last sent an envelope.
lastSignedDateTimestringOptionalThe date and time the user last signed an envelope.
sentCountstringOptionalThe number of envelopes the user has sent.
signedCountstringOptionalThe number of envelopes the user has signed.

Returns a URL to the edit view UI Use before an envelope has been sent — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
returnUrlstringOptional**Required**

Identifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are:

* send (user sends the envelope)
* save (user saves the envelope)
* cancel (user cancels the sending transaction. No envelopeId is returned in this case.)
* error (there is an error when performing the send)
* sessionEnd (the sending session ends before the user completes another action).
settingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings
Sets the UX for the resulting embedded view.
viewAccessstringOptional**Required** . Set to `envelope`

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings

Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings

FieldTypePresenceDescription and constraints
$objectRoot
backButtonActionstringOptionalSets the behavior of the back button when clicked. Valid values:
* `previousPage`: Navigate to browser's previous page
* `redirect`: Redirect to the `returnUrl` specified in the request
documentSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings
Sets the custom document settings.
envelopeCustomFieldSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings
Reserved for Docusign.
lockTokenstringOptionalIf your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
recipientSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings
sendButtonActionstringOptionalSets the behavior of the send button when clicked. Valid values:
* `send`: send the envelope and redirect with query parameter `event=Send` (default)
* `redirect`: Change the Tagger page's button text to 'Continue'; when clicked, redirect to the `returnUrl` with query parameter `event=Save`. Set `showBackButton` to `false` and `startingScreen` to `Tagger`.
showAdvancedOptionsstringOptionalReserved for Docusign.
showBackButtonstringOptionalDetermines whether the Tagger's back button is shown. Valid values:

* `true`: The back button is shown. This is the default value.
* `false`: Prevents access to the Prepare screen by hiding the back button.
showDiscardActionstringOptionalWhen **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**
showHeaderActionsstringOptionalDetermines whether the Actions menu displays advanced actions. Valid values:

* `true`: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value.
* `false`: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set `startingScreen` to `Tagger` and `showBackButton` to `false`.
showSignNowstringOptional
startingScreenstringOptionalDetermines the starting screen for the sender view. Valid values:

* `Prepare` (default)
* `Tagger`
taggerSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings
Sets the custom tagger settings.
templateSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings
Reserved for Docusign.

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings

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.