Skip to navigation

AccountConsumerDisclosures Resource

View as Markdown

The AccountConsumerDisclosures resource provides methods that allow you to retrieve the consumer disclosures associated with the account.

Methods supported

MethodDescription
getGET /restapi/v2/accounts/{accountId}/consumer_disclosure/{langCode}
Gets the Electronic Record and Signature Disclosure.
getDefaultGET /restapi/v2/accounts/{accountId}/consumer_disclosure
Gets the Electronic Record and Signature Disclosure for the account.
updatePUT /restapi/v2/accounts/{accountId}/consumer_disclosure/{langCode}
Update Consumer Disclosure.

AccountConsumerDisclosures properties

PropertyTypeDescription
accountEsignIdstringA GUID identifying the account associated with the consumer disclosure
allowCDWithdrawstringIndicates whether the customer can withdraw their acceptance of the consumer disclosure.
allowCDWithdrawMetadatasettingsMetadata
changeEmailstring
changeEmailOtherstring
companyNamestringThe name of the company associated with the consumer disclosure.
companyPhonestringThe phone number of the company associated with the consumer disclosure.
copyCostPerPagestring
copyFeeCollectionMethodstringSpecifies the fee collection method for cases in which the customer requires paper copies of the document.

Maximum Length: 255 characters
copyRequestEmailstring
customstring
enableEsignstring
esignAgreementstringThe Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.
esignTextstring
languageCodestring
mustAgreeToEsignstring
pdfIdstringDeprecated

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
withdrawAddressLine1stringContains the first address line of the postal address to which a customer can send a consent withdrawal notification.

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

Maximum length: 100 characters.
withdrawByEmailstringIndicates whether the customer can withdraw consent by email.
withdrawByMailstringIndicates whether the customer can withdraw consent by postal mail.
withdrawByPhonestringIndicates whether the customer can withdraw consent by phone.
withdrawCitystringContains the city of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 50 characters.
withdrawConsequencesstringIndicates the consequences of withdrawing consent.
withdrawEmailstringContains the email address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.
withdrawOtherstringIndicates other information need to withdraw consent.

Maximum length: 255 characters.
withdrawPhonestringContains the phone number which a customer can call to register consent withdrawal notification.

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

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