Template Document Visibility

Returns document visibility for a template recipient

GET
/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility

This method returns information about document visibility for a template recipient.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

recipientId*string

A local reference used to map recipients to other objects, such as specific document tabs.

A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.

For example, many envelopes assign the first recipient a recipientId of 1.

templateId*string

The ID of the template.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/templates/string/recipients/string/document_visibility"
{  "documentVisibility": [    {      "documentId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "recipientId": "string",      "rights": "string",      "visible": "string"    }  ]}