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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets account settings information — response body |
Referenced models: Gets account settings information — response body
Schemas
Section titled “Schemas”14 more schemas are linked from the tables above, on the schema pages.
Gets account settings information — response body — access Code Format
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Object specifying the format of the string provided to a recipient in order to access an envelope. |
formatRequired | string | Optional | Boolean specifying whether this format configuration is required. |
formatRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `formatRequired` property is editable. |
letterRequired | string | Optional | Boolean specifying whether alphabetical characters are required in the access code string. |
letterRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `letterRequired` property is editable. |
minimumLength | string | Optional | Minimum length of the access code string. |
minimumLengthMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `minimumLength` property is editable. |
numberRequired | string | Optional | Boolean specifying whether numerical characters (0-9) are required in the access code string. |
numberRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `numberRequired` property is editable. |
specialCharacterRequired | string | Optional | Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'. |
specialCharacterRequiredMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `specialCharacterRequired` property is editable. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — identity Verification item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies an Identity Verification workflow. |
defaultDescription | string | Optional | Text describing the purpose of the Identity Verification workflow. |
defaultName | string | Optional | The name of the Identity Verification workflow. |
displayOrder | string | Optional | The position on the page where the display section appears. Format: int32 |
inputOptions | array | Optional | |
inputOptions[] | Model | Each item | Expand Gets account settings information — response body — identity Verification item input Options item |
isDisabled | string | Optional | When **true,** the workflow is disabled. |
ownerType | string | Optional | |
signatureProvider | Model | Optional | Expand Gets the available signature providers for an account — response body — signature Providers item The signature provider associated with the Identity Verification workflow. |
workflowId | string | Optional | Workflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification` [core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters) |
workflowLabel | string | Optional | |
workflowResourceKey | string | Optional | Reserved for Docusign. |
Referenced models: Gets account settings information — response body — identity Verification item input Options item, Gets the available signature providers for an account — response body — signature Providers item
Gets account settings information — response body — account Notification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies notifications (expirations and reminders) for the envelope. |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
userOverrideEnabled | string | Optional | When **true,** the user can override envelope expirations. |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Gets account settings information — response body — additional Settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
name | string | Optional | |
value | string | Optional | Specifies the value of the tab. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Get credit card information — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
Gets account settings information — response body — external Document Sources
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object specifying the external document sources. |
boxnetEnabled | string | Optional | The account is enabled to allow external documents to be attached from BoxNet. |
boxnetMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `boxnetEnabled` property is editable. |
dropboxEnabled | string | Optional | The account is enabled to allow external documents to be attached from DropBox. |
dropboxMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `dropboxEnabled` property is editable. |
googleDriveEnabled | string | Optional | The account is enabled to allow external documents to be attached from Google Drive. |
googleDriveMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `googleDriveEnabled` property is editable. |
oneDriveEnabled | string | Optional | The account is enabled to allow external documents to be attached from OneDrive. |
oneDriveMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `oneDriveEnabled` property is editable. |
salesforceEnabled | string | Optional | The account is enabled to allow external documents to be attached from Salesforce. |
salesforceMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata indicating whether the `salesforceEnabled` property is editable. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets account settings information — response body — id Check Configurations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex object specifying ID check configuration. |
authSteps | array | Optional | A list of ID check security steps, each specifying an authorization type. |
authSteps[] | Model | Each item | Expand Gets account settings information — response body — id Check Configurations item auth Steps item |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
name | string | Optional | The name of the signature. |
Referenced models: Gets account settings information — response body — id Check Configurations item auth Steps item
Gets account settings information — response body — identity Verification item input Options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isRequired | boolean | Optional | |
optionName | string | Optional | |
valueType | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.