Request

HTTP request

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

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).

recipientIdstring

The recipientId used when the envelope or template was created.

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeDocumentVisibility
400

Error encountered.

errorDetails

SDK Method

Envelopes::getRecipientDocumentVisibility

Definitions

documentVisibility

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

recipientIdstring

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

visiblestring

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.

EnvelopeDocumentVisibility

documentVisibility[documentVisibility]

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

Examples

Generic JSON Response

Response
{
  "documentVisibility": [
    {
      "recipientId": "sample string 1",
      "documentId": "sample string 2",
      "visible": "sample string 3",
      "rights": "sample string 4",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<documentVisibilityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <documentVisibility>
    <documentVisibility>
      <documentId>sample string 2</documentId>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <recipientId>sample string 1</recipientId>
      <rights>sample string 4</rights>
      <visible>sample string 3</visible>
    </documentVisibility>
  </documentVisibility>
</documentVisibilityList> 
}} />