Skip to navigation

EnvelopeDocumentVisibility Resource

View as Markdown

The Envelope Documents Visibility resource provides methods that manage document views and insights in an envelope.

Methods supported

MethodDescription
getGET /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
Returns document visibility for the recipients
updatePUT /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility
Updates document visibility for the recipients
updateListPUT /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility
Updates document visibility for the recipients

EnvelopeDocumentVisibility properties

PropertyTypeDescription
documentVisibilityarrayA list of documentVisibility objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true.