Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeConsumerDisclosures

Gets the default Electronic Record and Signature Disclosure for an envelope.

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.

get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure

Path parameters

accountIdstring required

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

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

recipientIdstring required

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.

Query parameters

langCodestring

(Optional) The code for the signer language version of the disclosure that you want to retrieve. 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.

Response

Successful response.