Retrieves the account information for the specified account.

Response The canUpgrade property contains is a Boolean that indicates whether the account can be upgraded through the API.

Request

HTTP request

GET /v2.1/accounts/{accountId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Optional Query Parameters
include_account_settingsstring

When set to true, includes account settings (defined by the accountSettings property) in the response. If you omit this parameter, the default behavior is false.

Responses

CodeDescriptionReference
200

Successful response.

Accounts
400

Error encountered.

errorDetails

SDK Method

Accounts::GetAccountInformation

Definitions

accessCodeFormat

Object specifying the format of the string provided to a recipient in order to access an envelope.

formatRequiredstring

Boolean specifying whether this format configuration is required.

formatRequiredMetadatasettingsMetadata

Metadata indicating whether the formatRequired property is editable.

letterRequiredstring

Boolean specifying whether alphabetical characters are required in the access code string.

letterRequiredMetadatasettingsMetadata

Metadata indicating whether the letterRequired property is editable.

minimumLengthstring

Minimum length of the access code string.

minimumLengthMetadatasettingsMetadata

Metadata indicating whether the minimumLength property is editable.

numberRequiredstring

Boolean specifying whether numerical characters (0-9) are required in the access code string.

numberRequiredMetadatasettingsMetadata

Metadata indicating whether the numberRequired property is editable.

specialCharacterRequiredstring

Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'.

specialCharacterRequiredMetadatasettingsMetadata

Metadata indicating whether the specialCharacterRequired property is editable.

accountIdentityVerificationWorkflow

Specifies an Identity Verification workflow.

defaultDescriptionstring

Text describing the purpose of the Identity Verification workflow.

defaultNamestring

The name of the Identity Verification workflow.

signatureProvideraccountSignatureProvider

The signature provider associated with the Identity Verification workflow.

workflowIdstring

Workflow unique ID
This is the ID you must specify when setting ID Verification in an envelope using the identityVerification core recipient parameter

workflowResourceKeystring

Reserved for DocuSign.

accountNotification

A complex element that specifies notifications (expirations and reminders) for the envelope.

expirationsexpirations

A complex element that specifies the expiration settings for the envelope.

remindersreminders

A complex element that specifies reminder settings for the envelope

userOverrideEnabledstring

When true, the user can override envelope expirations.

accountSettingsInformation

Contains account settings information. Used in requests to set property values. Used in responses to report property values.

accessCodeFormataccessCodeFormat

Format of the string provided to a recipient in order to access an envelope.

accountDateTimeFormatstring

UTC date/time format for the account.

accountDateTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the accountDateTimeFormat property is editable.

accountNamestring

The name on the account.

accountNameMetadatasettingsMetadata

Metadata that indicates whether the accountName property is editable.

accountNotificationaccountNotification

An object that specifies notifications (expirations and reminders) for the envelope.

accountUISettingsaccountUISettings

An object that defines the settings to use in the UI.

adoptSigConfigstring

When set to true, Signature Adoption Configuration is enabled.

Note: Only Admin users can change this setting.

adoptSigConfigMetadatasettingsMetadata

Metadata that indicates whether the adoptSigConfig property is editable.

advancedCorrectstring

If true, the Advanced Correction feature is enabled for this account.

advancedCorrectMetadatasettingsMetadata

Metadata that indicates whether the advancedCorrect property is editable.

allowAccessCodeFormatstring

When true, the configured Access Code Format page is enabled for account administrators.

Note: Only Admin users can change this setting.

allowAccessCodeFormatMetadatasettingsMetadata

Metadata that indicates whether the allowAccessCodeFormat property is editable.

allowAccountManagementGranularstring

When true, the account can be managed on a per-user basis.

Note: Only Admin users can change this setting.

allowAccountManagementGranularMetadatasettingsMetadata

Metadata that indicates whether the allowAccountManagementGranular property is editable.

allowAccountMemberNameChangestring

Boolean that specifies whether member names can be changed in the account.

allowAccountMemberNameChangeMetadatasettingsMetadata

Metadata that indicates whether the allowAccountMemberNameChange property is editable.

allowAdvancedRecipientRoutingConditionalstring

When set to true, Conditional Routing is enabled for the account as part of DocuSign's Advanced Recipient Routing feature.

allowAdvancedRecipientRoutingConditionalMetadatasettingsMetadata

Metadata that indicates whether the allowAdvancedRecipientRoutingConditional property is editable.

allowAgentNameEmailEditstring

If true, an agent recipient can change the email addresses of recipients later in the signing order.

allowAgentNameEmailEditMetadatasettingsMetadata

Metadata that indicates whether the allowAgentNameEmailEdit property is editable.

allowAgreementActionsstring

allowAgreementActionsMetadatasettingsMetadata

Metadata about the allowAgreementActions property.

allowAutoNavSettingsstring

If true, auto-navigation can be enabled for this account.

allowAutoNavSettingsMetadatasettingsMetadata

Metadata that indicates whether the allowAutoNavSettings property is editable.

allowAutoTaggingstring

If true, auto-tagging is enabled for the account.

allowAutoTaggingMetadatasettingsMetadata

Metadata that indicates whether the allowAutoTagging property is editable.

allowBulkSendstring

When set to true, bulk send functionality is enabled for the account.

Note: Only Admin users can change this setting.

allowBulkSendMetadatasettingsMetadata

Metadata that indicates whether the allowBulkSend property is editable.

allowCDWithdrawstring

When set to true, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is false. Note: Only Admin users can change this setting.

allowCDWithdrawMetadatasettingsMetadata

Metadata that indicates whether the allowCDWithdraw property is editable.

allowConnectHttpListenerConfigsstring

Boolean that specifies whether a Connect configuration can use HTTP listeners.

allowConnectSendFinishLaterstring

Reserved for DocuSign.

allowConnectSendFinishLaterMetadatasettingsMetadata

Metadata that indicates whether the allowConnectSendFinishLater property is editable.

allowConsumerDisclosureOverridestring

If true, the account has the ability to change the Consumer Disclosure setting.

allowConsumerDisclosureOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowConsumerDisclosureOverride property is editable.

allowDataDownloadstring

When set to true, senders can download form data from the envelopes that they send.

Note: Only Admin users can change this setting.

allowDataDownloadMetadatasettingsMetadata

Metadata that indicates whether the allowDataDownload property is editable.

allowDocumentDisclosuresstring

Boolean that specifies whether disclosure documents can be included in envelopes.

allowDocumentDisclosuresMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentDisclosures property is editable.

allowDocumentsOnSignedEnvelopesstring

Boolean that specifies whether notifications can include the envelope's signed document.

allowDocumentsOnSignedEnvelopesMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentsOnSignedEnvelopes property is editable.

allowDocumentVisibilitystring

When true, the Document Visibility feature is enabled for the account.

allowDocumentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentVisibility property is editable.

allowEHankoStampsstring

When true, eHanko stamps are enabled.

allowEHankoStampsMetadatasettingsMetadata

Metadata that indicates whether the allowEHankoStamps property is editable.

allowENoteEOriginalstring

Specifies whether eNote eOriginal integration is enabled.

allowENoteEOriginalMetadatasettingsMetadata

Metadata that indicates whether the allowENoteEOriginal property is editable.

allowEnvelopeCorrectstring

When set to true, the envelope correction feature is enabled.

Note: Only Admin users can change this setting.

allowEnvelopeCorrectMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCorrect property is editable.

allowEnvelopeCustodyTransferstring

Specifies whether the account is able to manage rules that transfer ownership of envelopes within the same account.

allowEnvelopeCustodyTransferMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCustodyTransfer property is editable.

allowEnvelopeCustomFieldsstring

Specifies whether envelope custom fields are enabled.

allowEnvelopeCustomFieldsMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCustomFields property is editable.

allowEnvelopePublishReportingstring

When set to true, envelope publishing reporting is enabled.

Note: Only Admin users can change this setting.

allowEnvelopePublishReportingMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopePublishReporting property is editable.

allowEnvelopeReportingstring

Specifies whether the account has access to reports.

allowEnvelopeReportingMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeReporting property is editable.

allowExpressionstring

If the account plan does not include calculated fields, this setting allows an account to use them.

allowExpressionMetadatasettingsMetadata

Metadata that indicates whether the allowExpression property is editable.

allowExpressSignerCertificatestring

When set to true, signers are required to use Express Digital Signatures.

Note: Only Admin users can change this setting.

allowExpressSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowExpressSignerCertificate property is editable.

allowExtendedSendingResourceFilestring

Boolean that specifies whether resource files can be used for extended sending.

allowExtendedSendingResourceFileMetadatasettingsMetadata

Metadata that indicates whether the allowExtendedSendingResourceFile property is editable.

allowExternalSignaturePadstring

When set to true, the account can configure and use signature pads for their recipients.

Note: Only Admin users can change this setting.

allowExternalSignaturePadMetadatasettingsMetadata

Metadata that indicates whether the allowExternalSignaturePad property is editable.

allowIDVLevel1string

When set to true, IDV Level 1 is allowed. The default value is false.

allowIDVLevel1MetadatasettingsMetadata

Metadata that indicates whether the allowIDVLevel1 property is editable.

allowIDVPlatformstring

allowIDVPlatformMetadatasettingsMetadata

Metadata that indicates whether the allowIDVPlatform property is editable.

allowInPersonstring

When set to true, the account administrator can enable in-person signing.

Note: Only SysAdmin users can change this setting.

allowInPersonMetadatasettingsMetadata

Metadata that indicates whether the allowInPerson property is editable.

allowManagedStampsstring

When true, Managed Stamps are enabled.

allowManagedStampsMetadatasettingsMetadata

Metadata that indicates whether the allowManagedStamps property is editable.

allowMarkupstring

When set to true, the Document Markup feature is enabled.

Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level.

allowMarkupMetadatasettingsMetadata

Metadata that indicates whether the allowMarkup property is editable.

allowMemberTimeZonestring

When set to true, account users can set their own time zone settings.

Note: Only Admin users can change this setting.

allowMemberTimeZoneMetadatasettingsMetadata

Metadata that indicates whether the allowMemberTimeZone property is editable.

allowMergeFieldsstring

When set to true, the account can use merge fields with DocuSign for Salesforce.

allowMergeFieldsMetadatasettingsMetadata

Metadata that indicates whether the allowMergeFields property is editable.

allowMultipleBrandProfilesstring

Specifies whether the account supports multiple brands.

allowMultipleBrandProfilesMetadatasettingsMetadata

Metadata that indicates whether the allowMultipleBrandProfiles property is editable.

allowMultipleSignerAttachmentsstring

When set to true, recipients can upload multiple signer attachments with a single attachment.

Note: Only Admin users can change this setting.

allowMultipleSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the allowMultipleSignerAttachments property is editable.

allowNonUSPhoneAuthstring

Specifies whether users can use international numbers for phone authentication.

allowNonUSPhoneAuthMetadatasettingsMetadata

Metadata that indicates whether the allowNonUSPhoneAuth property is editable.

allowOfflineSigningstring

When set to true, offline signing is enabled for the account.

Note: Only Admin users can change this setting.

allowOfflineSigningMetadatasettingsMetadata

Metadata that indicates whether the allowOfflineSigning property is editable.

allowOpenTrustSignerCertificatestring

When set to true, senders can use OpenTrust signer certificates.

Note: Only Admin users can change this setting.

allowOpenTrustSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowOpenTrustSignerCertificate property is editable.

allowOrganizationsstring

Boolean that specifies whether Organization Administration is enabled for the account.

allowOrganizationsMetadatasettingsMetadata

Metadata that indicates whether the allowOrganizations property is editable.

allowPaymentProcessingstring

When set to true, payment processing is enabled for the account.

Note: Only Admin users can change this setting.

allowPaymentProcessingMetadatasettingsMetadata

Metadata that indicates whether the allowPaymentProcessing property is editable.

allowPersonalSignerCertificatestring

When set to true, signers can use personal signer certificates.

Note: Only Admin users can change this setting.

allowPersonalSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowPersonalSignerCertificate property is editable.

allowPhoneAuthenticationstring

Boolean that specifies whether phone authentication is enabled for the account.

allowPhoneAuthenticationMetadatasettingsMetadata

Metadata that indicates whether the allowPhoneAuthentication property is editable.

allowPhoneAuthOverridestring

Boolean that specifies whether users can override phone authentication.

allowPhoneAuthOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowPhoneAuthOverride property is editable.

allowPrivateSigningGroupsstring

Reserved for DocuSign. This property returns the value false when listing account settings. Read only.

allowPrivateSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the allowPrivateSigningGroups property is editable.

allowRemindersstring

When set to true, an account administrator can to turn on reminders and expiration defaults for the account.

Note: Only Admin users can change this setting.

allowRemindersMetadatasettingsMetadata

Metadata that indicates whether the allowReminders property is editable.

allowResourceFileBrandingstring

If true, resource files can be uploaded in branding.

allowResourceFileBrandingMetadatasettingsMetadata

Metadata that indicates whether the allowResourceFileBranding property is editable.

allowSafeBioPharmaSignerCertificatestring

When set to true, account administrators can specify that signers are required to use SAFE-BioPharma digital signatures.

Note: Only Admin users can change this setting.

allowSafeBioPharmaSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowSafeBioPharmaSignerCertificate property is editable.

allowSecurityAppliancestring

Boolean that specifies whether a DocuSign Signature Appliance can be used with the account.

allowSecurityApplianceMetadatasettingsMetadata

Metadata that indicates whether the allowSecurityAppliance property is editable.

allowSendToCertifiedDeliverystring

If true, the account admin can enable the Send to Certified Delivery feature on the account.

allowSendToCertifiedDeliveryMetadatasettingsMetadata

Metadata that indicates whether the allowSendToCertifiedDelivery property is editable.

allowSendToIntermediarystring

If true, the account admin can enable the Send to Intermediary feature on the account.

allowSendToIntermediaryMetadatasettingsMetadata

Metadata that indicates whether the allowSendToIntermediary property is editable.

allowServerTemplatesstring

If true, the account can use templates.

allowServerTemplatesMetadatasettingsMetadata

Metadata that indicates whether the allowServerTemplates property is editable.

allowSharedTabsstring

When set to true, shared tabs are enabled for the account.

Note: Only Admin users can change this setting.

allowSharedTabsMetadatasettingsMetadata

Metadata that indicates whether the allowSharedTabs property is editable.

allowSignatureStampsstring

When set to true, Signature Stamps are enabled.

Note: Only Admin users can change this setting.

allowSignatureStampsMetadatasettingsMetadata

Metadata that indicates whether the allowSignatureStamps property is editable.

allowSignDocumentFromHomePagestring

When set to true, recipients can sign documents from the home page.

Note: Only Admin users can change this setting.

allowSignDocumentFromHomePageMetadatasettingsMetadata

Metadata that indicates whether the allowSignDocumentFromHomePage property is editable.

allowSignerReassignstring

When set to true, the recipient of an envelope sent from this account can reassign it to another person.

Note: Only Admin users can change this setting.

allowSignerReassignMetadatasettingsMetadata

Metadata that indicates whether the allowSignerReassign property is editable.

allowSignerReassignOverridestring

When set to true, an account administrator can override the ability of an envelope recipient to reassign it to another person.

Note: Only Admin users can change this setting.

allowSignerReassignOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowSignerReassignOverride property is editable.

allowSigningExtensionsstring

Boolean that specifies whether Signing and App Extensions are allowed.

allowSigningExtensionsMetadatasettingsMetadata

Metadata that indicates whether the allowSigningExtensions property is editable.

allowSigningGroupsstring

When set to true, the account allows signing groups. This setting is only shown in responses that list account settings. Read only.

allowSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the allowSigningGroups property is editable.

allowSigningRadioDeselectstring

Boolean that specifies whether the account supports radio buttons on tabs Radio CustomTabType.

allowSigningRadioDeselectMetadatasettingsMetadata

Metadata that indicates whether the allowSigningRadioDeselect property is editable.

allowSignNowstring

If true, the account administrator can enable the Sign Now feature.

allowSignNowMetadatastring

Metadata that indicates whether the allowSignNow property is editable.

allowSocialIdLoginstring

Deprecated.

allowSocialIdLoginMetadatasettingsMetadata

Deprecated.

allowSupplementalDocumentsstring

When true, this user can include supplemental documents.

allowSupplementalDocumentsMetadatasettingsMetadata

Metadata that indicates whether the allowSupplementalDocuments property is editable.

anchorPopulationScopestring

This property determines how template anchor tabs are applied.

Valid values are:

  • document: Anchor tabs are applied only to the document that you specify.
  • envelope: Anchor tabs are applied to all of the documents in the envelope associated with the template.

Note: When you are using the anchorPopulationScope property with a Composite Template, the value document is supported only with a single server template and a single inline template.

anchorPopulationScopeMetadatasettingsMetadata

Metadata that indicates whether the anchorPopulationScope property is editable.

anchorTagVersionedPlacementEnabledstring

Reserved for DocuSign.

anchorTagVersionedPlacementMetadataEnabledsettingsMetadata

attachCompletedEnvelopestring

When set to true, envelope documents are included as a PDF file attachment to "signing completed" emails.

Note: Only SysAdmin users can change this setting.

attachCompletedEnvelopeMetadatasettingsMetadata

Metadata that indicates whether the attachCompletedEnvelope property is editable.

authenticationCheckstring

Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks:

  • Phone Authentication
  • SMS Authentication
  • Knowledge-Based ID

This setting takes one of the following options:

  • initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.
  • each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame.

Note: Only Admin users can change this setting.

authenticationCheckMetadatasettingsMetadata

Metadata that indicates whether the authenticationCheck property is editable.

autoNavRulestring

Specifies how auto-navigation works. Valid values are:

  • off
  • required_fields
  • required_and_blank_fields
  • all_fields
  • page_then_required_fields
  • page_then_required_and_blank_fields
  • page_then_all_fields

autoNavRuleMetadatasettingsMetadata

Metadata that indicates whether the autoNavRule property is editable.

autoProvisionSignerAccountstring

Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)

