Cmdlets for DocuSign

Build 24.0.9062

EnvelopeConsumerDisclosures

The EnvelopeConsumerDisclosures resource provides a method that allows you to retrieve the consumer disclosure for an envelope.

View Specific Information

In order to make a successful request on this view, you have to specify EnvelopeId and RecipientId.

For example:

SELECT * FROM [EnvelopeConsumerDisclosures] WHERE EnvelopeId = '7cc4251f-31ca-4a79-8221-53451222292d' AND RecipientId = 68364179

Columns

Name Type References Description
EnvelopeId String The envelope ID.
RecipientId String Unique Id for the recipient.
AccountEsignId [KEY] String A GUID identifying the account associated with the consumer disclosure.
CompanyName String The name of the company associated with the consumer disclosure.
CompanyPhone String The phone number of the company associated with the consumer disclosure.
ChangeEmail String Email of the account.
ChangeEmailOther String Other email information.
CopyCostPerPage String Copy cost for a page.
CopyFeeCollectionMethod String Specifies the fee collection method for cases in which the customer requires paper copies of the document.
EnableEsign String When is set to true, Esign is enabled.
EsignAgreement String The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.
EsignText String Text of the Esign.
MustAgreeToEsign String When is set ti true, customer must agree.
PdfId String 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.
AllowCDWithdraw String Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
WithdrawAddressLine1 String Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawAddressLine2 String Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.
WithdrawByEmail String Indicates whether the customer can withdraw consent by email.
WithdrawByMail String Indicates whether the customer can withdraw consent by postal mail.
WithdrawByPhone String Indicates whether the customer can withdraw consent by phone.
WithdrawCity String Contains the city of the postal address to which a customer can send a consent withdrawal notification.
WithdrawConsequences String Indicates the consequences of withdrawing consent.
WithdrawEmail String Contains the email address to which a customer can send a consent withdrawal notification.
WithdrawOther String Indicates other information need to withdraw consent.
WithdrawPhone String Contains the phone number which a customer can call to register consent withdrawal notification.
withdrawPostalCode String Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.
WithdrawState String Contains the state of the postal address to which a customer can send a consent withdrawal notification.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062