Docusign EnvelopeDocumentVisibility API

openapi: 3.2.0
info:
  title: Docusign Envelope Document Visibility API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeDocumentVisibility across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: EnvelopeDocumentVisibility
  description: The Envelope Documents Visibility resource provides methods that manage document views and insights in an envelope.
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility:
    get:
      tags:
      - EnvelopeDocumentVisibility
      summary: Docusign Returns document visibility for the recipients
      operationId: Recipients_GetRecipientDocumentVisibility
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      - name: recipientId
        in: path
        description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentVisibilityList'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getRecipientDocumentVisibility
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    put:
      tags:
      - EnvelopeDocumentVisibility
      summary: Docusign Updates document visibility for the recipients
      operationId: Recipients_PutRecipientDocumentVisibility
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      - name: recipientId
        in: path
        description: A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentVisibilityList'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentVisibilityList'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentVisibilityList'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateRecipientDocumentVisibility
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: documentVisibilityList
    servers:
    - url: https://www.docusign.net/restapi
  /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility:
    put:
      tags:
      - EnvelopeDocumentVisibility
      summary: Docusign Updates document visibility for the recipients
      operationId: Recipients_PutRecipientsDocumentVisibility
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentVisibilityList'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentVisibilityList'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentVisibilityList'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateRecipientsDocumentVisibility
      x-ds-method: updateList
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: documentVisibilityList
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility:
    parameters: []
    get:
      tags:
      - EnvelopeDocumentVisibility
      summary: Returns document visibility for a recipient
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdRecipientsByRecipientIdDocumentVisibility
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      - name: recipientId
        in: path
        description: '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`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentVisibilityList_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getRecipientDocumentVisibility
      description: This method returns information about document visibility for a recipient.
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: Recipients_GetRecipientDocumentVisibility
    put:
      tags:
      - EnvelopeDocumentVisibility
      summary: Updates document visibility for a recipient
      operationId: putV21AccountsByAccountIdEnvelopesByEnvelopeIdRecipientsByRecipientIdDocumentVisibility
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      - name: recipientId
        in: path
        description: '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`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentVisibilityList_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateRecipientDocumentVisibility
      description: 'This method updates document visibility for a recipient.


        **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.'
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentVisibilityList_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentVisibilityList_2'
      x-operation-id-source: normalized
      x-operation-id-original: Recipients_PutRecipientDocumentVisibility
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility:
    parameters: []
    put:
      tags:
      - EnvelopeDocumentVisibility
      summary: Updates document visibility for recipients
      operationId: putV21AccountsByAccountIdEnvelopesByEnvelopeIdRecipientsDocumentVisibility
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentVisibilityList_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateRecipientsDocumentVisibility
      description: 'This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.


        **Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.'
      x-ds-method: updateRecipientsDocumentVisibility
      x-ds-service: EnvelopeDocumentVisibility
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentVisibilityList_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/documentVisibilityList_2'
      x-operation-id-source: normalized
      x-operation-id-original: Recipients_PutRecipientsDocumentVisibility
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    documentVisibilityList:
      type: object
      properties:
        documentVisibility:
          type: array
          description: A 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**.
          items:
            $ref: '#/components/schemas/documentVisibility'
      description: ''
      x-ds-definition-name: documentVisibilityList
      x-ms-summary: ''
    documentVisibility:
      type: object
      properties:
        documentId:
          type: string
          description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        recipientId:
          type: string
          description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
        rights:
          type: string
          description: ''
        visible:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: documentVisibility
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    documentVisibilityList_2:
      type: object
      properties:
        documentVisibility:
          description: An array of `documentVisibility` objects that specifies which documents are visible to which recipients.
          type: array
          items:
            $ref: '#/components/schemas/documentVisibility_2'
      description: A list of `documentVisibility` objects that specify whether documents are visible to recipients.
      x-ds-definition-name: documentVisibilityList
      x-ms-summary: A list of `documentVisibility` objects that specify whether documents are visible to recipients.
    documentVisibility_2:
      type: object
      properties:
        documentId:
          description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        recipientId:
          description: 'The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.

            '
          type: string
        rights:
          description: 'Indicates whether the document is editable:


            - `editable`

            - `read_only`'
          type: string
        visible:
          description: When **true,** the document is visible to the recipient.
          type: string
      description: This object configures a recipient's read/write access to a document.
      x-ds-definition-name: documentVisibility
      x-ms-summary: This object configures a recipient's read/write access to a document.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'