autoProvisionSignerAccountMetadatasettingsMetadata

Metadata that indicates whether the autoProvisionSignerAccount property is editable.

bccEmailArchivestring

Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.

bccEmailArchiveMetadatasettingsMetadata

Metadata that indicates whether the bccEmailArchive property is editable.

betaSwitchConfigurationstring

Reserved for DocuSign.

betaSwitchConfigurationMetadatasettingsMetadata

Reserved for DocuSign.

billingAddressaddressInformation

The billing address for the account.

billingAddressMetadatasettingsMetadata

Metadata that indicates whether the billingAddress property is editable.

bulkSendstring

When true, this user can use the bulk send feature for the account.

bulkSendMetadatasettingsMetadata

Metadata that indicates whether the bulkSend property is editable.

canSelfBrandSendstring

When set to true, account administrators can self-brand their sending console through the DocuSign console.

canSelfBrandSendMetadatasettingsMetadata

Metadata that indicates whether the canSelfBrandSend property is editable.

canSelfBrandSignstring

When set to true, account administrators can self-brand their signing console through the DocuSign console.

canSelfBrandSignMetadatasettingsMetadata

Metadata that indicates whether the canSelfBrandSign property is editable.

captureVoiceRecordingstring

Reserved for DocuSign.

captureVoiceRecordingMetadatasettingsMetadata

