Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID. (For example, 93be49ab-afa0-4adf-933c-f752070d71ec).

langCodestring

The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are: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 Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (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) and Vietnamese (vi). Additionally, the value can be set to "browser" to automatically detect the browser language being used by the viewer and display the disclosure in that language.

recipientIdstring

The recipientId used when the envelope or template was created.

Optional Query Parameters
langCodestring

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeConsumerDisclosures
400

Error encountered.

errorDetails

SDK Method

Envelopes::getConsumerDisclosure

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

settingsMetadata

Metadata that indicates whether a property is editable and describes setting-specific options.

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

EnvelopeConsumerDisclosures

Envelope consumer disclosures

accountEsignIdstring

A GUID identifying the account associated with the consumer disclosure

allowCDWithdrawstring

Indicates whether the customer can withdraw their acceptance of the consumer disclosure.

allowCDWithdrawMetadatasettingsMetadata

Metadata that indicates whether the allowCDWithdraw property is editable.

changeEmailstring

changeEmailOtherstring

companyNamestring

The name of the company associated with the consumer disclosure.

companyPhonestring

The phone number of the company associated with the consumer disclosure.

copyCostPerPagestring

copyFeeCollectionMethodstring

Specifies the fee collection method for cases in which the customer requires paper copies of the document.

Maximum Length: 255 characters

copyRequestEmailstring

customstring

enableEsignstring

esignAgreementstring

The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.

esignTextstring

languageCodestring

mustAgreeToEsignstring

pdfIdstring

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.

useBrandstring

useConsumerDisclosureWithinAccountstring

useConsumerDisclosureWithinAccountMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosureWithinAccount property is editable.

withdrawAddressLine1string

Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.

withdrawAddressLine2string

Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.

withdrawByEmailstring

Indicates whether the customer can withdraw consent by email.

withdrawByMailstring

Indicates whether the customer can withdraw consent by postal mail.

withdrawByPhonestring

Indicates whether the customer can withdraw consent by phone.

withdrawCitystring

Contains the city of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 50 characters.

withdrawConsequencesstring

Indicates the consequences of withdrawing consent.

withdrawEmailstring

Contains the email address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.

withdrawOtherstring

Indicates other information need to withdraw consent.

Maximum length: 255 characters.

withdrawPhonestring

Contains the phone number which a customer can call to register consent withdrawal notification.

Maximum length: 20 characters.

withdrawPostalCodestring

Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 20 characters.

withdrawStatestring

Contains the state of the postal address to which a customer can send a consent withdrawal notification.

Examples

Generic JSON Response

Response
{
  "accountEsignId": "sample string 1",
  "companyName": "sample string 2",
  "companyPhone": "sample string 3",
  "withdrawEmail": "sample string 4",
  "withdrawByEmail": "sample string 5",
  "withdrawByPhone": "sample string 6",
  "withdrawByMail": "sample string 7",
  "withdrawAddressLine1": "sample string 8",
  "withdrawAddressLine2": "sample string 9",
  "withdrawCity": "sample string 10",
  "withdrawState": "sample string 11",
  "withdrawPostalCode": "sample string 12",
  "withdrawConsequences": "sample string 13",
  "withdrawOther": "sample string 14",
  "withdrawPhone": "sample string 15",
  "changeEmail": "sample string 16",
  "changeEmailOther": "sample string 17",
  "copyCostPerPage": "sample string 18",
  "copyRequestEmail": "sample string 19",
  "copyFeeCollectionMethod": "sample string 20",
  "custom": "sample string 21",
  "pdfId": "sample string 22",
  "enableEsign": "sample string 23",
  "languageCode": "sample string 24",
  "useBrand": "sample string 25",
  "esignAgreement": "sample string 26",
  "esignText": "sample string 27",
  "allowCDWithdraw": "sample string 28",
  "allowCDWithdrawMetadata": {
    "rights": "sample string 1",
    "uiHint": "sample string 2",
    "uiType": "sample string 3",
    "uiOrder": "sample string 4",
    "is21CFRPart11": "sample string 5",
    "options": [
      "sample string 1"
    ]
  },
  "mustAgreeToEsign": "sample string 29",
  "useConsumerDisclosureWithinAccount": "sample string 30",
  "useConsumerDisclosureWithinAccountMetadata": {}
}
Generic XML Response

Response
<consumerDisclosure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountEsignId>sample string 1</accountEsignId>
  <allowCDWithdraw>sample string 28</allowCDWithdraw>
  <allowCDWithdrawMetadata>
    <is21CFRPart11>sample string 5</is21CFRPart11>
    <options>
      <string>sample string 1</string>
    </options>
    <rights>sample string 1</rights>
    <uiHint>sample string 2</uiHint>
    <uiOrder>sample string 4</uiOrder>
    <uiType>sample string 3</uiType>
  </allowCDWithdrawMetadata>
  <changeEmail>sample string 16</changeEmail>
  <changeEmailOther>sample string 17</changeEmailOther>
  <companyName>sample string 2</companyName>
  <companyPhone>sample string 3</companyPhone>
  <copyCostPerPage>sample string 18</copyCostPerPage>
  <copyFeeCollectionMethod>sample string 20</copyFeeCollectionMethod>
  <copyRequestEmail>sample string 19</copyRequestEmail>
  <custom>sample string 21</custom>
  <enableEsign>sample string 23</enableEsign>
  <esignAgreement>sample string 26</esignAgreement>
  <esignText>sample string 27</esignText>
  <languageCode>sample string 24</languageCode>
  <mustAgreeToEsign>sample string 29</mustAgreeToEsign>
  <pdfId>sample string 22</pdfId>
  <useBrand>sample string 25</useBrand>
  <useConsumerDisclosureWithinAccount>sample string 30</useConsumerDisclosureWithinAccount>
  <useConsumerDisclosureWithinAccountMetadata />
  <withdrawAddressLine1>sample string 8</withdrawAddressLine1>
  <withdrawAddressLine2>sample string 9</withdrawAddressLine2>
  <withdrawByEmail>sample string 5</withdrawByEmail>
  <withdrawByMail>sample string 7</withdrawByMail>
  <withdrawByPhone>sample string 6</withdrawByPhone>
  <withdrawCity>sample string 10</withdrawCity>
  <withdrawConsequences>sample string 13</withdrawConsequences>
  <withdrawEmail>sample string 4</withdrawEmail>
  <withdrawOther>sample string 14</withdrawOther>
  <withdrawPhone>sample string 15</withdrawPhone>
  <withdrawPostalCode>sample string 12</withdrawPostalCode>
  <withdrawState>sample string 11</withdrawState>
</consumerDisclosure> 
}} />