Skip to content

DocuSign: Gets the default Electronic Record and Signature Disclosure for an account

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

← Esignature operations · Get started

Operation docusign.esignature_consumerdisclosure_getconsumerdisclosure

Provider route: GET /restapi/v2.1/accounts/{accountId}/consumer_disclosure. 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"]["esignatureConsumerDisclosureGetConsumerDisclosure"]>[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.esignatureConsumerDisclosureGetConsumerDisclosure(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_consumer_disclosure_get_consumer_disclosure(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
queryobjectOptionalAdditional keys: not allowed
query.langCodestringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets the Electronic Record and Signature Disclosure for an account — response body

Referenced models: Gets the Electronic Record and Signature Disclosure for an account — response body

Gets the Electronic Record and Signature Disclosure for an account — response body
FieldTypePresenceDescription and constraints
$objectRootDetails about account consumer disclosures.
accountEsignIdstringOptionalThe GUID of the account associated with the consumer disclosure.
allowCDWithdrawstringOptionalWhen **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**
**Note:** Only Admin users can change this setting.
allowCDWithdrawMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `allowCDWithdraw` property is editable.
changeEmailstringOptionalIf the customer needs to change their email address, this is the email address to which they should the change request.

Maximum length: 100 characters.
changeEmailOtherstringOptionalOther information about the requirements for the user to change their email address.

Maximum length: 255 characters.

Example:

`We do not require any other information from you to change your email address.`
companyNamestringOptionalSpecifies the company name used in the disclosure. The default value is the account name.

However, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.

**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**
companyPhonestringOptionalThe phone number of the company associated with the consumer disclosure, as a free-formatted string.
copyCostPerPagestringOptionalThe cost per page if the customer requests paper copies.

Example:

`0.0000`
copyFeeCollectionMethodstringOptionalSpecifies the fee collection method for cases in which the customer requires paper copies of the document.

Maximum length: 255 characters.

Example:

`We will bill you for any fees at that time, if any.`
copyRequestEmailstringOptionalThe email address to which the customer should send a request for copies of a document.

Maximum length: 100 characters.
customstringOptionalWhen **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**
enableEsignstringOptionalWhen **true** (default), indicates that eSign is enabled.
esignAgreementstringOptionalThe final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting.
esignTextstringOptionalThe template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.

**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting.
languageCodestringOptionalThe code for the language version of the disclosure. The following languages are supported:

- Arabic (`ar`)
- Bulgarian (`bg`)
- Czech (`cs`)
- Chinese Simplified (`zh_CN`)
- Chinese Traditional (`zh_TW`)
- Croatian (`hr`)
- Danish (`da`)
- Dutch (`nl`)
- English US (`en`)
- English UK (`en_GB`)
- Estonian (`et`)
- Farsi (`fa`)
- Finnish (`fi`)
- French (`fr`)
- French Canadian (`fr_CA`)
- German (`de`)
- Greek (`el`)
- Hebrew (`he`)
- Hindi (`hi`)
- Hungarian (`hu`)
- Bahasa Indonesian (`id`)
- Italian (`it`)
- Japanese (`ja`)
- Korean (`ko`)
- Latvian (`lv`)
- Lithuanian (`lt`)
- Bahasa Melayu (`ms`)
- Norwegian (`no`)
- Polish (`pl`)
- Portuguese (`pt`)
- Portuguese Brazil (`pt_BR`)
- Romanian (`ro`)
- Russian (`ru`)
- Serbian (`sr`)
- Slovak (`sk`)
- Slovenian (`sl`)
- Spanish (`es`)
- Spanish Latin America (`es_MX`)
- Swedish (`sv`)
- Thai (`th`)
- Turkish (`tr`)
- Ukrainian (`uk`)
- Vietnamese (`vi`)

Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.
mustAgreeToEsignstringOptionalWhen **true,** the recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions.
pdfIdstringOptional**Deprecated.**

The `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored.
useBrandstringOptionalWhen **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.

When **false** (default), or if the signing brand does not specify a company name, the account name is used instead.

**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD.
useConsumerDisclosureWithinAccountstringOptionalWhen **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
useConsumerDisclosureWithinAccountMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.
withdrawAddressLine1stringOptionalContains the first address line of the postal address to which a customer can send a consent withdrawal notification.

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

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

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

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

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

Maximum length: 255 characters.

Example:

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

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

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

Example: `PA`

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

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

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

SDK function policy ID: docusign.esignature_consumerdisclosure_getconsumerdisclosure. Catalog operation: esignature:ConsumerDisclosure_GetConsumerDisclosure. 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.