Reserved for DocuSign.

cfrUseWideImagestring

Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.

cfrUseWideImageMetadatasettingsMetadata

Metadata that indicates whether the cfrUseWideImage property is editable.

checkForMultipleAdminsOnAccountstring

checkForMultipleAdminsOnAccountMetadatasettingsMetadata

Metadata that indicates whether the checkForMultipleAdminsOnAccount property is editable.

chromeSignatureEnabledstring

Boolean that specifies whether the signers of the envelopes from this account use a signature with a DocuSign chrome around it or not.

chromeSignatureEnabledMetadatasettingsMetadata

Metadata that indicates whether the chromeSignatureEnabled property is editable.

commentEmailShowMessageTextstring

When set to true, the text of comments is included in email notifications when a comment is posted.

Note: If the envelope requires additional recipient authentication, comment text is not included.

commentEmailShowMessageTextMetadatasettingsMetadata

Metadata that indicates whether the commentEmailShowMessageText property is editable.

commentsAllowEnvelopeOverridestring

When set to true and comments are enabled for the account, senders can disable comments for an envelope through the Advanced Options menu that appears during the sending process.

commentsAllowEnvelopeOverrideMetadatasettingsMetadata

Metadata that indicates whether the commentsAllowEnvelopeOverride property is editable.

conditionalFieldsEnabledstring

When set to true, conditional fields can be used in documents.

Note: Only Admin users can change this setting.

conditionalFieldsEnabledMetadatasettingsMetadata

Metadata that indicates whether the conditionalFieldsEnabled property is editable.

consumerDisclosureFrequencystring

Speficies how often to display the consumer disclosure.

Valid values are:

  • once: Per account, the supplemental document is displayed once only per userId.
  • always: Per envelope, the supplemental document is displayed once only per userId.
  • each_access: Per envelope, the supplemental document is displayed once only per recipientId.

consumerDisclosureFrequencyMetadatasettingsMetadata

Metadata that indicates whether the consumerDisclosureFrequency property is editable.

convertPdfFieldsstring

Boolean that specifies whether to enable PDF form fields to get converted to DocuSign secure fields when the document is added or uploaded to an envelope.

convertPdfFieldsMetadatasettingsMetadata

Metadata that indicates whether the convertPdfFields property is editable.

dataPopulationScopestring

Specifies how data is shared for tabs with the same tabLabel. Valid values are:

  • document: Tabs in a document with the same label populate with the same data.
  • envelope: Tabs in all documents in the envelope with the same label populate with the same data.

This setting applies to the following tab types:

  • Check box
  • Company
  • Data field
  • Drop-down list
  • Full name
  • Formula
  • Note
  • Title

Note: Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed.

dataPopulationScopeMetadatasettingsMetadata

Metadata that indicates whether the dataPopulationScope property is editable.

disableMobileAppstring

When true, the mobile app distributor key is prevented from connecting for account users.

disableMobileAppMetadatasettingsMetadata

Metadata that indicates whether the disableMobileApp property is editable.

disableMobilePushNotificationsstring

When set to true, push notifications are disabled for the account.

Note: Only Admin users can change this setting.

disableMobilePushNotificationsMetadatasettingsMetadata

Metadata that indicates whether the disableMobilePushNotifications property is editable.

disableMobileSendingstring

When set to true, sending from a mobile application is disabled.

Note: Only Admin users can change this setting.

disableMobileSendingMetadatasettingsMetadata

Metadata that indicates whether the disableMobileSending property is editable.

disableMultipleSessionsstring

When set to true, account users cannot be logged into multiple sessions at the same time.

Note: Only Admin users can change this setting.

disableMultipleSessionsMetadatasettingsMetadata

Metadata that indicates whether the disableMultipleSessions property is editable.

disablePurgeNotificationsForSenderMetadatasettingsMetadata

Reserved for DocuSign.

disableSignerCertViewstring

When true, signers cannot view certificates of completion.

disableSignerCertViewMetadatasettingsMetadata

Metadata that indicates whether the disableSignerCertView property is editable.

disableSignerHistoryViewstring

When true, signers cannot view envelope history.

disableSignerHistoryViewMetadatasettingsMetadata

Metadata that indicates whether the disableSignerHistoryView property is editable.

disableStyleSignaturestring

When true, the Select Style option is hidden from signers and they must draw their signature instead.

disableStyleSignatureMetadatasettingsMetadata

Metadata that indicates whether the disableStyleSignature property is editable.

disableUploadSignaturestring

When set to true, signers cannot upload custom image files of their signature and initials.

Note: Only Admin users can change this setting.

disableUploadSignatureMetadatasettingsMetadata

Metadata that indicates whether the disableUploadSignature property is editable.

disableUserSharingstring

When true, the User Sharing feature is disabled for the account.

disableUserSharingMetadatasettingsMetadata

Metadata that indicates whether the disableUserSharing property is editable.

displayBetaSwitchstring

Boolean that specifies whether to display a Beta switch for your app.

displayBetaSwitchMetadatasettingsMetadata

Metadata that indicates whether the displayBetaSwitch property is editable.

documentConversionRestrictionsstring

Sets the account document upload restriction for non-account administrators. Valid values are:

  • no_restrictions: There are no restrictions on the type of documents that can be uploaded.
  • allow_pdf_only: Non-administrators can only upload PDF files.
  • no_upload: Non-administrators cannot upload files.

Note: Only Admin users can change this setting.

documentConversionRestrictionsMetadatasettingsMetadata

Metadata that indicates whether the documentConversionRestrictions property is editable.

documentRetentionstring

Sets a document retention period, which controls the number of days that DocuSign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is 356 days.

documentRetentionMetadatasettingsMetadata

Metadata that indicates whether the documentRetention property is editable.

documentRetentionPurgeTabsstring

When set to true and documentRetention is set, document fields and metadata are also purged after the document retention period ends. The default value is false.

Note: Only Admins can change this setting.

documentVisibilitystring

Configures the Document Visibility feature for the account. Valid values are:

  • Off: Document Visibility is not active for the account.
  • MustSignToViewUnlessSenderAccount: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope.
  • MustSignToViewUnlessSender: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope.
  • SenderCanSetMustSignToViewUnlessSenderAccount: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account. Vd- SenderCanSetMustSignToViewUnlessSender: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender.

Note: For this configuration to take effect, allowDocumentVisibility must be set to true.

documentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the documentVisibility property is editable.

emailTemplateVersionstring

Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account.

emailTemplateVersionMetadatasettingsMetadata

Metadata that indicates whether the emailTemplateVersion property is editable.

enableAccessCodeGeneratorstring

When true, enables Access Code Generator on the account.

enableAccessCodeGeneratorMetadatasettingsMetadata

Metadata that indicates whether the enableAccessCodeGenerator property is editable.

enableAdvancedPaymentsstring

When true, enables Advanced Payments for the account.

enableAdvancedPaymentsMetadatasettingsMetadata

Metadata that indicates whether the enableAdvancedPayments property is editable.

enableAdvancedPowerFormsstring

When true, enables advanced PowerForms for the account.

enableAdvancedPowerFormsMetadatasettingsMetadata

