DocuSign REST API — EnvelopeDocuments

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — EnvelopeDocuments
  description: 'DocuSign REST API — EnvelopeDocuments. 5 operations. Lead operation: Docusign Gets a list of envelope documents..
    Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - EnvelopeDocuments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-envelopedocuments
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — EnvelopeDocuments business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-envelopes-envelopeId-documents
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/documents
      operations:
      - name: documentsgetdocuments
        method: GET
        description: Docusign Gets a list of envelope documents.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: include_document_size
          in: query
          type: string
      - name: documentsputdocuments
        method: PUT
        description: Docusign Adds one or more documents to an existing envelope document.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: apply_document_fields
          in: query
          type: string
          description: When **true**, document fields
        - name: persist_tabs
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: documentsdeletedocuments
        method: DELETE
        description: Docusign Deletes documents from a draft envelope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-accounts-accountId-envelopes-envelopeId-documents-documentId
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
      operations:
      - name: documentsgetdocument
        method: GET
        description: Docusign Gets a document from an envelope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: documentId
          in: path
          type: string
          description: The ID of the document being accessed.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: certificate
          in: query
          type: string
          description: When set to **false**, the envelope signing certificate is removed from the download.
        - name: encoding
          in: query
          type: string
        - name: encrypt
          in: query
          type: string
          description: When set to **true**, the PDF bytes returned in the response are encrypted for all the key managers
            configured on your DocuSign account. The documents can be de
        - name: language
          in: query
          type: string
          description: 'Specifies the language for the Certificate of Completion in the response. The supported languages,
            with the language value shown in parenthesis, are: Chinese Si'
        - name: recipient_id
          in: query
          type: string
        - name: show_changes
          in: query
          type: string
          description: When set to **true**, any changed fields for the returned PDF are highlighted in yellow and optional
            signatures or initials outlined in red.
        - name: watermark
          in: query
          type: string
          description: When set to **true**, the account has the watermark feature enabled, and the envelope is not complete,
            the watermark for the account is added to the PDF documen
      - name: documentsputdocument
        method: PUT
        description: Docusign Adds a document to an existing draft envelope.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: documentId
          in: path
          type: string
          description: The ID of the document being accessed.
          required: true
        - name: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: apply_document_fields
          in: query
          type: string
          description: When **true**, document fields
  exposes:
  - type: rest
    namespace: docusign-envelopedocuments-rest
    port: 8080
    description: REST adapter for DocuSign REST API — EnvelopeDocuments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/documents
      name: v2-accounts-accountid-envelopes-envelopeid-documents
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-documents.
      operations:
      - method: GET
        name: documentsgetdocuments
        description: Docusign Gets a list of envelope documents.
        call: docusign-envelopedocuments.documentsgetdocuments
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          include_document_size: rest.include_document_size
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: documentsputdocuments
        description: Docusign Adds one or more documents to an existing envelope document.
        call: docusign-envelopedocuments.documentsputdocuments
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          apply_document_fields: rest.apply_document_fields
          persist_tabs: rest.persist_tabs
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: documentsdeletedocuments
        description: Docusign Deletes documents from a draft envelope.
        call: docusign-envelopedocuments.documentsdeletedocuments
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/documents/{documentid}
      name: v2-accounts-accountid-envelopes-envelopeid-documents-documentid
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-documents-documentId.
      operations:
      - method: GET
        name: documentsgetdocument
        description: Docusign Gets a document from an envelope.
        call: docusign-envelopedocuments.documentsgetdocument
        with:
          accountId: rest.accountId
          documentId: rest.documentId
          envelopeId: rest.envelopeId
          certificate: rest.certificate
          encoding: rest.encoding
          encrypt: rest.encrypt
          language: rest.language
          recipient_id: rest.recipient_id
          show_changes: rest.show_changes
          watermark: rest.watermark
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: documentsputdocument
        description: Docusign Adds a document to an existing draft envelope.
        call: docusign-envelopedocuments.documentsputdocument
        with:
          accountId: rest.accountId
          documentId: rest.documentId
          envelopeId: rest.envelopeId
          apply_document_fields: rest.apply_document_fields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-envelopedocuments-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — EnvelopeDocuments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: docusign-gets-list-envelope-documents
      description: Docusign Gets a list of envelope documents.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-envelopedocuments.documentsgetdocuments
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        include_document_size: tools.include_document_size
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-adds-one-more-documents
      description: Docusign Adds one or more documents to an existing envelope document.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-envelopedocuments.documentsputdocuments
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        apply_document_fields: tools.apply_document_fields
        persist_tabs: tools.persist_tabs
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-deletes-documents-draft-envelope
      description: Docusign Deletes documents from a draft envelope.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: docusign-envelopedocuments.documentsdeletedocuments
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-gets-document-envelope
      description: Docusign Gets a document from an envelope.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-envelopedocuments.documentsgetdocument
      with:
        accountId: tools.accountId
        documentId: tools.documentId
        envelopeId: tools.envelopeId
        certificate: tools.certificate
        encoding: tools.encoding
        encrypt: tools.encrypt
        language: tools.language
        recipient_id: tools.recipient_id
        show_changes: tools.show_changes
        watermark: tools.watermark
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-adds-document-existing-draft
      description: Docusign Adds a document to an existing draft envelope.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-envelopedocuments.documentsputdocument
      with:
        accountId: tools.accountId
        documentId: tools.documentId
        envelopeId: tools.envelopeId
        apply_document_fields: tools.apply_document_fields
      outputParameters:
      - type: object
        mapping: $.