Gets the Electronic Record and Signature Disclosure for a specific envelope recipient
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings.
To set the language of the disclosure that you want to retrieve, specify the langCode as either a path or query parameter.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The envelope's GUID.
Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. 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.
A local reference used to map recipients to other objects, such as specific document tabs.
A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.
For example, many envelopes assign the first recipient
a recipientId of 1.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/recipients/string/consumer_disclosure/string"{ "accountEsignId": "string", "allowCDWithdraw": "string", "changeEmail": "string", "changeEmailOther": "string", "companyName": "string", "companyPhone": "string", "copyCostPerPage": "string", "copyFeeCollectionMethod": "string", "copyRequestEmail": "string", "custom": "string", "enableEsign": "string", "esignAgreement": "string", "esignText": "string", "languageCode": "string", "mustAgreeToEsign": "string", "pdfId": "string", "useBrand": "string", "useConsumerDisclosureWithinAccount": "string", "withdrawAddressLine1": "string", "withdrawAddressLine2": "string", "withdrawByEmail": "string", "withdrawByMail": "string", "withdrawByPhone": "string", "withdrawCity": "string", "withdrawConsequences": "string", "withdrawEmail": "string", "withdrawOther": "string", "withdrawPhone": "string", "withdrawPostalCode": "string", "withdrawState": "string"}Gets the default Electronic Record and Signature Disclosure for an envelope GET
Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. This is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.
Gets a list of documents in an envelope GET
Retrieves a list of documents associated with the specified envelope. ### Related topics - [How to list envelope documents](https://developers.docusign.com/docs/esign-rest-api/how-to/list-envelope-documents/)