Metadata that indicates whether the enableAdvancedPowerForms property is editable.

enableAutoNavstring

When true, enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope.

Note: To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set.

enableAutoNavMetadatasettingsMetadata

Metadata that indicates whether the enableAutoNav property is editable.

enableCalculatedFieldsstring

When set to true, calculated fields are enabled for the account.

Note: This setting can be changed only by Admin users, and only if the account-level setting allowExpression is set to true.

enableCalculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the enableCalculatedFields property is editable.

enableClickwrapsstring

Boolean that specifies whether clickwraps are enabled in your app. A clickwrap is an iframe that you embed in your own website or app.

enableClickwrapsMetadatasettingsMetadata

Metadata that indicates whether the enableClickwraps property is editable.

enableCustomerSatisfactionMetricTrackingstring

When true, enables customer satisfaction metric tracking for the account.

enableCustomerSatisfactionMetricTrackingMetadatasettingsMetadata

Metadata that indicates whether the enableCustomerSatisfactionMetricTracking property is editable.

enableDSProstring

Reserved for DocuSign.

enableDSProMetadatasettingsMetadata

Metadata that indicates whether the enableDSPro property is editable.

enableEnvelopeStampingByAccountAdminstring

When set to true, enables the account administrator to control envelope stamping for an account (stamping the envelopeId in the the document margins).

Note: This setting can be changed only by Admin users, and only if the account-level setting enableEnvelopeStampingByDSAdmin is set to true.

enableEnvelopeStampingByAccountAdminMetadatasettingsMetadata

Metadata that indicates whether the enableEnvelopeStampingByAccountAdmin property is editable.

enableEnvelopeStampingByDSAdminstring

When true, enables the DocuSign administrator to control envelope stamping for an account (placement of the envelopeId).

enableEnvelopeStampingByDSAdminMetadatasettingsMetadata

Metadata that indicates whether the enableEnvelopeStampingByDSAdmin property is editable.

enablePaymentProcessingstring

When set to true, payment processing is enabled for this account.

Note: This setting can be changed only by Admin users, and only if the account-level setting allowPaymentProcessing is set.

enablePaymentProcessingMetadatasettingsMetadata

Metadata that indicates whether the enablePaymentProcessing property is editable.

enablePowerFormstring

When set to true, enables PowerForms for the account.

Note: Only SysAdmin users can change this setting.

enablePowerFormDirectstring

When set to true, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.

Note: Only Admin users can change this setting.

enablePowerFormDirectMetadatasettingsMetadata

Metadata that indicates whether the enablePowerFormDirect property is editable.

enablePowerFormMetadatasettingsMetadata

Metadata that indicates whether the enablePowerForm property is editable.

enableRecipientDomainValidationstring

Reserved for DocuSign.

enableRecipientDomainValidationMetadatasettingsMetadata

Metadata that indicates whether the enableRecipientDomainValidation property is editable.

enableReportLinksstring

Enables direct links to envelopes in reports for administrators in the following scopes:

  • NoEnvelopes
  • AllEnvelopes
  • OnlyOwnEnvelopes

enableReportLinksMetadatasettingsMetadata

Metadata that indicates whether the enableReportLinks property is editable.

enableRequireSignOnPaperstring

When set to true, the account can use the requireSignOnPaper option.

Note: Only Admin users can change this setting.

enableRequireSignOnPaperMetadatasettingsMetadata

Metadata that indicates whether the enableRequireSignOnPaper property is editable.

enableReservedDomainstring

When true, account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as `@exampledomain.com`. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users.

  • Domains may be claimed by an organization.
  • When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts.
  • You can set domain controls for all users of the domain.
  • You can export information about your organization’s users that are associated with your reserved domains.

Note: Only SysAdmin users can change this setting.

enableReservedDomainMetadatasettingsMetadata

Metadata that indicates whether the enableReservedDomain property is editable.

enableResponsiveSigningstring

When true, enables responsive signing.

enableResponsiveSigningMetadatasettingsMetadata

Metadata that indicates whether the enableResponsiveSigning property is editable.

enableScheduledReleasestring

When set to true, scheduled releases are enabled. The default value is false.

enableScheduledReleaseMetadatasettingsMetadata

Metadata that indicates whether the enableScheduledRelease property is editable.

enableSendingTagsFontSettingsstring

When true, enables fonts to be set on tags for the account.

enableSendingTagsFontSettingsMetadatasettingsMetadata

Metadata that indicates whether the enableSendingTagsFontSettings property is editable.

enableSendToAgentstring

When true, this account can use the Agent recipient type.

Note: Only SysAdmin users can change this setting.

enableSendToAgentMetadatasettingsMetadata

Metadata that indicates whether the enableSendToAgent property is editable.

enableSendToIntermediarystring

When set to true, this account can use the Intermediary recipient type.

Note: Only Admin users can change this setting, and only if allowSendToIntermediary is set.

enableSendToIntermediaryMetadatasettingsMetadata

Metadata that indicates whether the enableSendToIntermediary property is editable.

enableSendToManagestring

When set to true, this account can use the Editor recipient type.

Note: Only Admin users can change this setting.

enableSendToManageMetadatasettingsMetadata

Metadata that indicates whether the enableSendToManage property is editable.

enableSequentialSigningAPIstring

When set to true, the account can define the routing order of recipients for envelopes sent by using the DocuSign API.

Note: Only SysAdmin users can change this setting.

enableSequentialSigningAPIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

enableSequentialSigningUIstring

When set to 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.

enableSequentialSigningUIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningUI property is editable.

enableSignerAttachmentsstring

When set to true, users can use the signing attachments feature to request attachments from signers.

Note: Only Admin users can change this setting.

enableSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the enableSignerAttachments property is editable.

enableSigningExtensionCommentsstring

When set to true, enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent.

enableSigningExtensionCommentsMetadatasettingsMetadata

Metadata that indicates whether the enableSigningExtensionComments property is editable.

enableSigningExtensionConversationsstring

When true, enables conversation functionality.

enableSigningExtensionConversationsMetadatasettingsMetadata

Metadata that indicates whether the enableSigningExtensionConversations property is editable.

enableSigningOrderSettingsForAccountstring

When true, switches Signing Order to On by default for new envelopes.

enableSigningOrderSettingsForAccountMetadatasettingsMetadata

Metadata that indicates whether the enableSigningOrderSettingsForAccount property is editable.

enableSignOnPaperstring

When set to true, a sender can allow signers to use the sign on paper option.

Note: Only Admin users can change this setting.

enableSignOnPaperMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaper property is editable.

enableSignOnPaperOverridestring

When set to 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.

enableSignOnPaperOverrideMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

enableSignWithNotarystring

When set to true, Sign with Notary functionality is enabled for the account.

Note: Only Admin users can change this setting.

enableSignWithNotaryMetadatasettingsMetadata

Metadata that indicates whether the enableSignWithNotary property is editable.

enableSmartContractsstring

When set to true, blockchain-based Smart Contracts are enabled. The default value is false.

enableSmartContractsMetadatasettingsMetadata

Metadata that indicates whether the enableSmartContracts property is editable.

enableSMSAuthenticationstring

When set to true, the account can use SMS authentication.

Note: Only Admin users can change this setting.

enableSMSAuthenticationMetadatasettingsMetadata

Metadata that indicates whether the enableSMSAuthentication property is editable.

enableSocialIdLoginstring

Deprecated.

enableSocialIdLoginMetadatasettingsMetadata

Deprecated.

enableStrikeThroughstring

When true, enables strikethrough formatting in documents.

enableStrikeThroughMetadatasettingsMetadata

Metadata that indicates whether the enableStrikeThrough property is editable.

enableTransactionPointstring

Reserved for DocuSign.

enableTransactionPointMetadatasettingsMetadata

Reserved for DocuSign.

enableVaultingstring

When set to true, Vaulting is enabled for the account.

enableVaultingMetadatasettingsMetadata

Metadata that indicates whether the enableVaulting property is editable.

enableWitnessingstring

Reserved for DocuSign.

enableWitnessingMetadatasettingsMetadata

Metadata that indicates whether the enableWitnessing property is editable.

enforceTemplateNameUniquenessstring

When true, the template name must be unique.

enforceTemplateNameUniquenessMetadatasettingsMetadata

Metadata that indicates whether the enforceTemplateNameUniqueness property is editable.

envelopeIntegrationAllowedstring

Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are:

  • not_allowed
  • full

Note: Only SysAdmin users can change this setting.

envelopeIntegrationAllowedMetadatasettingsMetadata

Metadata that indicates whether the envelopeIntegrationAllowed property is editable.

envelopeIntegrationEnabledstring

When true, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.

Note: Only Admin users can change this setting, and only when envelopeIntegrationAllowed is set.

envelopeIntegrationEnabledMetadatasettingsMetadata

Metadata that indicates whether the envelopeIntegrationEnabled property is editable.

