Docusign Envelopes API

Create, send, and manage envelopes. An envelope is the fundamental unit of a DocuSign transaction, containing the documents to be signed, the recipients who will sign them, and the workflow rules.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

docusign-envelopes-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: DocuSign Admin AccountBrands Envelopes API
  description: An API for an organization administrator to manage organizations, accounts and users
  termsOfService: https://www.docusign.com/company/terms-and-conditions/developers
  contact:
    name: DocuSign Developer Center
    url: https://developers.docusign.com
    email: devcenter@docusign.com
  version: v2.1
servers:
- url: https://api.docusign.net/Management
tags:
- name: Envelopes
  description: Create, send, and manage envelopes. An envelope is the fundamental unit of a DocuSign transaction, containing the documents to be signed, the recipients who will sign them, and the workflow rules.
  externalDocs:
    url: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/
paths:
  /accounts/{accountId}/envelopes:
    post:
      operationId: Envelopes_CreateEnvelope
      summary: Docusign Create an Envelope
      description: Creates and optionally sends an envelope. An envelope is the container for documents, recipients, and the workflow information. You can create an envelope in draft status to allow for further modifications, or send it immediately upon creation.
      tags:
      - Envelopes
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvelopeDefinition'
      responses:
        '201':
          description: Envelope created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeSummary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: Envelopes_ListEnvelopes
      summary: Docusign List Envelopes
      description: Returns a list of envelopes that match the specified criteria. Use query parameters to filter by date, status, and other envelope properties.
      tags:
      - Envelopes
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: from_date
        in: query
        description: Start date for the envelope search. Only envelopes created on or after this date are returned. Format is ISO 8601.
        schema:
          type: string
          format: date-time
      - name: to_date
        in: query
        description: End date for the envelope search. Only envelopes created before this date are returned. Format is ISO 8601.
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        description: Filter by envelope status. Valid values include created, sent, delivered, signed, completed, declined, voided, deleted.
        schema:
          type: string
          enum:
          - created
          - sent
          - delivered
          - signed
          - completed
          - declined
          - voided
          - deleted
      - name: from_to_status
        in: query
        description: The status value checked for in the from_date and to_date range. Default is changed.
        schema:
          type: string
      - name: count
        in: query
        description: Maximum number of envelopes to return. Default is 100.
        schema:
          type: integer
          default: 100
      - name: start_position
        in: query
        description: Starting index position for the result set.
        schema:
          type: integer
      - name: search_text
        in: query
        description: Free text search across envelope metadata including recipient names, email addresses, and custom fields.
        schema:
          type: string
      - name: order
        in: query
        description: Sort order for results. Valid values are asc and desc.
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: order_by
        in: query
        description: The envelope property to sort by. Valid values include created, completed, last_modified, sent, status_changed.
        schema:
          type: string
      - name: folder_ids
        in: query
        description: Comma-separated list of folder IDs to search within.
        schema:
          type: string
      - name: include
        in: query
        description: Comma-separated list of additional information to include. Valid values include custom_fields, documents, attachments, extensions, folders, recipients, powerform.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list of envelopes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopesInformation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accounts/{accountId}/envelopes/{envelopeId}:
    get:
      operationId: Envelopes_GetEnvelope
      summary: Docusign Get an Envelope
      description: Retrieves the overall status and properties of a single envelope. Returns information about the envelope including its status, sender, recipients, and documents.
      tags:
      - Envelopes
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/envelopeId'
      - name: include
        in: query
        description: Comma-separated list of additional information to include. Valid values include custom_fields, documents, attachments, extensions, folders, recipients, powerform, tabs.
        schema:
          type: string
      - name: advanced_update
        in: query
        description: When true, allows sender to update an in-process envelope.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: Envelopes_UpdateEnvelope
      summary: Docusign Update an Envelope
      description: Updates the envelope specified by envelopeId. You can use this method to modify envelope properties such as the email subject and message, resend notifications, void envelopes, and purge documents.
      tags:
      - Envelopes
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/envelopeId'
      - name: resend_envelope
        in: query
        description: When true, resends the envelope to all recipients who have not yet completed their actions.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Envelope'
      responses:
        '200':
          description: Envelope updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeUpdateSummary'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/accounts/{accountId}/envelopes:
    get:
      tags:
      - Envelopes
      summary: Docusign Gets status changes for one or more envelopes.
      description: "Retrieves a list of envelopes that match your request. \nA large set of optional filters let you filter\nby date,\nby envelope ID,\nor by status codes.\n\nYour request must include one or more of the following parameters:\n\n* `from_date`\n* `envelope_ids`\n* `transaction_ids`\n\n\nGetting envelope status using `transaction_ids` is useful\nfor offline signing situations where it can be used\ndetermine if an envelope was created or not. It can be used\nfor the cases where a network connection was lost, before\nthe envelope status could be returned.\n\nTo avoid unnecessary database queries, the DocuSign\nsignature platform first checks requests to ensure that the\nfilter set supplied does not result in a zero-size response\nbefore querying the database. \n\nFor example, for a request with a `from_to_status` of\n`delivered` and a current `status` of `created,sent`,\nDocuSign will always return an empty list. \nThis is because the request translates to: find the\nenvelopes that were delivered between the `from_date` and\n`to_date` dates that have a current status of `created` or\n`sent`. Since an envelope that has been delivered can\nnever have a status of `created` or `sent`, a zero-size\nresponse would be generated. \nIn this case, DocuSign does not query the database\nand returns an empty list immediately.\n\n\nThe following table shows the valid current envelope\nstatuses (`status` parameter) for the different status\nqualifiers (`from_to_status` parameter) in the request. If\nthe status and status qualifiers in the API request do not\ncontain any of the values shown in the Valid Current\nStatuses column, then an empty list is returned.\n\nClient applications should check that the statuses (`status`\nparameter) they are requesting make sense for a given\n`from_to_status` parameter value.\n\n| Status Qualifier<br>(`from_to_status`) | Effective Status Qualifier | Valid Current Statuses                                                      |  \n| :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- |  \n| any (changed)                          | StatusChanged              | any, created, sent, delivered, signed, completed, declined, voided, deleted |  \n| created                                | Created                    | any, created, sent, delivered, signed, completed, declined, voided, deleted |  \n| sent                                   | Sent                       | any, sent, delivered, signed, completed, declined, voided, deleted          |  \n| delivered                              | StatusChanged              | any, delivered, signed, completed, declined, voided, deleted                |  \n| signed                                 | StatusChanged              | any, signed, completed, declined, voided, deleted                           |  \n| completed                              | Completed                  | any, completed, declined, voided, deleted                                   |  \n| declined                               | StatusChanged              | any, declined, voided, deleted                                              |  \n| timedout<br>always return zero results | StatusChanged              | any, voided, deleted                                                        |  \n| voided                                 | Voided                     | any, voided, deleted                                                        |  \n| deleted                                | StatusChanged              | any, deleted                                                                |  \n\n## Extraneous results\n\nIn some cases, a request for a specific envelope status will\ninclude envelopes with additional statuses. For example, in\na request with a `from_date` of 2017-01-01, a `to_date` of\n2017-01-07 and the status qualifier (`from_to_status`) set\nto `delivered`, the response set might contain envelopes\nthat were created during that time period, but not delivered\nduring the time period. As a workaround, check the envelope\nstatus values in the result set as needed. \n"
      operationId: Envelopes_GetEnvelopes
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: ac_status
        in: query
        description: 'Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.'
        schema:
          type: string
      - name: block
        in: query
        description: 'Reserved for DocuSign.

          '
        schema:
          type: string
      - name: count
        in: query
        description: 'Optional. Number of items to return. Currently there is no implicit maximum limit of the number of items that can be returned.

          '
        schema:
          type: string
      - name: custom_field
        in: query
        description: "Optional. Specifies a envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`\n\nExample: If you have an envelope custom field named \"Region\" and you want to search for all envelopes where the value is \"West\" you would use set this parameter to `Region=West`. \n \n"
        schema:
          type: string
      - name: email
        in: query
        description: 'Limit results to envelopes

          sent by the account user

          with this email address.


          `user_name` must be given as well,

          and both `email` and `user_name`

          must refer to an existing account user.

          '
        schema:
          type: string
      - name: envelope_ids
        in: query
        description: Comma separated list of `envelopeId` values.
        schema:
          type: string
      - name: from_date
        in: query
        description: 'Specifies the date and time

          to start looking for status changes.

          This parameter is required

          unless `envelopeIds` or `transactionIds`

          are set.



          Although you can use any date format

          supported by the .NET system library''s

          [`DateTime.Parse()`][msoft] function,

          DocuSign recommends

          using [ISO 8601][] format dates

          with an explicit time zone offset

          If you do not provide

          a time zone offset,

          the method uses the server''s time zone.


          For example, the following dates and times refer to the same instant:


          * `2017-05-02T01:44Z`

          * `2017-05-01T21:44-04:00`

          * `2017-05-01T18:44-07:00`



          [msoft]: https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse

          [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601'
        schema:
          type: string
      - name: from_to_status
        in: query
        description: "The status value checked for in the `from_date` to `to_date` time period. \n\nPossible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.\n\nIf `Changed` is specified, then envelopes that changed status during the period will be returned. \n\nFor example, if `Created` is specified, then envelopes created during the period are found. \n\nThe default is `Changed`. "
        schema:
          type: string
      - name: start_position
        in: query
        description: 'This value is supported and currently has no implicit maximum items.

          '
        schema:
          type: string
      - name: status
        in: query
        description: 'A comma-separated list of current envelope statuses to included in the response. Possible values are:


          * completed

          * created

          * declined

          * deleted

          * delivered

          * processing

          * sent

          * signed

          * timedout

          * voided


          The `any` value is equivalent to any status.


          '
        schema:
          type: string
      - name: to_date
        in: query
        description: 'Specifies the date and time

          to stop looking for status changes.

          The default is the current date and time.


          Although you can use any date format

          supported by the .NET system library''s

          [`DateTime.Parse()`][msoft] function,

          DocuSign recommends

          using [ISO 8601][] format dates

          with an explicit time zone offset

          If you do not provide

          a time zone offset,

          the method uses the server''s time zone.


          For example, the following dates and times refer to the same instant:


          * `2017-05-02T01:44Z`

          * `2017-05-01T21:44-04:00`

          * `2017-05-01T18:44-07:00`



          [msoft]: https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse

          [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601

          '
        schema:
          type: string
      - name: transaction_ids
        in: query
        description: 'A comma-separated list of envelope transaction IDs.

          Transaction IDs are only valid for seven days.

          '
        schema:
          type: string
      - name: user_name
        in: query
        description: 'Limit results to envelopes

          sent by the account user

          with this user name.


          `email` must be given as well,

          and both `email` and `user_name`

          must refer to an existing account user.

          '
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopesInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listStatusChanges
      x-ds-method: listStatusChanges
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-ds-examples:
      - description: 'This example shows a how to get information about

          envelopes created since January 1, 2016.


          The request for this endpoint has no payload.


          ### Request

          ```

          GET /restapi/v2/accounts/1703061/envelopes?from_date=2016-01-01

          ```

          '
        direction: response
        format: json
        response:
          endPosition: '1'
          envelopes:
          - certificateUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/certificate
            customFieldsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/custom_fields
            documentsCombinedUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents/combined
            documentsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/documents
            envelopeId: 379497bb-cc85-4654-bab9-a8e397f538d0
            envelopeUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0
            notificationUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/notification
            recipientsUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/recipients
            status: completed
            statusChangedDateTime: 2016-10-04 15:26:28.283000+00:00
            templatesUri: /envelopes/379497bb-cc85-4654-bab9-a8e397f538d0/templates
          - certificateUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/certificate
            customFieldsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/custom_fields
            documentsCombinedUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents/combined
            documentsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/documents
            envelopeId: 4b728be4-4417-45c6-b7e8-d63e23f822b6
            envelopeUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6
            notificationUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/notification
            recipientsUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/recipients
            status: sent
            statusChangedDateTime: 2016-10-05 01:04:58.777000+00:00
            templatesUri: /envelopes/4b728be4-4417-45c6-b7e8-d63e23f822b6/templates
          nextUri: ''
          previousUri: ''
          resultSetSize: '2'
          startPosition: '0'
          totalSetSize: '2'
        style: custom
        title: Get Status About Envelopes Since a Specified Date
    post:
      tags:
      - Envelopes
      summary: Docusign Creates an envelope.
      description: "Creates and sends an envelope or creates a draft envelope.\nEnvelopes are fundamental resources in the DocuSign platform.\n\nWith this method you can:\n\n* Create and send an envelope\n  with [documents][], [recipients][], and [tabs][].\n* Create and send an envelope from a template.\n* Create and send an envelope from\n  a combination of documents and templates.\n* Create a draft envelope.\n\n\nWhen you use this method\nto create and send an envelope\nin a single request,\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition]) are required:\n\n| Parameter      | Description |\n| :--------      | :---------- |\n| `status`       | Set to `sent` to send the envelope to recipients.<br>Set to `created` (or don't set at all) to save the envelope as a draft. |\n| `emailSubject` | The subject of the email used to send the envelope. |\n| `documents`    | The [documents][] to be signed. |\n| `recipients`   | The email addresses of the envelope [recipients][]. |\n\n\nThere are many ways to use envelopes.\nYou can create and send an envelope\nwith a single API request,\nor you can use several API requests\nto create, populate, and send envelopes.\n\n\n| See                     | To learn about                                                                                                                    |\n| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |\n| [Envelopes][envelopes]   | Envelopes, [adding documents][addingdocs], [tracking][], [locking][], [deleting][], [templates][]                                  |\n| [Documents][documents]   | Documents, [attachments][], [supplemental documents][supdocs], [authoritative copies][authcopies], [purging][]                     |\n| [Recipients][recipients] | Recipients, [recipient types][reciptypes], [recipient status][recipstatus]                                                         |\n| [Tabs][tabs]             | Tabs, [tab types][tabtypes], [anchoring tabs][tabanchor], [auto-populating tabs][tabauto],  [custom tabs][tabcustom], [payments][] |\n\n\n[addingdocs]:           https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#adding-documents-to-an-envelope\n[attachments]:          https://developers.docusign.com/esign-rest-api/guides/concepts/documents#attachments\n[authcopies]:           https://developers.docusign.com/esign-rest-api/guides/concepts/documents#authoritative-copies\n[conoverview]:          https://developers.docusign.com/esign-rest-api/guides/concepts/overview\n[deleting]:             https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#deleting-envelopes\n[documents]:            https://developers.docusign.com/esign-rest-api/guides/concepts/documents\n[envelopeDefinition]:   https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create#envelopeDefinition\n[envelopes]:            https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes\n[locking]:              https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#locking-envelopes\n[payments]:             https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#requesting-payments\n[purging]:              https://developers.docusign.com/esign-rest-api/guides/concepts/documents#purging-documents\n[recipients]:           https://developers.docusign.com/esign-rest-api/guides/concepts/recipients\n[recipstatus]:          https://developers.docusign.com/esign-rest-api/guides/concepts/recipients#recipient-status\n[reciptypes]:           https://developers.docusign.com/esign-rest-api/guides/concepts/recipients#recipient-types\n[supdocs]:              https://developers.docusign.com/esign-rest-api/guides/concepts/documents#supplemental-documents\n[tabanchor]:            https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#anchoring-tabs\n[tabauto]:              https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#automatically-populating-tabs\n[tabcustom]:            https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#using-custom-tabs-in-envelopes-and-templates\n[tabs]:                 https://developers.docusign.com/esign-rest-api/guides/concepts/tabs\n[tabtypes]:             https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#tab-types\n[templates]:            https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#working-with-templates\n[tracking]:             https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes#tracking-envelope-status\n\n**Note**: When you create an envelope by using a [composite template](https://developers.docusign.com/esign-rest-api/guides/concepts/templates#composite-templates), you should specify the envelope custom fields in the inline template. Any custom fields that you specify at the root level are ignored.\n"
      operationId: Envelopes_PostEnvelopes
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: cdse_mode
        in: query
        description: 'Reserved for DocuSign.

          '
        schema:
          type: string
      - name: change_routing_order
        in: query
        description: When true, users can define the routing order of recipients while sending documents for signature.
        schema:
          type: string
      - name: completed_documents_only
        in: query
        description: 'Reserved for DocuSign.

          '
        schema:
          type: string
      - name: merge_roles_on_draft
        in: query
        description: 'When set to **true**, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)


          ###### Note: DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.'
        schema:
          type: string
      - name: tab_label_exact_matches
        in: query
        description: 'Reserved for DocuSign.


          <!--

          Note from Kate Dougherty: This functionality has not been released yet. When it is (contact Alia Paddock with any questions), use the following description:


          "When set to **true**, each tab in the inline template is matched and collapsed with all qualified tabs in the server template. When set to **false** (default), each tab in the inline template is matched and collapsed with at most one qualified tab in the server template.


          This parameter applies when you create an envelope from a composite template."

          -->

          '
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/envelopeDefinition'
          application/xml:
            schema:
              $ref: '#/components/schemas/envelopeDefinition'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopeSummary'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: createEnvelope
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-ds-examples:
      - description: 'This example shows a request/response that includes:


          * A single PDF document to be signed

          * One tab positioned using anchor text

          * One recipient


          See [Requesting a Signature via Email](/esign/guide/usage/request_a_signature.html)

          for a full walkthrough of this example.

          '
        direction: both
        format: json
        response:
          envelopeId: 63e05468-6432-41d2-b01c-8b48f7dbeb80
          status: sent
          statusDateTime: 2016-05-29 17:11:56.180000+00:00
          uri: /envelopes/63e05468-6432-41d2-b01c-8b48f7dbeb80
        request:
          documents:
          - documentBase64: '[Document content (PDF File)]'
            documentId: '1'
            fileExtension: pdf
            name: NDA.pdf
          emailSubject: Please sign the NDA
          recipients:
            signers:
            - email: the_nda_signer@example.com
              name: Darlene Petersen
              recipientId: '1'
              routingOrder: '1'
              tabs:
                dateSignedTabs:
                - anchorString: signer1date
                  anchorYOffset: '-6'
                  fontSize: Size12
                  name: Date Signed
                  recipientId: '1'
                  tabLabel: date_signed
                fullNameTabs:
                - anchorString: signer1name
                  anchorYOffset: '-6'
                  fontSize: Size12
                  name: Full Name
                  recipientId: '1'
                  tabLabel: Full Name
                signHereTabs:
                - anchorString: signer1sig
                  anchorUnits: mms
                  anchorXOffset: '0'
                  anchorYOffset: '0'
                  name: Please sign here
                  optional: 'false'
                  recipientId: '1'
                  scaleValue: 1
                  tabLabel: signer1sig
          status: sent
        style: custom
        title: Request Signature on Single Document by Email
      - description: 'This example shows a request/response that includes:


          * Multiple documents, both pdf and Word docx files.

          * Multiple tabs including signing, fullName, dateSigned, and text tabs.

          * Tabs positioned using anchor text.

          * Two recipients, a signer and a cc recipient.


          For more information, and to try this request live, see the [API Recipe](https://www.docusign.com/developer-center/recipes/send-multiple-docs)

          '
        direction: both
        format: json
        response:
          envelopeId: 63e05468-6432-41d2-b01c-8b48f7dbeb80
          status: sent
          statusDateTime: 2016-05-29 17:11:56.180000+00:00
          uri: /envelopes/63e05468-6432-41d2-b01c-8b48f7dbeb80
        request:
          documents:
          - documentBase64: '[Document 1 content (PDF File)]'
            documentId: '1'
            fileExtension: pdf
            name: NDA.pdf
          - documentBase64: '[Document 2 content (PDF File)]'
            documentId: '2'
            fileExtension: pdf
            name: House.pdf
          - documentBase64: '[Document 3 content (Word file)]'
            documentId: '3'
            fileExtension: docx
            name: contractor_agreement.docx
          emailSubject: Please sign the house documentation package
          recipients:
            carbonCopies:
            - email: cody_vigil@worldwidecorp.example.com
              name: Cody Vigil
              recipientId: '2'
              routingOrder: '2'
            signers:
            - email: darlene_petersen@newco.example.com
              name: Darlene Petersen
              recipientId: '1'
              routingOrder: '1'
              tabs:
                dateSignedTabs:
                - anchorString: signer1date
                  anchorYOffset: '-6'
                  fontSize: Size12
                  name: Date Signed
                  recipientId: '1'
                  tabLabel: date_signed

# --- truncated at 32 KB (622 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/docusign/refs/heads/main/openapi/docusign-envelopes-api-openapi.yml