Skip to content

DocuSign: Gets account settings information

DocuSign esignature.esignatureSettingsGetSettings: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_settings_getsettings

Provider route: GET /restapi/v2.1/accounts/{accountId}/settings. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureSettingsGetSettings"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureSettingsGetSettings(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_settings_get_settings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets account settings information — response body

Referenced models: Gets account settings information — response body

14 more schemas are linked from the tables above, on the schema pages.

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

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

Gets account settings information — response body — identity Verification item
FieldTypePresenceDescription and constraints
$objectRootSpecifies an Identity Verification workflow.
defaultDescriptionstringOptionalText describing the purpose of the Identity Verification workflow.
defaultNamestringOptionalThe name of the Identity Verification workflow.
displayOrderstringOptionalThe position on the page where the display section appears.
Format: int32
inputOptionsarrayOptional
inputOptions[]ModelEach itemExpand Gets account settings information — response body — identity Verification item input Options item
isDisabledstringOptionalWhen **true,** the workflow is disabled.
ownerTypestringOptional
signatureProviderModelOptionalExpand Gets the available signature providers for an account — response body — signature Providers item
The signature provider associated with the Identity Verification workflow.
workflowIdstringOptionalWorkflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification`
[core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters)
workflowLabelstringOptional
workflowResourceKeystringOptionalReserved for Docusign.

Referenced models: Gets account settings information — response body — identity Verification item input Options item, Gets the available signature providers for an account — response body — signature Providers item

Gets account settings information — response body — account Notification
FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies notifications (expirations and reminders) for the envelope.
expirationsModelOptionalExpand Gets envelope notification information — response body — expirations
A complex element that specifies the expiration settings for the envelope.
remindersModelOptionalExpand Gets envelope notification information — response body — reminders
A complex element that specifies reminder settings for the envelope.
userOverrideEnabledstringOptionalWhen **true,** the user can override envelope expirations.

Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders

Gets account settings information — response body — additional Settings item
FieldTypePresenceDescription and constraints
$objectRoot
metadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
namestringOptional
valuestringOptionalSpecifies the value of the tab.

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

Get credit card information — response body — address
FieldTypePresenceDescription and constraints
$objectRootContains address information.
address1stringOptionalThe first line of the user's address.
Maximum length: 100 characters.
address2stringOptionalThe second line of the user's address.
Maximum length: 100 characters.
citystringOptionalThe user's city. Maximum length: 40 characters.
countrystringOptionalThe user's country. Maximum length: 50 characters.
faxstringOptionalA fax number associated with the address, if one is available.
phonestringOptionalA phone number associated with the address.
postalCodestringOptionalThe user's postal code. Maximum length: 20 characters.
stateOrProvincestringOptionalThe user's state or province. Maximum length: 40 characters.
zipPlus4stringOptional
Gets account settings information — response body — external Document Sources
FieldTypePresenceDescription and constraints
$objectRootA complex object specifying the external document sources.
boxnetEnabledstringOptionalThe account is enabled to allow external documents to be attached from BoxNet.
boxnetMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `boxnetEnabled` property is editable.
dropboxEnabledstringOptionalThe account is enabled to allow external documents to be attached from DropBox.
dropboxMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `dropboxEnabled` property is editable.
googleDriveEnabledstringOptionalThe account is enabled to allow external documents to be attached from Google Drive.
googleDriveMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `googleDriveEnabled` property is editable.
oneDriveEnabledstringOptionalThe account is enabled to allow external documents to be attached from OneDrive.
oneDriveMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `oneDriveEnabled` property is editable.
salesforceEnabledstringOptionalThe account is enabled to allow external documents to be attached from Salesforce.
salesforceMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata indicating whether the `salesforceEnabled` property is editable.

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

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

Referenced models: Gets account settings information — response body — id Check Configurations item auth Steps item

Gets account settings information — response body — identity Verification item input Options item
FieldTypePresenceDescription and constraints
$objectRoot
isRequiredbooleanOptional
optionNamestringOptional
valueTypestringOptional

SDK function policy ID: docusign.esignature_settings_getsettings. Catalog operation: esignature:Settings_GetSettings. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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