envelopeStampingDefaultValuestring

When set to true, envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped.

envelopeStampingDefaultValueMetadatasettingsMetadata

Metadata that indicates whether the envelopeStampingDefaultValue property is editable.

expressSendstring

Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.

expressSendAllowTabsstring

Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger).

expressSendAllowTabsMetadatasettingsMetadata

Metadata that indicates whether the expressSendAllowTabs property is editable.

expressSendMetadatasettingsMetadata

Metadata that indicates whether the expressSend property is editable.

externalDocumentSourcesexternalDocumentSources

A list of external document sources such as DropBox and OneDrive.

externalSignaturePadTypestring

Specifies the signature pad type. Valid values are:

  • none
  • topaz
  • e_padv9
  • e_pad_integrisign
  • topaz_sigplusextlite

Note: Only Admin users can change this setting.

externalSignaturePadTypeMetadatasettingsMetadata

Metadata that indicates whether the externalSignaturePadType property is editable.

faxOutEnabledstring

When set to true, fax delivery to recipients is allowed for the account.

Note: Only Admin users can change this setting.

faxOutEnabledMetadatasettingsMetadata

Metadata that indicates whether the faxOutEnabled property is editable.

guidedFormsHtmlAllowedstring

When set to true, HTML used to implement Guided Forms is enabled for the account.

guidedFormsHtmlAllowedMetadatasettingsMetadata

hideAccountAddressInCoCstring

Boolean that specifies whether to hide the account address in the Certificate of Completion.

hideAccountAddressInCoCMetadatasettingsMetadata

Metadata that indicates whether the hideAccountAddressInCoC property is editable.

hidePricingstring

Boolean that specifies whether to hide the pricing functionality for an account.

hidePricingMetadatasettingsMetadata

Metadata that indicates whether the hidePricing property is editable.

idCheckConfigurations[idCheckConfiguration]

A list of ID check configuration objects.

idCheckExpirestring

Determines when a user's authentication with the account expires. Valid values are:

  • always: Users are required to authenticate each time.
  • variable: If the authentication for a user is valid and falls within the value for the idCheckExpireDays property, the user is not required to authenticate again.

Note: Only Admin users can change this setting.

idCheckExpireDaysstring

The number of days before user authentication credentials expire. A value of 0 specifies that users must re-authenticate for each new session.

Note: Only Admin users can change this setting.

idCheckExpireDaysMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpireDays property is editable.

idCheckExpireMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpire property is editable.

idCheckExpireMinutesstring

The number of minutes before user authentication credentials expire.

idCheckExpireMinutesMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpireMinutes property is editable.

idCheckRequiredstring

Indicates if authentication is configured for the account. Valid values are:

  • always: Authentication checks are performed on every envelope.
  • never: Authentication checks are not performed on any envelopes.
  • optional: Authentication is configurable per envelope.

Note: Only Admin users can change this setting.

idCheckRequiredMetadatasettingsMetadata

Metadata that indicates whether the idCheckRequired property is editable.

identityVerification[accountIdentityVerificationWorkflow]

identityVerificationMetadatasettingsMetadata

Metadata that indicates whether the identityVerification property is editable.

ignoreErrorIfAnchorTabNotFoundstring

Reserved for DocuSign.

ignoreErrorIfAnchorTabNotFoundMetadataEnabledsettingsMetadata

Reserved for DocuSign.

inPersonIDCheckQuestionstring

A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.

Note: Only Admin users can change this setting.

inPersonIDCheckQuestionMetadatasettingsMetadata

Metadata that indicates whether the inPersonIDCheckQuestion property is editable.

inPersonSigningEnabledstring

When true, in-person signing is enabled for the account.

inPersonSigningEnabledMetadatasettingsMetadata

Metadata that indicates whether the inPersonSigningEnabled property is editable.

inSessionEnabledstring

When true, the account can send in-session (embedded) envelopes.

Note: Only Admin users can change this setting.

inSessionEnabledMetadatasettingsMetadata

Metadata that indicates whether the inSessionEnabled property is editable.

inSessionSuppressEmailsstring

When set to true, emails are not sent to the in-session (embedded) recipients on an envelope.

Note: Only Admin users can change this setting.

inSessionSuppressEmailsMetadatasettingsMetadata

Metadata that indicates whether the inSessionSuppressEmails property is editable.

maximumSigningGroupsstring

The maximum number of signing groups allowed on the account. The default value is 50. This setting is only shown in responses that list account settings.

Note: Only SysAdmin users can change this setting.

maximumSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the maximumSigningGroups property is editable.

maximumUsersPerSigningGroupstring

The maximum number of users per signing group. The default value is 50. This setting is only shown in responses that list account settings.

Note: Only SysAdmin users can change this setting.

maximumUsersPerSigningGroupMetadatasettingsMetadata

Metadata that indicates whether the maximumUsersPerSigningGroup property is editable.

maxNumberOfCustomStampsstring

The maximum number of custom stamps.

mobileSessionTimeoutstring

The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are 1 to 120 minutes. The default value is 20 minutes.

Note: Only Admin users can change this setting.

mobileSessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the mobileSessionTimeout property is editable.

numberOfActiveCustomStampsstring

The number of active custom stamps associated with the account. DocuSign calculates this number automatically. This property is only visible to the DocuSign account manager.

optInMobileSigningV02string

Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.

optInMobileSigningV02MetadatasettingsMetadata

Metadata that indicates whether the optInMobileSigningV02 property is editable.

optOutAutoNavTextAndTabColorUpdatesstring

Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.

optOutAutoNavTextAndTabColorUpdatesMetadatasettingsMetadata

Metadata that indicates whether the optOutAutoNavTextAndTabColorUpdates property is editable.

optOutNewPlatformSealstring

Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal.

optOutNewPlatformSealPlatformMetadatasettingsMetadata

Metadata that indicates whether the optOutNewPlatformSealPlatform property is editable.

phoneAuthRecipientMayProvidePhoneNumberstring

When set to true, senders can allow recipients to provide a phone number for the Phone Authentication process.

Note: Only Admin users can change this setting.

phoneAuthRecipientMayProvidePhoneNumberMetadatasettingsMetadata

Metadata that indicates whether the phoneAuthRecipientMayProvidePhoneNumber property is editable.

pkiSignDownloadedPDFDocsstring

The policy for adding a digital certificate to downloaded, printed, and emailed documents.

Possible values are:

  • no_sign
  • no_sign_allow_user_override
  • yes_sign (Specifies that PDF files downloaded from the platform are signed.)

Note: Only Admin users can change this setting.

pkiSignDownloadedPDFDocsMetadatasettingsMetadata

Metadata that indicates whether the pkiSignDownloadedPDFDocs property is editable.

recipientsCanSignOfflinestring

When set to true, recipients receiving envelopes from this account can sign offline.

Note: Only Admin users can change this setting.

recipientsCanSignOfflineMetadatasettingsMetadata

Metadata that indicates whether the recipientsCanSignOffline property is editable.

recipientSigningAutoNavigationControlstring

When set to true, recipients receiving envelopes from this account can override auto-navigation functionality.

Note: Only Admin users can change this setting.

recipientSigningAutoNavigationControlMetadatasettingsMetadata

Metadata that indicates whether the recipientSigningAutoNavigationControl property is editable.

require21CFRpt11Compliancestring

When set to true, recipients are required to use a 21 CFR part 11-compliant signing experience.

Note: Only Admin users can change this setting.

require21CFRpt11ComplianceMetadatasettingsMetadata

Metadata that indicates whether the require21CFRpt11Compliance property is editable.

requireDeclineReasonstring

When set to true, signers who decline to sign an envelope sent from this account are required to provide a reason for declining.

Note: Only Admin users can change this setting.

requireDeclineReasonMetadatasettingsMetadata

Metadata that indicates whether the requireDeclineReason property is editable.

requireExternalUserManagementstring

When set to true, the account requires external management of users.

Note: Only Admin users can change this setting.

requireExternalUserManagementMetadatasettingsMetadata

Metadata that indicates whether the requireExternalUserManagement property is editable.

requireSignerCertificateTypestring

Sets the Digital Signature certificate requirements for sending envelopes. Valid values are:

  • none: A Digital Signature certificate is not required.
  • docusign_express: Signers must use a DocuSign Express certificate.
  • docusign_personal: Signers must use a DocuSign personal certificate.
  • safe
  • open_trust: Signers must use an OpenTrust certificate.

requireSignerCertificateTypeMetadatasettingsMetadata

Metadata that indicates whether the requireSignerCertificateType property is editable.

rsaVeridAccountNamestring

The RSA account name.

Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridPasswordstring

The password for the RSA account.

Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridRulesetstring

The RSA rule set used with the account.

Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridUserIdstring

The user ID for the RSA account.

Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

selfSignedRecipientEmailDocumentstring

Sets 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.

selfSignedRecipientEmailDocumentMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

selfSignedRecipientEmailDocumentUserOverridestring

When set to true, the selfSignedRecipientEmailDocument user setting can be set for an individual user. The user setting overrides the account setting.

Note: Only Admin users can change this account setting.

selfSignedRecipientEmailDocumentUserOverrideMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocumentUserOverride property is editable.

senderCanSignInEachLocationstring

When set to true, a signer can draw their signature in each location where a sign or initial tab exists. This functionality is typically used for mobile signing.

Note: Only Admin users can change this setting.

senderCanSignInEachLocationMetadatasettingsMetadata

Metadata that indicates whether the senderCanSignInEachLocation property is editable.

senderMustAuthenticateSigningstring

When set to true, a sender who is also a recipient of an envelope must follow the authentication requirements for the envelope.

Note: Only Admin users can change this setting.

senderMustAuthenticateSigningMetadatasettingsMetadata

Metadata that indicates whether the senderMustAuthenticateSigning property is editable.

sendingTagsFontColorstring

The account-wide default font color to use for the content of the tab.

Valid values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

sendingTagsFontColorMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontColor property is editable.

sendingTagsFontNamestring

The account-wide default font to be used for the tab value. Supported fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

sendingTagsFontNameMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontName property is editable.

sendingTagsFontSizestring

The account-wide default font size used for the information in the tab:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

sendingTagsFontSizeMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontSize property is editable.

sendToCertifiedDeliveryEnabledstring

When true, the account can use the certified deliveries recipient type.

sendToCertifiedDeliveryEnabledMetadatasettingsMetadata

Metadata that indicates whether the sendToCertifiedDeliveryEnabled property is editable.

sessionTimeoutstring

The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.

sessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the sessionTimeout property is editable.

setRecipEmailLangstring

When set to true, senders can set the email language to use for each recipient.

Note: Only Admin users can change this setting.

setRecipEmailLangMetadatasettingsMetadata

Metadata that indicates whether the setRecipEmailLang property is editable.

setRecipSignLangstring

If true, setting a unique language for a recipient not only affects the email language, but also the signing language they are presented with. If false, only the email will be affected when the sender specifies a unique language for a recipient.

Note: Only Admin users can change this setting.

setRecipSignLangMetadatasettingsMetadata

Metadata that indicates whether the setRecipSignLang property is editable.

sharedTemplateFoldersstring

Boolean that specifies whether an account can use Shared Template Folders.

sharedTemplateFoldersMetadatasettingsMetadata

Metadata that indicates whether the sharedTemplateFolders property is editable.

showCompleteDialogInEmbeddedSessionstring

Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.

showCompleteDialogInEmbeddedSessionMetadatasettingsMetadata

Metadata that indicates whether the showCompleteDialogInEmbeddedSession property is editable.

showConditionalRoutingOnSendstring

When set to true, Conditional Routing options display to senders during the sending experience.

showConditionalRoutingOnSendMetadatasettingsMetadata

showInitialConditionalFieldsstring

Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).

showInitialConditionalFieldsMetadatasettingsMetadata

Metadata that indicates whether the showInitialConditionalFields property is editable.

showLocalizedWatermarksstring

Boolean that specifies whether localized watermarks are displayed.

showLocalizedWatermarksMetadatasettingsMetadata

Metadata that indicates whether the showLocalizedWatermarks property is editable.

showTutorialsstring

If true, show tutorials.

showTutorialsMetadatasettingsMetadata

Metadata that indicates whether the showTutorials property is editable.

signatureProviders[array]

Names of electronic or digital signature providers that can be used.

signatureProvidersMetadatasettingsMetadata

Metadata that indicates whether the signatureProviders property is editable.

signDateFormatstring

The 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.

signDateFormatMetadatasettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

signerAttachCertificateToEnvelopePDFstring

When set to true, the Certificate of Completion is included in the PDF of the envelope documents when it is downloaded.

Note: Only Admin users can change this setting.

signerAttachCertificateToEnvelopePDFMetadatasettingsMetadata

Metadata that indicates whether the signerAttachCertificateToEnvelopePDF property is editable.

signerAttachConcatstring

When set to true, signer attachments are added to the parent document that contains the attachment. The default behavior creates a new document in the envelope for every signer attachment.

Note: Only Admin users can change this setting.

signerAttachConcatMetadatasettingsMetadata

Metadata that indicates whether the signerAttachConcat property is editable.

signerCanCreateAccountstring

When set to true, a signer can create a DocuSign account after signing.

Note: Only Admin users can change this setting.

signerCanCreateAccountMetadatasettingsMetadata

Metadata that indicates whether the signerCanCreateAccount property is editable.

signerCanSignOnMobilestring

When set to true, recipients can sign on a mobile device.

Note: Only Admin users can change this setting.

signerCanSignOnMobileMetadatasettingsMetadata

Metadata that indicates whether the signerCanSignOnMobile property is editable.

signerInSessionUseEnvelopeCompleteEmailstring

When set to true, an "envelope complete" email is sent to an in-session (embedded) or offline signer after DocuSign processes the envelope if in-session emails are not suppressed.

Note: Only Admin users can change this setting.

signerInSessionUseEnvelopeCompleteEmailMetadatasettingsMetadata

Metadata that indicates whether the signerInSessionUseEnvelopeCompleteEmail property is editable.

signerLoginRequirementsstring

Sets the login requirements for signers. Valid values are:

  • login_not_required: Signers are not required to log in.
  • login_required_if_account_holder: If the signer has a DocuSign account, they must log in to sign the document.
  • login_required_per_session: The sender cannot send an envelope to anyone who does not have a DocuSign account.
  • login_required_per_envelope: The sender cannot send an envelope to anyone who does not have a DocuSign account, and the signer must also log in for each envelope they will sign.

Note: Only Admin users can change this setting. If you use Direct PowerForms or captive (embedded signers), the "Account required" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods.

signerLoginRequirementsMetadatasettingsMetadata

Metadata that indicates whether the signerLoginRequirements property is editable.

signerMustHaveAccountstring

When set to true, senders can only send an envelope to a recipient that has a DocuSign account.

Note: Only Account Administrators can change this setting.

signerMustHaveAccountMetadatasettingsMetadata

Metadata that indicates whether the signerMustHaveAccount property is editable.

signerMustLoginToSignstring

When set to true, signers must log in to the DocuSign platform to sign an envelope.

Note: Only Admin users can change this setting.

signerMustLoginToSignMetadatasettingsMetadata

Metadata that indicates whether the signerMustLoginToSign property is editable.

signerShowSecureFieldInitialValuesstring

When set to true, the initial values of all SecureFields are written to the document when it is sent.

Note: Only Admin users can change this setting.

signerShowSecureFieldInitialValuesMetadatasettingsMetadata

Metadata that indicates whether the signerShowSecureFieldInitialValues property is editable.

signingSessionTimeoutstring

The number of minutes that a signing session stays alive without any activity.

signingSessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the signingSessionTimeout property is editable.

signingUiVersionstring

Reserved for DocuSign.

signingUiVersionMetadatasettingsMetadata

Reserved for DocuSign.

signTimeFormatstring

The format for the signature time. Valid values are:

  • none
  • HH:mm
  • h:mm
  • HH:mm:ss
  • h:mm:ss

signTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

signTimeShowAmPmstring

If true, the time shows the AM or PM indicator.

signTimeShowAmPmMetadatasettingsMetadata

Metadata that indicates whether the signTimeShowAmPm property is editable.

simplifiedSendingEnabledstring

When set to true, simplified sending is enabled for the account. The default value is false.

simplifiedSendingEnabledMetadatasettingsMetadata

Metadata that indicates whether the simplifiedSendingEnabled property is editable.

singleSignOnEnabledstring

If true, single sign-on (SSO) is enabled.

singleSignOnEnabledMetadatasettingsMetadata

Metadata that indicates whether the singleSignOnEnabled property is editable.

skipAuthCompletedEnvelopesstring

If true, do not require authentication prompt for viewing completed envelopes

skipAuthCompletedEnvelopesMetadatasettingsMetadata

Metadata that indicates whether the skipAuthCompletedEnvelopes property is editable.

socialIdRecipAuthstring

If true, recipients can use social ids when signing

socialIdRecipAuthMetadatasettingsMetadata

Metadata that indicates whether the socialIdRecipAuth property is editable.

specifyDocumentVisibilitystring

When true, senders can specify the visibility of the documents in an envelope at the recipient level.

specifyDocumentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the specifyDocumentVisibility property is editable.

startInAdvancedCorrectstring

If true, when initiating correction of an in-flight envelope the sender starts in advanced correct mode.

startInAdvancedCorrectMetadatasettingsMetadata

Metadata that indicates whether the startInAdvancedCorrect property is editable.

supplementalDocumentsMustAcceptstring

When set to true, account users must accept supplemental documents when signing.

supplementalDocumentsMustAcceptMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

supplementalDocumentsMustReadstring

When set to true, account users must both view and accept supplemental documents when signing.

supplementalDocumentsMustReadMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

supplementalDocumentsMustViewstring

When set to true, account users must view supplemental documents when signing.

supplementalDocumentsMustViewMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

suppressCertificateEnforcementstring

Boolean that specifies whether or not API calls require a x509 cert in the header of the call.

suppressCertificateEnforcementMetadatasettingsMetadata

Metadata that indicates whether the suppressCertificateEnforcement property is editable.

tabAccountSettingsAccountTabSettings

Account-wide tab settings.

timezoneOffsetAPIstring

Specifies the time zone to use with the API.

Valid values are:

  • 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

timezoneOffsetAPIMetadatasettingsMetadata

Metadata that indicates whether the timezoneOffsetAPI property is editable.

timezoneOffsetUIstring

Specifies the time zone to use in the UI.

Valid values are:

  • 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

timezoneOffsetUIMetadatasettingsMetadata

Metadata that indicates whether the timezoneOffsetUI property is editable.

universalSignatureOptInstring

Reserved for DocuSign.

useAccountLevelEmailstring

Reserved for DocuSign.

useAccountLevelEmailMetadatasettingsMetadata

Metadata that indicates whether the useAccountLevelEmail property is editable.

useConsumerDisclosurestring

When set to true, the account uses an Electronic Record and Signature Disclosure Statement.

Note: Only Admin users can change this setting.

useConsumerDisclosureMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosure property is editable.

useConsumerDisclosureWithinAccountstring

When set to true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.

useConsumerDisclosureWithinAccountMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosureWithinAccount property is editable.

useDerivedKeysstring

Reserved for DocuSign.

useDerivedKeysMetadatasettingsMetadata

Metadata that indicates whether the useDerivedKeys property is editable.

useDocuSignExpressSignerCertificatestring

If true, signers are required to use Express Digital Signatures.

useDocuSignExpressSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the useDocuSignExpressSignerCertificate property is editable.

useNewBlobForPdfstring

Reserved for DocuSign.

useNewBlobForPdfMetadatasettingsMetadata

Metadata that indicates whether the useNewBlobForPdf property is editable.

useSAFESignerCertificatesstring

If true, signers are required to use SAFE digital signatures.

useSAFESignerCertificatesMetadatasettingsMetadata

Metadata that indicates whether the useSAFESignerCertificates property is editable.

usesAPIstring

When set to true, the account can use the API.

Note: Only SysAdmin users can change this setting.

usesAPIMetadatasettingsMetadata

Metadata that indicates whether the usesAPI property is editable.

useSignatureProviderPlatformstring

Boolean that specifies whether the account uses the digital signature provider platform to eSign.

useSignatureProviderPlatformMetadatasettingsMetadata

Metadata that indicates whether the useSignatureProviderPlatform property is editable.

validationsAllowedstring

Boolean that specifies whether validations on recipient email domains are allowed.

validationsAllowedMetadatasettingsMetadata

Metadata that indicates whether the validationsAllowed property is editable.

validationsBrandstring

Valid values are:

  • docusign
  • account

validationsBrandMetadatasettingsMetadata

Metadata that indicates whether the validationsBrand property is editable.

validationsCadencestring

Valid values are:

  • none
  • monthly

validationsCadenceMetadatasettingsMetadata

Metadata that indicates whether the validationsCadence property is editable.

validationsEnabledstring

If true, enables validations.

validationsEnabledMetadatasettingsMetadata

Metadata that indicates whether the validationsEnabled property is editable.

validationsReportstring

Valid values are:

  • none
  • life_sciences_part11

validationsReportMetadatasettingsMetadata

Metadata that indicates whether the validationsReport property is editable.

waterMarkEnabledstring

If true, the watermark feature is enabled for the account.

waterMarkEnabledMetadatasettingsMetadata

Metadata that indicates whether the waterMarkEnabled property is editable.

writeReminderToEnvelopeHistorystring

If true, sent reminders are included in the envelope history.

writeReminderToEnvelopeHistoryMetadatasettingsMetadata

Metadata that indicates whether the writeReminderToEnvelopeHistory property is editable.

wurflMinAllowableScreenSizestring

The smallest screen allowed.

wurflMinAllowableScreenSizeMetadatasettingsMetadata

Metadata that indicates whether the wurflMinAllowableScreenSize property is editable.

accountSignatureProvider

Contains information abotu the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers.

isRequiredstring

Reserved for DocuSign.

prioritystring

Reserved for DocuSign.

signatureProviderDisplayNamestring

Reserved for DocuSign.

signatureProviderIdstring

Reserved for DocuSign.

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see the current provider list. You can also retrieve the list by using the AccountSignatureProviders::List method.

Example: universalsignaturepen_default

signatureProviderOptionsMetadata[accountSignatureProviderOption]

Reserved for DocuSign.

signatureProviderRequiredOptions[signatureProviderRequiredOption]

Reserved for DocuSign.

accountSignatureProviderOption

Reserved for DocuSign.

signatureProviderOptionDisplayNamestring

Reserved for DocuSign.

signatureProviderOptionIdstring

Reserved for DocuSign.

signatureProviderOptionNamestring

Reserved for DocuSign.

accountUISettings

An object that defines the options that are available to non-administrators in the UI.

enableEasySignCanUseMultiTemplateApplystring

enableEasySignCanUseMultiTemplateApplyMetadatasettingsMetadata

enableEasySignTemplateUploadstring

enableEasySignTemplateUploadMetadatasettingsMetadata

hideSendAnEnvelopestring

hideSendAnEnvelopeMetadatasettingsMetadata

hideUseATemplatestring

When set to true, the Templates menu is hidden from account users who are not Admins. The default value is false.

hideUseATemplateInPreparestring

hideUseATemplateInPrepareMetadatasettingsMetadata

hideUseATemplateMetadatasettingsMetadata

orderBasedRecipientIdGenerationstring

orderBasedRecipientIdGenerationMetadatasettingsMetadata

removeEnvelopeForwardingstring

removeEnvelopeForwardingMetadatasettingsMetadata

shouldRedactAccessCodestring

shouldRedactAccessCodeMetadatasettingsMetadata

addressInformation

Contains address information.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The user's city.

countrystring

The user's country.

faxstring

A fax number associated with the address, if one is available.

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

expirations

A complex element that specifies the expiration settings for the envelope.

expireAfterstring

An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (sentDateTime). Set expireAfter to set the number of days until an envelope expires. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

externalDocumentSources

A complex object specifying the external document sources.

boxnetEnabledstring

The account is enabled to allow external documents to be attached from BoxNet.

boxnetMetadatasettingsMetadata

Metadata indicating whether the boxnetEnabled property is editable.

dropboxEnabledstring

The account is enabled to allow external documents to be attached from DropBox.

dropboxMetadatasettingsMetadata

Metadata indicating whether the dropboxEnabled property is editable.

googleDriveEnabledstring

The account is enabled to allow external documents to be attached from Google Drive.

googleDriveMetadatasettingsMetadata

Metadata indicating whether the googleDriveEnabled property is editable.

oneDriveEnabledstring

The account is enabled to allow external documents to be attached from OneDrive.

oneDriveMetadatasettingsMetadata

Metadata indicating whether the oneDriveEnabled property is editable.

salesforceEnabledstring

The account is enabled to allow external documents to be attached from Salesforce.

salesforceMetadatasettingsMetadata

Metadata indicating whether the salesforceEnabled property is editable.

idCheckConfiguration

A complex object specifying ID check configuration.

authSteps[idCheckSecurityStep]

A list of ID check security steps, each specifying an authorization type.

isDefaultstring

Boolean that specifies whether the signature is the default signature for the user.

namestring

The name of the signature.

idCheckSecurityStep

authTypestring

Type of authorization used for the security check.

recipientDomain

activestring

domainCodestring

domainNamestring

recipientDomainIdstring

reminders

A complex element that specifies reminder settings for the envelope.

reminderDelaystring

An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

reminderEnabledstring

When set to true, the envelope expires and is no longer available for signing after the specified number of days. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

reminderFrequencystring

An integer specifying the interval in days between reminder emails.

settingsMetadata

Metadata that indicates whether a property is editable and describes setting-specific options.

is21CFRPart11string

When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

signatureProviderRequiredOption

Contains additional information that a specific signature provider requires.

requiredSignatureProviderOptionIds[array]

Reserved for DocuSign.

signerTypestring

Reserved for DocuSign.

Accounts

Account management

accountIdGuidstring

The GUID associated with the account ID.

accountNamestring

The name on the account.

accountSettingsaccountSettingsInformation

The list of account settings 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.

allowTransactionRoomsstring

When set to true, the transaction rooms feature exposed through the Workspaces API is enabled.

billingPeriodDaysRemainingstring

Number of days remaining in the current billing period.

billingPeriodEndDatestring

The billing period end date in UTC timedate format.

billingPeriodEnvelopesAllowedstring

The number of envelopes that can be sent in the current billing period (can be unlimited).

billingPeriodEnvelopesSentstring

The number of envelopes that have been sent in the current billing period.

billingPeriodStartDatestring

The billing period start date in UTC timedate format.

billingProfilestring

The type of billing method on the account; for example direct or web.

canUpgradestring

When set to 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.

connectPermissionstring

createdDatestring

The creation date of the account in UTC timedate format.

currencyCodestring

The currency code for the account, based on the ISO 4217 currency code.

currentPlanIdstring

ID of the plan used to create this account.

distributorCodestring

The code that identifies the billing plan groups and plans for the new account.

docuSignLandingUrlstring

URL of the landing page used to create the account.

dssValuesobject

envelopeSendingBlockedstring

When true, the ability to send envelopes is blocked. When false, envelopes can be sent.

envelopeUnitPricestring

The price of sending an envelope, represented in the account's local currency.

externalAccountIdstring

The Account ID displayed on the user's Account page.

forgottenPasswordQuestionsCountstring

A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.

isDowngradestring

When true, the account has been downgraded from a premium account type. Otherwise false.

paymentMethodstring

The payment method used for the billing plan. Valid values are:

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit

planClassificationstring

Identifies the type of plan. Examples include:

  • business
  • corporate
  • enterprise
  • free

planEndDatestring

The date that the current plan will end.

planNamestring

The name of the billing plan used for the account.

Examples:

  • Personal - Annual
  • Unlimited Envelope Subscription - Annual Billing

planStartDatestring

The date that the Account started using the current plan.

recipientDomains[recipientDomain]

seatsAllowedstring

The number of active users the account can have at one time.

seatsInUsestring

The number of users currently active on the account.

status21CFRPart11string

The 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.

suspensionDatestring

The date on which the account was suspended.

suspensionStatusstring

Indicates whether the account is currently suspended.

AccountTabSettings

Tab settings determine the tab types and tab functionality that are enabled for an account.

allowTabOrderstring

When set to true, account users can set a tab order for the signing process.

Note: Only Admin users can change this setting.

allowTabOrderMetadatasettingsMetadata

Metadata that indicates whether the allowTabOrder property is editable.

approveDeclineTabsEnabledstring

When true, approve and decline tabs are enabled.

approveDeclineTabsMetadatasettingsMetadata

Metadata that indicates whether the approveDeclineTabs property is editable.

calculatedFieldsEnabledstring

When true, calculated fields are enabled for tabs.

calculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the calculatedFields property is editable.

checkboxTabsEnabledstring

When true, checkbox tabs are enabled.

checkBoxTabsMetadatasettingsMetadata

Metadata that indicates whether the checkBoxTabs property is editable.

dataFieldRegexEnabledstring

When true, regular expressions are enabled for tabs that contain data fields.

dataFieldRegexMetadatasettingsMetadata

Metadata that indicates whether the dataFieldRegex property is editable.

dataFieldSizeEnabledstring

When true, setting character limits for input fields is enabled.

dataFieldSizeMetadatasettingsMetadata

Metadata that indicates whether the dataFieldSize property is editable.

firstLastEmailTabsEnabledstring

Reserved for DocuSign.

firstLastEmailTabsMetadatasettingsMetadata

Reserved for DocuSign.

listTabsEnabledstring

When true, list tabs are enabled.

listTabsMetadatasettingsMetadata

Metadata that indicates whether the listTabs property is editable.

noteTabsEnabledstring

When true, note tabs are enabled.

noteTabsMetadatasettingsMetadata

Metadata that indicates whether the noteTabs property is editable.

radioTabsEnabledstring

When true, radio button tabs are enabled.

radioTabsMetadatasettingsMetadata

Metadata that indicates whether the radioTabs property is editable.

savingCustomTabsEnabledstring

When true, saving custom tabs is enabled.

savingCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the savingCustomTabs property is editable.

senderToChangeTabAssignmentsEnabledstring

Reserved for DocuSign.

senderToChangeTabAssignmentsMetadatasettingsMetadata

Reserved for DocuSign.

sharedCustomTabsEnabledstring

When true, shared custom tabs are enabled.

sharedCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the sharedCustomTabs property is editable.

tabDataLabelEnabledstring

When set to true, data labels are enabled.

Note: Only Admin users can change this setting.

tabDataLabelMetadatasettingsMetadata

Metadata that indicates whether the tabDataLabel property is editable.

tabLocationEnabledstring

Reserved for DocuSign.

tabLocationMetadatasettingsMetadata

Reserved for DocuSign.

tabLockingEnabledstring

When set to true, tab locking is enabled.

Note: Only Admin users can change this setting.

tabLockingMetadatasettingsMetadata

Metadata that indicates whether the tabLocking property is editable.

tabScaleEnabledstring

Reserved for DocuSign.

tabScaleMetadatasettingsMetadata

Reserved for DocuSign.

tabTextFormattingEnabledstring

When set to 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.

tabTextFormattingMetadatasettingsMetadata

Metadata that indicates whether the tabTextFormatting property is editable.

textTabsEnabledstring

When true, text tabs are enabled.

textTabsMetadatasettingsMetadata

Metadata that indicates whether the textTabs property is editable.

Examples

Generic JSON Response

Response
{
  "currentPlanId": "sample string 1",
  "planName": "sample string 2",
  "planClassification": "sample string 3",
  "planStartDate": "sample string 4",
  "planEndDate": "sample string 5",
  "billingPeriodStartDate": "sample string 6",
  "billingPeriodEndDate": "sample string 7",
  "billingPeriodEnvelopesSent": "sample string 8",
  "billingPeriodEnvelopesAllowed": "sample string 9",
  "billingPeriodDaysRemaining": "sample string 10",
  "canUpgrade": "sample string 11",
  "canCancelRenewal": "sample string 12",
  "envelopeSendingBlocked": "sample string 13",
  "envelopeUnitPrice": "sample string 14",
  "suspensionStatus": "sample string 15",
  "suspensionDate": "sample string 16",
  "accountName": "sample string 17",
  "connectPermission": "sample string 18",
  "docuSignLandingUrl": "sample string 19",
  "distributorCode": "sample string 20",
  "accountIdGuid": "sample string 21",
  "externalAccountId": "sample string 22",
  "currencyCode": "sample string 23",
  "forgottenPasswordQuestionsCount": "sample string 24",
  "paymentMethod": "sample string 25",
  "seatsAllowed": "sample string 26",
  "seatsInUse": "sample string 27",
  "createdDate": "sample string 28",
  "isDowngrade": "sample string 29",
  "billingProfile": "sample string 30",
  "status21CFRPart11": "sample string 31",
  "allowTransactionRooms": "sample string 32"
}
Generic XML Response

Response
<accountInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountIdGuid>sample string 21</accountIdGuid>
  <accountName>sample string 17</accountName>
  <allowTransactionRooms>sample string 32</allowTransactionRooms>
  <billingPeriodDaysRemaining>sample string 10</billingPeriodDaysRemaining>
  <billingPeriodEndDate>sample string 7</billingPeriodEndDate>
  <billingPeriodEnvelopesAllowed>sample string 9</billingPeriodEnvelopesAllowed>
  <billingPeriodEnvelopesSent>sample string 8</billingPeriodEnvelopesSent>
  <billingPeriodStartDate>sample string 6</billingPeriodStartDate>
  <billingProfile>sample string 30</billingProfile>
  <canCancelRenewal>sample string 12</canCancelRenewal>
  <canUpgrade>sample string 11</canUpgrade>
  <connectPermission>sample string 18</connectPermission>
  <createdDate>sample string 28</createdDate>
  <currencyCode>sample string 23</currencyCode>
  <currentPlanId>sample string 1</currentPlanId>
  <distributorCode>sample string 20</distributorCode>
  <docuSignLandingUrl>sample string 19</docuSignLandingUrl>
  <envelopeSendingBlocked>sample string 13</envelopeSendingBlocked>
  <envelopeUnitPrice>sample string 14</envelopeUnitPrice>
  <externalAccountId>sample string 22</externalAccountId>
  <forgottenPasswordQuestionsCount>sample string 24</forgottenPasswordQuestionsCount>
  <isDowngrade>sample string 29</isDowngrade>
  <paymentMethod>sample string 25</paymentMethod>
  <planClassification>sample string 3</planClassification>
  <planEndDate>sample string 5</planEndDate>
  <planName>sample string 2</planName>
  <planStartDate>sample string 4</planStartDate>
  <seatsAllowed>sample string 26</seatsAllowed>
  <seatsInUse>sample string 27</seatsInUse>
  <status21CFRPart11>sample string 31</status21CFRPart11>
  <suspensionDate>sample string 16</suspensionDate>
  <suspensionStatus>sample string 15</suspensionStatus>
</accountInformation> 
}} />