openapi: 3.0.3
info:
  title: Dropbox Sign Account Signature Request API
  description: Dropbox Sign v3 API
  termsOfService: https://www.hellosign.com/terms
  contact:
    email: apisupport@hellosign.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 3.0.0
servers:
- url: https://api.hellosign.com/v3
security:
- api_key: []
- oauth2:
  - account_access
  - signature_request_access
  - template_access
  - team_access
  - api_app_access
  - basic_account_info
  - request_signature
tags:
- name: Signature Request
  description:
    $ref: ./markdown/en/tags/signature-request-tag-description.md
paths:
  /signature_request/bulk_create_embedded_with_template:
    post:
      tags:
      - Signature Request
      summary: Embedded Bulk Send with Template
      description: 'Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.


        **NOTE:** Only available for Standard plan and higher.'
      operationId: signatureRequestBulkCreateEmbeddedWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSendJobSendResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh
      x-meta:
        seo:
          title: Embedded Bulk Send with Template | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here.
  /signature_request/bulk_send_with_template:
    post:
      tags:
      - Signature Request
      summary: Bulk Send with Template
      description: 'Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.


        **NOTE:** Only available for Standard plan and higher.'
      operationId: signatureRequestBulkSendWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSendJobSendResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh
      x-meta:
        seo:
          title: Bulk Send with Template | REST API | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here.
  /signature_request/cancel/{signature_request_id}:
    post:
      tags:
      - Signature Request
      summary: Cancel Incomplete Signature Request
      description: 'Cancels an incomplete signature request. This action is **not reversible**.


        The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.


        This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.


        To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.


        **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.'
      operationId: signatureRequestCancel
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the incomplete SignatureRequest to cancel.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json: {}
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestCancelExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestCancelExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestCancelExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestCancelExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestCancelExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestCancelExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestCancelExample.sh
      x-meta:
        seo:
          title: Cancel Incomplete Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here.
  /signature_request/create_embedded:
    post:
      tags:
      - Signature Request
      summary: Create Embedded Signature Request
      description: Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
      operationId: signatureRequestCreateEmbedded
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.sh
      x-meta:
        seo:
          title: Create Embedded Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here.
  /signature_request/create_embedded_with_template:
    post:
      tags:
      - Signature Request
      summary: Create Embedded Signature Request with Template
      description: Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
      operationId: signatureRequestCreateEmbeddedWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh
      x-meta:
        seo:
          title: Signature Request with Template | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.
  /signature_request/edit/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Signature Request
      description: 'Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEdit
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestSendResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestEditExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestEditExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestEditExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestEditExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestEditExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestEditExample.sh
      x-meta:
        seo:
          title: Edit Signature Request | REST API | Dropbox Sign for Developers
          description: Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.
  /signature_request/edit_embedded/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Embedded Signature Request
      description: 'Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEditEmbedded
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.sh
      x-meta:
        seo:
          title: Edit Embedded Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.
  /signature_request/edit_embedded_with_template/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Embedded Signature Request with Template
      description: 'Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEditEmbeddedWithTemplate
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh
      x-meta:
        seo:
          title: Signature Request with Template | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.
  /signature_request/edit_with_template/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Signature Request With Template
      description: 'Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEditWithTemplate
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestEditWithTemplateExample.sh
      x-meta:
        seo:
          title: Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers
          description: Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.
  /signature_request/files/{signature_request_id}:
    get:
      tags:
      - Signature Request
      summary: Download Files
      description: 'Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file.


        If the files are currently being prepared, a status code of `409` will be returned instead.'
      operationId: signatureRequestFiles
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to retrieve.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      - name: file_type
        in: query
        description: Set to `pdf` for a single merged document or `zip` for a collection of individual documents.
        schema:
          type: string
          default: pdf
          enum:
          - pdf
          - zip
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/zip:
              schema:
                type: string
                format: binary
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestFilesExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestFilesExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestFilesExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestFilesExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestFilesExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestFilesExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestFilesExample.sh
      x-meta:
        seo:
          title: Download Files | API Documentation | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here
  /signature_request/files_as_data_uri/{signature_request_id}:
    get:
      tags:
      - Signature Request
      summary: Download Files as Data Uri
      description: 'Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).


        If the files are currently being prepared, a status code of `409` will be returned instead.'
      operationId: signatureRequestFilesAsDataUri
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to retrieve.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileResponseDataUri'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestFilesResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestFilesAsDataUriExample.sh
      x-meta:
        seo:
          title: Download Files | API Documentation | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here
  /signature_request/files_as_file_url/{signature_request_id}:
    get:
      tags:
      - Signature Request
      summary: Download Files as File Url
      description: 'Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only).


        If the files are currently being prepared, a status code of `409` will be returned instead.'
      operationId: signatureRequestFilesAsFileUrl
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to retrieve.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      - name: force_download
        in: query
        description: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestFilesResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestFilesAsFileUrlExample.sh
      x-meta:
        seo:
          title: Download Files | API Documentation | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here
  /signature_request/{signature_request_id}:
    get:
      tags:
      - Signature Request
      summary: Get Signature Request
      description: Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
      operationId: signatureRequestGet
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to retrieve.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestGetResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestGetExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestGetExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestGetExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestGetExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestGetExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestGetExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestGetExample.sh
      x-meta:
        seo:
          title: Get Signature Request | Documentation | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.
  /signature_request/list:
    get:
      tags:
      - Signature Request
      summary: List Signature Requests
      description: 'Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.


        Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.'
      operationId: signatureRequestList
      parameters:
      - name: account_id
        in: query
        description: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
        schema:
          type: string
      - name: page
        in: query
        description: Which page number of the SignatureRequest List to return. Defaults to `1`.
        schema:
          type: integer
          default: 1
          example: 1
      - name: page_size
        in: query
        description: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
        schema:
          type: integer
          default: 20
      - name: query
        in: query
        description: String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestListResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestListResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestListExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestListExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestListExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestListExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestListExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestListExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestListExample.sh
      x-meta:
        seo:
          title: List Signature Requests | REST API | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.
  /signature_request/release_hold/{signature_request_id}:
    post:
      tags:
      - Signature Request
      summary: Release On-Hold Signature Request
      description: Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
      operationId: signatureRequestReleaseHold
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to release.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestReleaseHoldResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestReleaseHoldExample.sh
      x-meta:
        seo:
          title: Release On-Hold Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.
  /signature_request/remind/{signature_request_id}:
    post:
      tags:
      - Signature Request
      summary: Send Request Reminder
      description: 'Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.


        **NOTE:** This action can **not** be used with embedded signature requests.'
      operationId: signatureRequestRemind
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to send a reminder for.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestRemindRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestRemindRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestRemindResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestRemindExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestRemindExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestRemindExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestRemindExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestRemindExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestRemindExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestRemindExample.sh
      x-meta:
        seo:
          title: Send Request Reminder | REST API | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.
  /signature_request/remove/{signature_request_id}:
    post:
      tags:
      - Signature Request
      summary: Remove Signature Request Access
      description: 'Removes your access to a completed signature request. This action is **not reversible**.


        The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s).


        Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.'
      operationId: signatureRequestRemove
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to remove.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json: {}
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestRemoveExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestRemoveExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestRemoveExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestRemoveExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestRemoveExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestRemoveExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestRemoveExample.sh
      x-meta:
        seo:
          title: Remove Signature Request Access | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.
  /signature_request/send:
    post:
      tags:
      - Signature Request
      summary: Send Signature Request
      description: Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
      operationId: signatureRequestSend
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestSendRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestSendRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestSendRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestSendResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestSendExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestSendExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestSendExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestSendExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestSendExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestSendExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestSendExample.sh
      x-meta:
        seo:
          title: Send Signature Request | REST API | Dropbox Sign for Developers
          description: Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.
  /signature_request/send_with_template:
    post:
      tags:
      - Signature Request
      summary: Send with Template
      description: Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
      operationId: signatureRequestSendWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestSendWithTemplateExample.sh
      x-meta:
        seo:
          title: Send with Template | API Documentation | Dropbox Sign for Developers
          description: Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.
  /signature_request/update/{signature_request_id}:
    post:
      tags:
      - Signature Request
      summary: Update Signature Request
      description: 'Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.


        Updating the email address of a signer will generate a new `signature_id` value.


        **NOTE:** This action cannot be performed on a signature request with an appended signature page.'
      operationId: signatureRequestUpdate
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to update.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestUpdateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestUpdateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestUpdateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestUpdateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestUpdateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestUpdateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestUpdateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestUpdateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestUpdateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestUpdateExample.sh
      x-meta:
        seo:
          title: Update Signature Request | REST API | Dropbox Sign for Developers
          description: Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.
components:
  examples:
    Error401Response:
      summary: Error 401 unauthorized
      value:
        $ref: examples/json/Error401Response.json
    SignatureRequestBulkSendWithTemplateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json
    SignatureRequestCreateEmbeddedResponse:
      summary: Create Embedded Signature Request
      value:
        $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json
    SignatureRequestEditRequestGroupedSigners:
      summary: Grouped Signers Example
      value:
        $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json
    Error400Response:
      summary: Error 400 bad_request
      value:
        $ref: examples/json/Error400Response.json
    Error4XXResponse:
      summary: Error 4XX failed_operation
      value:
        $ref: examples/json/Error4XXResponse.json
    SignatureRequestEditEmbeddedWithTemplateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json
    SignatureRequestCreateEmbeddedWithTemplateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json
    SignatureRequestBulkCreateEmbeddedWithTemplateResponse:
      summary: Bulk Send Create Embedded Signature Request With Template
      value:
        $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json
    SignatureRequestUpdateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestUpdateRequest.json
    Error429Response:
      summary: Error 429 exceeded_rate
      value:
        $ref: examples/json/Error429Response.json
    SignatureRequestSendWithTemplateResponse:
      summary: Send Signature Request With Template
      value:
        $ref: examples/json/SignatureRequestSendWithTemplateResponse.json
    SignatureRequestEditEmbeddedRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestEditEmbeddedRequest.json
    Error410Response:
      summary: Error 410 deleted
      value:
        $ref: examples/json/Error410Response.json
    SignatureRequestCreateEmbeddedRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json
    SignatureRequestBulkSendWithTemplateResponse:
      summary: Send Signature Request With Template
      value:
        $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json
    Error402Response:
      summary: Error 402 payment_required
      value:
        $ref: examples/json/Error402Response.json
    Error403Response:
      summary: Error 403 forbidden
      value:
        $ref: examples/json/Error403Response.json
    SignatureRequestRemindResponse:
      summary: Send Signature Request Reminder
      value:
        $ref: examples/json/SignatureRequestRemindResponse.json
    SignatureRequestCreateEmbeddedWithTemplateResponse:
      summary: Create Embedded Signature Request With Template
      value:
        $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json
    SignatureRequestRemindRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestRemindRequest.json
    SignatureRequestSendRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestSendRequest.json
    SignatureRequestEditWithTemplateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestEditWithTemplateRequest.json
    SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json
    SignatureRequestSendRequestGroupedSigners:
      summary: Grouped Signers Example
      value:
        $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json
    SignatureRequestReleaseHoldResponse:
      summary: Send Signature Release Hold
      value:
        $ref: examples/json/SignatureRequestReleaseHoldResponse.json
    SignatureRequestEditRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestEditRequest.json
    SignatureRequestSendWithTemplateRequest:
      summary: Default Example
      value:
        $ref: examples/json/SignatureRequestSendWithTemplateRequest.json
    SignatureRequestCreateEmbeddedRequestGroupedSigners:
      summary: Grouped Signers Example
      value:
        $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json
    Error409Response:
      summary: Error 409 conflict
      value:
        $ref: examples/json/Error409Response.json
    SignatureRequestEditEmbeddedRequestGroupedSigners:
      summary: Grouped Signers Example
      value:
        $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json
    SignatureRequestUpdateResponse:
      summary: Signature Request Update
      value:
        $ref: examples/json/SignatureRequestUpdateResponse.json
    SignatureRequestFilesResponse:
      summary: Signature Requests Files
      value:
        $ref: examples/json/SignatureRequestFilesResponse.json
    Error404Response:
      summary: Error 404 not_found
      value:
        $ref: examples/json/Error404Response.json
    SignatureRequestListResponse:
      summary: List Signature Requests
      value:
        $ref: examples/json/SignatureRequestListResponse.json
    SignatureRequestSendResponse:
      summary: Send Signature Request
      value:
        $ref: examples/json/SignatureRequestSendResponse.json
    SignatureRequestGetResponse:
      summary: Get Signature Request
      value:
        $ref: examples/json/SignatureRequestGetResponse.json
  schemas:
    SignatureRequestEditWithTemplateRequest:
      description: ''
      required:
      - signers
      - template_ids
      properties:
        template_ids:
          description: Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
          type: array
          items:
            type: string
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        ccs:
          description: Add CC email recipients. Required when a CC role exists for the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCC'
        client_id:
          description: Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
          type: string
        custom_fields:
          description: An array defining values and options for custom fields. Required when a custom field exists in the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        is_eid:
          description: 'Send with a value of `true` if you wish to enable

            [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),

            which requires the signer to verify their identity with an eID provider to sign a document.<br>

            **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.'
          type: boolean
          default: false
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signers:
          description: Add Signers to your Templated-based Signature Request.
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        signing_redirect_url:
          description: The URL you want signers redirected to after they successfully sign.
          type: string
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
      type: object
    BulkSendJobResponse:
      description: Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
      properties:
        bulk_send_job_id:
          description: The id of the BulkSendJob.
          type: string
          nullable: true
        total:
          description: The total amount of Signature Requests queued for sending.
          type: integer
        is_creator:
          description: True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.
          type: boolean
        created_at:
          description: Time that the BulkSendJob was created.
          type: integer
      type: object
      x-internal-class: true
    SignatureRequestEditRequest:
      properties:
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        signers:
          description: 'Add Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestSigner'
        grouped_signers:
          description: 'Add Grouped Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestGroupedSigners'
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        allow_reassign:
          description: 'Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.


            **NOTE:** Only available for Premium plan and higher.'
          type: boolean
          default: false
        attachments:
          description: A list describing the attachments
          type: array
          items:
            $ref: '#/components/schemas/SubAttachment'
        cc_email_addresses:
          description: The email addresses that should be CCed.
          type: array
          items:
            type: string
            format: email
        client_id:
          description: The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
          type: string
        custom_fields:
          description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


            Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


            For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        field_options:
          $ref: '#/components/schemas/SubFieldOptions'
        form_field_groups:
          description: Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldGroup'
        form_field_rules:
          description: Conditional Logic rules for fields defined in `form_fields_per_document`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldRule'
        form_fields_per_document:
          description: 'The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)


            **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.


            * Text Field use `SubFormFieldsPerDocumentText`

            * Dropdown Field use `SubFormFieldsPerDocumentDropdown`

            * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`

            * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`

            * Radio Field use `SubFormFieldsPerDocumentRadio`

            * Signature Field use `SubFormFieldsPerDocumentSignature`

            * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`

            * Initials Field use `SubFormFieldsPerDocumentInitials`

            * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`

            * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`'
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
        hide_text_tags:
          description: 'Enables automatic Text Tag removal when set to true.


            **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.'
          type: boolean
          default: false
        is_eid:
          description: 'Send with a value of `true` if you wish to enable

            [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),

            which requires the signer to verify their identity with an eID provider to sign a document.<br>

            **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.'
          type: boolean
          default: false
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        signing_redirect_url:
          description: The URL you want signers redirected to after they successfully sign.
          type: string
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
        use_text_tags:
          description: Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
          type: boolean
          default: false
        expires_at:
          description: When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
          type: integer
          nullable: true
      type: object
    SignatureRequestSendRequest:
      properties:
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        signers:
          description: 'Add Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestSigner'
        grouped_signers:
          description: 'Add Grouped Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestGroupedSigners'
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        allow_reassign:
          description: 'Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.


            **NOTE:** Only available for Premium plan and higher.'
          type: boolean
          default: false
        attachments:
          description: A list describing the attachments
          type: array
          items:
            $ref: '#/components/schemas/SubAttachment'
        cc_email_addresses:
          description: The email addresses that should be CCed.
          type: array
          items:
            type: string
            format: email
        client_id:
          description: The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
          type: string
        custom_fields:
          description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


            Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


            For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        field_options:
          $ref: '#/components/schemas/SubFieldOptions'
        form_field_groups:
          description: Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldGroup'
        form_field_rules:
          description: Conditional Logic rules for fields defined in `form_fields_per_document`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldRule'
        form_fields_per_document:
          description: 'The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)


            **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.


            * Text Field use `SubFormFieldsPerDocumentText`

            * Dropdown Field use `SubFormFieldsPerDocumentDropdown`

            * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`

            * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`

            * Radio Field use `SubFormFieldsPerDocumentRadio`

            * Signature Field use `SubFormFieldsPerDocumentSignature`

            * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`

            * Initials Field use `SubFormFieldsPerDocumentInitials`

            * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`

            * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`'
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
        hide_text_tags:
          description: 'Enables automatic Text Tag removal when set to true.


            **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.'
          type: boolean
          default: false
        is_eid:
          description: 'Send with a value of `true` if you wish to enable

            [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),

            which requires the signer to verify their identity with an eID provider to sign a document.<br>

            **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.'
          type: boolean
          default: false
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        signing_redirect_url:
          description: The URL you want signers redirected to after they successfully sign.
          type: string
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
        use_text_tags:
          description: Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
          type: boolean
          default: false
        expires_at:
          description: When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
          type: integer
          nullable: true
      type: object
    SubCC:
      required:
      - role
      - email_address
      properties:
        role:
          description: Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.
          type: string
        email_address:
          description: The email address of the CC recipient.
          type: string
          format: email
      type: object
    SignatureRequestCreateEmbeddedWithTemplateRequest:
      required:
      - client_id
      - template_ids
      - signers
      properties:
        template_ids:
          description: Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
          type: array
          items:
            type: string
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        ccs:
          description: Add CC email recipients. Required when a CC role exists for the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCC'
        client_id:
          description: Client id of the app you're using to create this embedded signature request. Used for security purposes.
          type: string
        custom_fields:
          description: An array defining values and options for custom fields. Required when a custom field exists in the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signers:
          description: Add Signers to your Templated-based Signature Request.
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
        populate_auto_fill_fields:
          description: 'Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer''s information during signing.


            **NOTE:** Keep your signer''s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.'
          type: boolean
          default: false
      type: object
    ErrorResponse:
      required:
      - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
      type: object
    SubFieldOptions:
      description: This allows the requester to specify field options for a signature request.
      required:
      - date_format
      properties:
        date_format:
          description: 'Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))


            **NOTE:** Only available for Premium and higher.'
          type: string
          enum:
          - MM / DD / YYYY
          - MM - DD - YYYY
          - DD / MM / YYYY
          - DD - MM - YYYY
          - YYYY / MM / DD
          - YYYY - MM - DD
          x-enum-varnames:
          - MMDDYYYY
          - MM_DD_YYYY
          - DDMMYYYY
          - DD_MM_YYYY
          - YYYYMMDD
          - YYYY_MM_DD
      type: object
    SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
      required:
      - client_id
      - template_ids
      properties:
        template_ids:
          description: Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
          type: array
          items:
            type: string
        signer_file:
          description: "`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **NOTE:** Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"
          type: string
          format: binary
        signer_list:
          description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.'
          type: array
          items:
            $ref: '#/components/schemas/SubBulkSignerList'
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        ccs:
          description: Add CC email recipients. Required when a CC role exists for the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCC'
        client_id:
          description: Client id of the app you're using to create this embedded signature request. Used for security purposes.
          type: string
        custom_fields:
          description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


            Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


            For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signing_redirect_url:
          description: The URL you want signers redirected to after they successfully sign.
          type: string
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
      type: object
    SignatureRequestEditEmbeddedWithTemplateRequest:
      required:
      - client_id
      - template_ids
      - signers
      properties:
        template_ids:
          description: Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
          type: array
          items:
            type: string
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        ccs:
          description: Add CC email recipients. Required when a CC role exists for the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCC'
        client_id:
          description: Client id of the app you're using to create this embedded signature request. Used for security purposes.
          type: string
        custom_fields:
          description: An array defining values and options for custom fields. Required when a custom field exists in the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signers:
          description: Add Signers to your Templated-based Signature Request.
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
        populate_auto_fill_fields:
          description: 'Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer''s information during signing.


            **NOTE:** Keep your signer''s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.'
          type: boolean
          default: false
      type: object
    ListInfoResponse:
      description: Contains pagination information about the data returned.
      properties:
        num_pages:
          description: Total number of pages available.
          type: integer
        num_results:
          description: Total number of objects available.
          type: integer
          nullable: true
        page:
          description: Number of the page being returned.
          type: integer
        page_size:
          description: Objects returned per page.
          type: integer
      type: object
      x-internal-class: true
    SignatureRequestGetResponse:
      required:
      - signature_request
      properties:
        signature_request:
          $ref: '#/components/schemas/SignatureRequestResponse'
        warnings:
          description: A list of warnings.
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
      type: object
      x-internal-class: true
    SignatureRequestResponseDataBase:
      description: An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
      properties:
        api_id:
          description: The unique ID for this field.
          type: string
        signature_id:
          description: The ID of the signature to which this response is linked.
          type: string
        name:
          description: The name of the form field.
          type: string
        required:
          description: A boolean value denoting if this field is required.
          type: boolean
        type:
          type: string
      type: object
      discriminator:
        propertyName: type
        mapping:
          text: '#/components/schemas/SignatureRequestResponseDataValueText'
          checkbox: '#/components/schemas/SignatureRequestResponseDataValueCheckbox'
          dropdown: '#/components/schemas/SignatureRequestResponseDataValueDropdown'
          radio: '#/components/schemas/SignatureRequestResponseDataValueRadio'
          signature: '#/components/schemas/SignatureRequestResponseDataValueSignature'
          date_signed: '#/components/schemas/SignatureRequestResponseDataValueDateSigned'
          initials: '#/components/schemas/SignatureRequestResponseDataValueInitials'
          text-merge: '#/components/schemas/SignatureRequestResponseDataValueTextMerge'
          checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge'
      x-internal-class: true
      x-base-class: true
    SubSignatureRequestTemplateSigner:
      required:
      - role
      - name
      - email_address
      properties:
        role:
          description: Must match an existing role in chosen Template(s). It's case-sensitive.
          type: string
        name:
          description: The name of the signer.
          type: string
        email_address:
          description: The email address of the signer.
          type: string
          format: email
        pin:
          description: The 4- to 12-character access code that will secure this signer's signature page.
          type: string
          maxLength: 12
          minLength: 4
        sms_phone_number:
          description: 'An E.164 formatted phone number.


            By using the feature, you agree you are responsible for obtaining a signer''s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).


            **NOTE:** Not available in test mode and requires a Standard plan or higher.'
          type: string
        sms_phone_number_type:
          description: 'Specifies the feature used with the `sms_phone_number`. Default `authentication`.


            If `authentication`, signer is sent a verification code via SMS that is required to access the document.


            If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).'
          type: string
          enum:
          - authentication
          - delivery
      type: object
    SubCustomField:
      description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


        Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


        For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
      required:
      - name
      properties:
        editor:
          description: 'Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.


            **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won''t be editable.'
          type: string
        name:
          description: The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
          type: string
        required:
          description: Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
          type: boolean
          default: false
        value:
          description: The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.
          type: string
      type: object
    ErrorResponseError:
      description: Contains information about an error that occurred.
      required:
      - error_msg
      - error_name
      properties:
        error_msg:
          description: Message describing an error.
          type: string
        error_path:
          description: Path at which an error occurred.
          type: string
        error_name:
          description: Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.
          type: string
      type: object
    SignatureRequestBulkSendWithTemplateRequest:
      required:
      - template_ids
      properties:
        template_ids:
          description: Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
          type: array
          items:
            type: string
        signer_file:
          description: "`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **NOTE:** Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"
          type: string
          format: binary
        signer_list:
          description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.'
          type: array
          items:
            $ref: '#/components/schemas/SubBulkSignerList'
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        ccs:
          description: Add CC email recipients. Required when a CC role exists for the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCC'
        client_id:
          description: The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
          type: string
        custom_fields:
          description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


            Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


            For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signing_redirect_url:
          description: The URL you want signers redirected to after they successfully sign.
          type: string
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
      type: object
    SignatureRequestResponseSignatures:
      description: An array of signature objects, 1 for each signer.
      properties:
        signature_id:
          description: Signature identifier.
          type: string
        signer_group_guid:
          description: Signer Group GUID
          type: string
          nullable: true
        signer_email_address:
          description: The email address of the signer.
          type: string
        signer_name:
          description: The name of the signer.
          type: string
          nullable: true
        signer_role:
          description: The role of the signer.
          type: string
          nullable: true
        order:
          description: If signer order is assigned this is the 0-based index for this signer.
          type: integer
          nullable: true
        status_code:
          description: 'The current status of the signature. eg: awaiting_signature, signed, declined.'
          type: string
        decline_reason:
          description: The reason provided by the signer for declining the request.
          type: string
          nullable: true
        signed_at:
          description: Time that the document was signed or null.
          type: integer
          nullable: true
        last_viewed_at:
          description: The time that the document was last viewed by this signer or null.
          type: integer
          nullable: true
        last_reminded_at:
          description: The time the last reminder email was sent to the signer or null.
          type: integer
          nullable: true
        has_pin:
          description: Boolean to indicate whether this signature requires a PIN to access.
          type: boolean
        has_sms_auth:
          description: Boolean to indicate whether this signature has SMS authentication enabled.
          type: boolean
          nullable: true
        has_sms_delivery:
          description: Boolean to indicate whether this signature has SMS delivery enabled.
          type: boolean
          nullable: true
        sms_phone_number:
          description: The SMS phone number used for authentication or signature request delivery.
          type: string
          nullable: true
        reassigned_by:
          description: Email address of original signer who reassigned to this signer.
          type: string
          nullable: true
        reassignment_reason:
          description: Reason provided by original signer who reassigned to this signer.
          type: string
          nullable: true
        reassigned_from:
          description: Previous signature identifier.
          type: string
          nullable: true
        error:
          description: Error message pertaining to this signer, or null.
          type: string
          nullable: true
      type: object
      x-internal-class: true
    WarningResponse:
      description: A list of warnings.
      required:
      - warning_msg
      - warning_name
      properties:
        warning_msg:
          description: Warning message
          type: string
        warning_name:
          description: Warning name
          type: string
      type: object
    SubFormFieldRuleTrigger:
      required:
      - id
      - operator
      properties:
        id:
          description: Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
          type: string
        operator:
          description: "Different field types allow different `operator` values:\n- Field type of **text**:\n  - **is**: exact match\n  - **not**: not exact match\n  - **match**: regular expression, without /. Example:\n    - OK `[a-zA-Z0-9]`\n    - Not OK `/[a-zA-Z0-9]/`\n- Field type of **dropdown**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n  - **any**: exact match, array of values.\n  - **none**: not exact match, array of values.\n- Field type of **checkbox**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n- Field type of **radio**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value"
          type: string
          enum:
          - any
          - is
          - match
          - none
          - not
        value:
          description: "**value** or **values** is required, but not both.\n\nThe value to match against **operator**.\n\n- When **operator** is one of the following, **value** must be `String`:\n  - `is`\n  - `not`\n  - `match`\n\nOtherwise,\n- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`\n- **radio**: When **type** of trigger is **radio**, **value** must be `1`"
          type: string
        values:
          description: '**values** or **value** is required, but not both.


            The values to match against **operator** when it is one of the following:


            - `any`

            - `none`'
          type: array
          items:
            type: string
      type: object
    SignatureRequestUpdateRequest:
      required:
      - signature_id
      properties:
        email_address:
          description: 'The new email address for the recipient.


            This will generate a new `signature_id` value.


            **NOTE:** Optional if `name` is provided.'
          type: string
          format: email
        name:
          description: 'The new name for the recipient.


            **NOTE:** Optional if `email_address` is provided.'
          type: string
        signature_id:
          description: The signature ID for the recipient.
          type: string
        expires_at:
          description: The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
          type: integer
          nullable: true
      type: object
    SignatureRequestResponseAttachment:
      description: Signer attachments.
      required:
      - id
      - signer
      - name
      - required
      properties:
        id:
          description: The unique ID for this attachment.
          type: string
        signer:
          description: The Signer this attachment is assigned to.
          type: string
          x-int-or-string: true
        name:
          description: The name of this attachment.
          type: string
        required:
          description: A boolean value denoting if this attachment is required.
          type: boolean
        instructions:
          description: Instructions for Signer.
          type: string
          nullable: true
        uploaded_at:
          description: Timestamp when attachment was uploaded by Signer.
          type: integer
          nullable: true
      type: object
      x-internal-class: true
    SignatureRequestCreateEmbeddedRequest:
      required:
      - client_id
      properties:
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        signers:
          description: 'Add Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestSigner'
        grouped_signers:
          description: 'Add Grouped Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestGroupedSigners'
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        allow_reassign:
          description: 'Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.


            **NOTE:** Only available for Premium plan.'
          type: boolean
          default: false
        attachments:
          description: A list describing the attachments
          type: array
          items:
            $ref: '#/components/schemas/SubAttachment'
        cc_email_addresses:
          description: The email addresses that should be CCed.
          type: array
          items:
            type: string
            format: email
        client_id:
          description: Client id of the app you're using to create this embedded signature request. Used for security purposes.
          type: string
        custom_fields:
          description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


            Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


            For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        field_options:
          $ref: '#/components/schemas/SubFieldOptions'
        form_field_groups:
          description: Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldGroup'
        form_field_rules:
          description: Conditional Logic rules for fields defined in `form_fields_per_document`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldRule'
        form_fields_per_document:
          description: 'The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)


            **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.


            * Text Field use `SubFormFieldsPerDocumentText`

            * Dropdown Field use `SubFormFieldsPerDocumentDropdown`

            * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`

            * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`

            * Radio Field use `SubFormFieldsPerDocumentRadio`

            * Signature Field use `SubFormFieldsPerDocumentSignature`

            * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`

            * Initials Field use `SubFormFieldsPerDocumentInitials`

            * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`

            * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`'
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
        hide_text_tags:
          description: 'Enables automatic Text Tag removal when set to true.


            **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.'
          type: boolean
          default: false
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
        use_text_tags:
          description: Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
          type: boolean
          default: false
        populate_auto_fill_fields:
          description: 'Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer''s information during signing.


            **NOTE:** Keep your signer''s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.'
          type: boolean
          default: false
        expires_at:
          description: When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
          type: integer
          nullable: true
      type: object
    SubFormFieldsPerDocumentBase:
      description: 'The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)


        **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.


        * Text Field use `SubFormFieldsPerDocumentText`

        * Dropdown Field use `SubFormFieldsPerDocumentDropdown`

        * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`

        * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`

        * Radio Field use `SubFormFieldsPerDocumentRadio`

        * Signature Field use `SubFormFieldsPerDocumentSignature`

        * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`

        * Initials Field use `SubFormFieldsPerDocumentInitials`

        * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`

        * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`'
      required:
      - document_index
      - api_id
      - type
      - required
      - signer
      - width
      - height
      - x
      - y
      properties:
        document_index:
          description: Represents the integer index of the `file` or `file_url` document the field should be attached to.
          type: integer
        api_id:
          description: An identifier for the field that is unique across all documents in the request.
          type: string
        height:
          description: Size of the field in pixels.
          type: integer
        name:
          description: Display name for the field.
          type: string
        page:
          description: 'Page in the document where the field should be placed (requires documents be PDF files).


            - When the page number parameter is supplied, the API will use the new coordinate system.

            - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.'
          type: integer
          nullable: true
        required:
          description: Whether this field is required.
          type: boolean
        signer:
          description: 'Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.


            **NOTE:** To set the value of the field as the preparer you must set this to `me_now`


            **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.'
          type: string
          x-int-or-string: true
        type:
          type: string
        width:
          description: Size of the field in pixels.
          type: integer
        x:
          description: Location coordinates of the field in pixels.
          type: integer
        y:
          description: Location coordinates of the field in pixels.
          type: integer
      type: object
      discriminator:
        propertyName: type
        mapping:
          text: '#/components/schemas/SubFormFieldsPerDocumentText'
          dropdown: '#/components/schemas/SubFormFieldsPerDocumentDropdown'
          hyperlink: '#/components/schemas/SubFormFieldsPerDocumentHyperlink'
          checkbox: '#/components/schemas/SubFormFieldsPerDocumentCheckbox'
          radio: '#/components/schemas/SubFormFieldsPerDocumentRadio'
          signature: '#/components/schemas/SubFormFieldsPerDocumentSignature'
          date_signed: '#/components/schemas/SubFormFieldsPerDocumentDateSigned'
          initials: '#/components/schemas/SubFormFieldsPerDocumentInitials'
          text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge'
          checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge'
      x-internal-class: true
      x-base-class: true
    SignatureRequestResponseCustomFieldBase:
      description: 'An array of Custom Field objects containing the name and type of each custom field.


        * Text Field uses `SignatureRequestResponseCustomFieldText`

        * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`'
      required:
      - name
      - type
      properties:
        type:
          description: The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
          type: string
        name:
          description: The name of the Custom Field.
          type: string
        required:
          description: A boolean value denoting if this field is required.
          type: boolean
        api_id:
          description: The unique ID for this field.
          type: string
        editor:
          description: The name of the Role that is able to edit this field.
          type: string
          nullable: true
      type: object
      discriminator:
        propertyName: type
        mapping:
          text: '#/components/schemas/SignatureRequestResponseCustomFieldText'
          checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox'
      x-internal-class: true
      x-base-class: true
    SubFormFieldRuleAction:
      required:
      - hidden
      - type
      properties:
        field_id:
          description: '**field_id** or **group_id** is required, but not both.


            Must reference the `api_id` of an existing field defined within `form_fields_per_document`.


            Cannot use with `group_id`. Trigger and action fields must belong to the same signer.'
          type: string
        group_id:
          description: '**group_id** or **field_id** is required, but not both.


            Must reference the ID of an existing group defined within `form_field_groups`.


            Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.'
          type: string
        hidden:
          description: '`true` to hide the target field when rule is satisfied, otherwise `false`.'
          type: boolean
        type:
          type: string
          enum:
          - change-field-visibility
          - change-group-visibility
      type: object
    SignatureRequestResponse:
      description: Contains information about a signature request.
      properties:
        test_mode:
          description: Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
          type: boolean
          default: false
        signature_request_id:
          description: The id of the SignatureRequest.
          type: string
        requester_email_address:
          description: The email address of the initiator of the SignatureRequest.
          type: string
          nullable: true
        title:
          description: The title the specified Account uses for the SignatureRequest.
          type: string
        original_title:
          description: Default Label for account.
          type: string
        subject:
          description: The subject in the email that was initially sent to the signers.
          type: string
          nullable: true
        message:
          description: The custom message in the email that was initially sent to the signers.
          type: string
          nullable: true
        metadata:
          description: The metadata attached to the signature request.
          type: object
          additionalProperties: {}
        created_at:
          description: Time the signature request was created.
          type: integer
        expires_at:
          description: The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
          type: integer
          nullable: true
        is_complete:
          description: Whether or not the SignatureRequest has been fully executed by all signers.
          type: boolean
        is_declined:
          description: Whether or not the SignatureRequest has been declined by a signer.
          type: boolean
        has_error:
          description: Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
          type: boolean
        files_url:
          description: The URL where a copy of the request's documents can be downloaded.
          type: string
        signing_url:
          description: The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.
          type: string
          nullable: true
        details_url:
          description: The URL where the requester and the signers can view the current status of the SignatureRequest.
          type: string
        cc_email_addresses:
          description: A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
          type: array
          items:
            type: string
        signing_redirect_url:
          description: The URL you want the signer redirected to after they successfully sign.
          type: string
          nullable: true
        final_copy_uri:
          description: The path where the completed document can be downloaded
          type: string
          nullable: true
        template_ids:
          description: Templates IDs used in this SignatureRequest (if any).
          type: array
          items:
            type: string
          nullable: true
        custom_fields:
          description: 'An array of Custom Field objects containing the name and type of each custom field.


            * Text Field uses `SignatureRequestResponseCustomFieldText`

            * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`'
          type: array
          items:
            $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
          nullable: true
        attachments:
          description: Signer attachments.
          type: array
          items:
            $ref: '#/components/schemas/SignatureRequestResponseAttachment'
          nullable: true
        response_data:
          description: An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
          type: array
          items:
            $ref: '#/components/schemas/SignatureRequestResponseDataBase'
          nullable: true
        signatures:
          description: An array of signature objects, 1 for each signer.
          type: array
          items:
            $ref: '#/components/schemas/SignatureRequestResponseSignatures'
        bulk_send_job_id:
          description: The ID of the Bulk Send job which sent the signature request, if applicable.
          type: string
          nullable: true
      type: object
      x-internal-class: true
    SignatureRequestEditEmbeddedRequest:
      required:
      - client_id
      properties:
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        signers:
          description: 'Add Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestSigner'
        grouped_signers:
          description: 'Add Grouped Signers to your Signature Request.


            This endpoint requires either **signers** or **grouped_signers**, but not both.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestGroupedSigners'
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        allow_reassign:
          description: 'Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.


            **NOTE:** Only available for Premium plan.'
          type: boolean
          default: false
        attachments:
          description: A list describing the attachments
          type: array
          items:
            $ref: '#/components/schemas/SubAttachment'
        cc_email_addresses:
          description: The email addresses that should be CCed.
          type: array
          items:
            type: string
            format: email
        client_id:
          description: Client id of the app you're using to create this embedded signature request. Used for security purposes.
          type: string
        custom_fields:
          description: 'When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.


            Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.


            For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.'
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        field_options:
          $ref: '#/components/schemas/SubFieldOptions'
        form_field_groups:
          description: Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldGroup'
        form_field_rules:
          description: Conditional Logic rules for fields defined in `form_fields_per_document`.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldRule'
        form_fields_per_document:
          description: 'The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)


            **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.


            * Text Field use `SubFormFieldsPerDocumentText`

            * Dropdown Field use `SubFormFieldsPerDocumentDropdown`

            * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`

            * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`

            * Radio Field use `SubFormFieldsPerDocumentRadio`

            * Signature Field use `SubFormFieldsPerDocumentSignature`

            * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`

            * Initials Field use `SubFormFieldsPerDocumentInitials`

            * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`

            * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`'
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
        hide_text_tags:
          description: 'Enables automatic Text Tag removal when set to true.


            **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.'
          type: boolean
          default: false
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
        use_text_tags:
          description: Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
          type: boolean
          default: false
        populate_auto_fill_fields:
          description: 'Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer''s information during signing.


            **NOTE:** Keep your signer''s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.'
          type: boolean
          default: false
        expires_at:
          description: When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
          type: integer
          nullable: true
      type: object
    SubBulkSignerList:
      properties:
        custom_fields:
          description: An array of custom field values.
          type: array
          items:
            $ref: '#/components/schemas/SubBulkSignerListCustomField'
        signers:
          description: 'Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.


            Currently only templates with a single role are supported. All signers must have the same `role` value.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
      type: object
    SubSignatureRequestGroupedSigners:
      required:
      - group
      - signers
      properties:
        group:
          description: The name of the group.
          type: string
        order:
          description: The order the group is required to sign in. Use this instead of Signer-level `order`.
          type: integer
          nullable: true
        signers:
          description: 'Signers belonging to this Group.


            **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.'
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestSigner'
      type: object
    SubSigningOptions:
      description: 'This allows the requester to specify the types allowed for creating a signature and specify another signing options.


        **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.


        **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.'
      required:
      - default_type
      properties:
        default_type:
          description: The default type shown (limited to the listed types)
          type: string
          enum:
          - draw
          - phone
          - type
          - upload
        draw:
          description: Allows drawing the signature
          type: boolean
          default: false
        phone:
          description: Allows using a smartphone to email the signature
          type: boolean
          default: false
        type:
          description: Allows typing the signature
          type: boolean
          default: false
        upload:
          description: Allows uploading the signature
          type: boolean
          default: false
        force_advanced_signature_details:
          description: Turning on advanced signature details for the signature request
          type: boolean
          default: false
      type: object
    SubFormFieldRule:
      required:
      - id
      - trigger_operator
      - triggers
      - actions
      properties:
        id:
          description: Must be unique across all defined rules.
          type: string
        trigger_operator:
          description: Currently only `AND` is supported. Support for `OR` is being worked on.
          type: string
          default: AND
        triggers:
          description: An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldRuleTrigger'
          maxItems: 1
          minItems: 1
        actions:
          description: An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.
          type: array
          items:
            $ref: '#/components/schemas/SubFormFieldRuleAction'
          minItems: 1
      type: object
    SignatureRequestListResponse:
      required:
      - signature_requests
      - list_info
      properties:
        signature_requests:
          description: Contains information about signature requests.
          type: array
          items:
            $ref: '#/components/schemas/SignatureRequestResponse'
        list_info:
          $ref: '#/components/schemas/ListInfoResponse'
        warnings:
          description: A list of warnings.
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
      type: object
      x-internal-class: true
    FileResponseDataUri:
      required:
      - data_uri
      properties:
        data_uri:
          description: File as base64 encoded string.
          type: string
      type: object
      x-internal-class: true
    SubBulkSignerListCustomField:
      required:
      - name
      - value
      properties:
        name:
          description: The name of the custom field. Must be the field's `name` or `api_id`.
          type: string
        value:
          description: The value of the custom field.
          type: string
      type: object
    SubFormFieldGroup:
      required:
      - group_id
      - group_label
      - requirement
      properties:
        group_id:
          description: ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.
          type: string
        group_label:
          description: Name of the group
          type: string
        requirement:
          description: 'Examples: `require_0-1` `require_1` `require_1-ormore`


            - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).

            - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).

            - Radio groups require **at least** two fields per group.'
          type: string
      type: object
    BulkSendJobSendResponse:
      required:
      - bulk_send_job
      properties:
        bulk_send_job:
          $ref: '#/components/schemas/BulkSendJobResponse'
        warnings:
          description: A list of warnings.
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
      type: object
      x-internal-class: true
    SubSignatureRequestSigner:
      required:
      - name
      - email_address
      properties:
        name:
          description: The name of the signer.
          type: string
        email_address:
          description: The email address of the signer.
          type: string
          format: email
        order:
          description: The order the signer is required to sign in.
          type: integer
          nullable: true
        pin:
          description: The 4- to 12-character access code that will secure this signer's signature page.
          type: string
          maxLength: 12
          minLength: 4
        sms_phone_number:
          description: 'An E.164 formatted phone number.


            By using the feature, you agree you are responsible for obtaining a signer''s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).


            **NOTE:** Not available in test mode and requires a Standard plan or higher.'
          type: string
        sms_phone_number_type:
          description: 'Specifies the feature used with the `sms_phone_number`. Default `authentication`.


            If `authentication`, signer is sent a verification code via SMS that is required to access the document.


            If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).'
          type: string
          enum:
          - authentication
          - delivery
      type: object
    SubAttachment:
      required:
      - name
      - signer_index
      properties:
        instructions:
          description: The instructions for uploading the attachment.
          type: string
        name:
          description: The name of attachment.
          type: string
        required:
          description: Determines if the attachment must be uploaded.
          type: boolean
          default: false
        signer_index:
          description: 'The signer''s index in the `signers` parameter (0-based indexing).


            **NOTE:** Only one signer can be assigned per attachment.'
          type: integer
      type: object
    SignatureRequestSendWithTemplateRequest:
      description: ''
      required:
      - signers
      - template_ids
      properties:
        template_ids:
          description: Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
          type: array
          items:
            type: string
        allow_decline:
          description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
          type: boolean
          default: false
        ccs:
          description: Add CC email recipients. Required when a CC role exists for the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCC'
        client_id:
          description: Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
          type: string
        custom_fields:
          description: An array defining values and options for custom fields. Required when a custom field exists in the Template.
          type: array
          items:
            $ref: '#/components/schemas/SubCustomField'
        files:
          description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
            format: binary
        file_urls:
          description: 'Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.


            This endpoint requires either **files** or **file_urls[]**, but not both.'
          type: array
          items:
            type: string
        is_eid:
          description: 'Send with a value of `true` if you wish to enable

            [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),

            which requires the signer to verify their identity with an eID provider to sign a document.<br>

            **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.'
          type: boolean
          default: false
        message:
          description: The custom message in the email that will be sent to the signers.
          type: string
          maxLength: 5000
        metadata:
          description: 'Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer''s order number for look up when receiving events for the signature request.


            Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.'
          type: object
          maxItems: 10
          additionalProperties: {}
        signers:
          description: Add Signers to your Templated-based Signature Request.
          type: array
          items:
            $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
        signing_options:
          $ref: '#/components/schemas/SubSigningOptions'
        signing_redirect_url:
          description: The URL you want signers redirected to after they successfully sign.
          type: string
        subject:
          description: The subject in the email that will be sent to the signers.
          type: string
          maxLength: 255
        test_mode:
          description: Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
          type: boolean
          default: false
        title:
          description: The title you want to assign to the SignatureRequest.
          type: string
          maxLength: 255
      type: object
    FileResponse:
      required:
      - file_url
      - expires_at
      properties:
        file_url:
          description: URL to the file.
          type: string
        expires_at:
          description: When the link expires.
          type: integer
      type: object
      x-internal-class: true
    SignatureRequestRemindRequest:
      required:
      - email_address
      properties:
        email_address:
          description: The email address of the signer to send a reminder to.
          type: string
          format: email
        name:
          description: The name of the signer to send a reminder to. Include if two or more signers share an email address.
          type: string
      type: object
  headers:
    X-Ratelimit-Reset:
      description: The Unix time at which the rate limit will reset to its maximum.
      schema:
        type: integer
        format: int64
        example: 1430170900
    X-RateLimit-Limit:
      description: The maximum number of requests per hour that you can make.
      schema:
        type: integer
        format: int32
        example: 100
    X-RateLimit-Remaining:
      description: The number of requests remaining in the current rate limit window.
      schema:
        type: integer
        format: int32
        example: 99
  securitySchemes:
    api_key:
      type: http
      description: 'Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.

        ✅ Supported by Try it console (calls sent in `test_mode` only).'
      scheme: basic
    oauth2:
      type: http
      description: 'You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information.

        ❌ **Not supported** by Try it console.'
      bearerFormat: JWT
      scheme: bearer
externalDocs:
  description: Legacy API Reference
  url: https://app.hellosign.com/api/reference
x-webhooks:
  accountCallback:
    post:
      summary: Account Callbacks
      operationId: accountUpdateEventCallback
      description:
        $ref: ./markdown/en/descriptions/account-callback-description.md
      tags:
      - Callbacks and Events
      x-meta:
        seo:
          title: Account Callbacks | API Documentation | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.
      x-fern-audiences:
      - events
      requestBody:
        description: "**Account Callback Payloads --**\n      Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventCallbackPayload'
            examples:
              signature_request_viewed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestViewed'
              signature_request_signed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestSigned'
              signature_request_signer_removed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestSignerRemoved'
              signature_request_downloadable_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestDownloadable'
              signature_request_sent_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestSent'
              signature_request_all_signed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestAllSigned'
              signature_request_invalid_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestInvalid'
              signature_request_email_bounce_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestEmailBounce'
              signature_request_remind_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestRemind'
              signature_request_incomplete_qes_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestIncompleteQes'
              signature_request_destroyed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestDestroyed'
              signature_request_canceled_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestCanceled'
              signature_request_declined_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestDeclined'
              signature_request_expired_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestExpired'
              signature_request_reassigned_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestReassigned'
              signature_request_prepared_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestPrepared'
              account_confirmed_example:
                $ref: '#/components/examples/EventCallbackAccountConfirmed'
              unknown_error_example:
                $ref: '#/components/examples/EventCallbackUnknownError'
              file_error_example:
                $ref: '#/components/examples/EventCallbackFileError'
              template_created_example:
                $ref: '#/components/examples/EventCallbackTemplateCreated'
              template_error_example:
                $ref: '#/components/examples/EventCallbackTemplateError'
              sign_url_invalid_example:
                $ref: '#/components/examples/EventCallbackSignUrlInvalid'
              callback_test_example:
                $ref: '#/components/examples/EventCallbackCallbackTest'
      responses:
        200:
          $ref: '#/components/responses/EventCallbackResponse'
  appCallback:
    post:
      summary: App Callbacks
      operationId: apiAppCreateEventCallback
      description:
        $ref: ./markdown/en/descriptions/api-app-callback-description.md
      tags:
      - Callbacks and Events
      x-meta:
        seo:
          title: App Callbacks | API Documentation | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.
      x-fern-audiences:
      - events
      requestBody:
        description: '**API App Callback Payloads --**

          Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventCallbackPayload'
            examples:
              signature_request_viewed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestViewed'
              signature_request_signed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestSigned'
              signature_request_signer_removed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestSignerRemoved'
              signature_request_downloadable_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestDownloadable'
              signature_request_sent_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestSent'
              signature_request_all_signed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestAllSigned'
              signature_request_invalid_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestInvalid'
              signature_request_email_bounce_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestEmailBounce'
              signature_request_remind_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestRemind'
              signature_request_incomplete_qes_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestIncompleteQes'
              signature_request_destroyed_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestDestroyed'
              signature_request_canceled_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestCanceled'
              signature_request_declined_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestDeclined'
              signature_request_expired_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestExpired'
              signature_request_reassigned_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestReassigned'
              signature_request_prepared_example:
                $ref: '#/components/examples/EventCallbackSignatureRequestPrepared'
              account_confirmed_example:
                $ref: '#/components/examples/EventCallbackAccountConfirmed'
              unknown_error_example:
                $ref: '#/components/examples/EventCallbackUnknownError'
              file_error_example:
                $ref: '#/components/examples/EventCallbackFileError'
              template_created_example:
                $ref: '#/components/examples/EventCallbackTemplateCreated'
              template_error_example:
                $ref: '#/components/examples/EventCallbackTemplateError'
              sign_url_invalid_example:
                $ref: '#/components/examples/EventCallbackSignUrlInvalid'
              callback_test_example:
                $ref: '#/components/examples/EventCallbackCallbackTest'
      responses:
        200:
          $ref: '#/components/responses/EventCallbackResponse'
x-error-codes:
  bad_request:
    http_status: 400
    summary: The request contained invalid or malformed parameters.
    cause: A parameter failed validation, or the request body was malformed.
    remediation: Inspect error_msg and error_path, correct the offending parameter, and resend.
    retryable: 'no'
  unauthorized:
    http_status: 401
    summary: The credentials supplied are missing or invalid.
    cause: Missing, malformed, or invalid API key or OAuth access token.
    remediation: Verify the API key or OAuth token and the Authorization header, then retry.
    retryable: 'no'
  payment_required:
    http_status: 402
    summary: The account must be credited or upgraded to perform this action.
    cause: The action requires a paid plan, additional quota, or API credits.
    remediation: Upgrade the plan or add the required credits/quota, then retry.
    retryable: 'no'
  forbidden:
    http_status: 403
    summary: The action is not allowed for these credentials or in the current context.
    cause: The authenticated account lacks access to the resource or operation.
    remediation: Confirm the account has access to the resource and the required permissions.
    retryable: 'no'
  not_found:
    http_status: 404
    summary: Nothing matches the requested resource.
    cause: The resource id does not exist or is not visible to this account.
    remediation: Verify the id and that the resource belongs to the authenticated account.
    retryable: 'no'
  conflict:
    http_status: 409
    summary: The request was well-formed but conflicts with the current state.
    cause: The target resource is in a state incompatible with the request (e.g. a signature request is still being set up).
    remediation: Wait briefly and retry, or listen for a callback event confirming the resource is ready.
    retryable: conditional
  exceeded_rate:
    http_status: 429
    summary: Your account's API request rate limit has been exceeded.
    cause: Too many requests were sent within the rate-limit window for this request type.
    remediation: Pace requests using the X-RateLimit-* response headers and retry after the window resets.
    retryable: 'yes'
    backoff: Honor X-Ratelimit-Reset (Unix epoch); otherwise exponential backoff with jitter. No Retry-After header is sent.
  unknown:
    http_status: 500
    summary: An unexpected error occurred.
    cause: An unhandled server-side error, or a status code without a more specific error_name.
    remediation: Retry transient failures; if it persists, contact support with the request details.
    retryable: conditional
    backoff: For transient 5xx, retry with exponential backoff; otherwise do not retry.
  team_invite_failed:
    http_status: 403
    summary: The team invitation could not be completed.
    cause: The invitee already belongs to a team, or the invite is otherwise not permitted.
    remediation: Confirm the invitee is not already on a team before inviting.
    retryable: 'no'
  max_faxes:
    http_status: 429
    summary: Too many fax transmissions are currently pending or transmitting.
    cause: The account has reached the limit of concurrent in-flight fax transmissions.
    remediation: Wait for outstanding transmissions to complete, then retry.
    retryable: 'yes'
    backoff: Retry with exponential backoff once pending transmissions clear.
  invalid_recipient:
    http_status: 400
    summary: The recipient (fax number or email address) is invalid.
    cause: A recipient value did not pass validation.
    remediation: Correct the recipient value and resend.
    retryable: 'no'
  signature_request_cancel_failed:
    http_status: 400
    summary: The signature request could not be cancelled.
    cause: The caller is not the requester, or the request is already fully executed/closed.
    remediation: Only the requester can cancel, and only before the request is fully executed.
    retryable: 'no'
  signature_request_remove_failed:
    http_status: 400
    summary: Access to the signature request could not be removed.
    cause: The signature request has not yet been fully executed, so access cannot be revoked.
    remediation: Wait until all parties have signed, or call /signature_request/cancel to cancel incomplete requests instead.
    retryable: 'no'
  maintenance:
    http_status: 503
    summary: The request could not be completed because the site is under maintenance.
    cause: The API is in a scheduled maintenance window.
    remediation: Retry once the maintenance window ends.
    retryable: 'yes'
    backoff: Retry later with exponential backoff.
  method_not_supported:
    http_status: 405
    summary: The HTTP method is not supported for this endpoint.
    cause: The request used a verb the endpoint does not accept.
    remediation: Use the HTTP method documented for the endpoint.
    retryable: 'no'
  invalid_reminder:
    http_status: 400
    summary: The signature request reminder was invalid.
    cause: A reminder was attempted against an ineligible request (e.g. embedded, closed, or expired).
    remediation: Only send reminders for eligible (non-embedded, open) signature requests.
    retryable: 'no'
  unavailable:
    http_status: 503
    summary: The service is temporarily unavailable.
    cause: A downstream dependency or the service itself is temporarily unavailable.
    remediation: Retry later with exponential backoff.
    retryable: 'yes'
    backoff: Retry later with exponential backoff and jitter.
  unprocessable_entity:
    http_status: 422
    summary: The request was understood but the target entity cannot be processed.
    cause: The resource is still being processed, or it is in an error state.
    remediation: If the resource is still processing, wait and retry; if it is in an error state, recreate/resend it instead of retrying.
    retryable: conditional
    backoff: If still processing, retry with exponential backoff; if in an error state, do not retry.
  signature_request_expired:
    http_status:
    - 400
    - 403
    summary: The signature request has expired.
    cause: The operation targets a request whose expiration has passed. Most endpoints return 400; final-copy/download endpoints return 403.
    remediation: The request can no longer be acted upon; create a new signature request.
    retryable: 'no'
  deleted:
    http_status: 410
    summary: The request was cancelled or deleted.
    cause: The resource has been cancelled or removed and is no longer available.
    remediation: Do not retry; the resource is permanently gone.
    retryable: 'no'
x-oauth-error-codes:
  invalid_grant:
    http_status:
    - 400
    - 401
    summary: The OAuth grant (authorization code or refresh token) is invalid or expired.
    cause: The code/token was already used, expired, or does not match the client.
    remediation: Re-initiate the OAuth flow to obtain a fresh authorization code.
    retryable: 'no'
  invalid_client:
    http_status: 400
    summary: The OAuth client credentials are invalid.
    cause: The client_id or client_secret is unrecognized or incorrect.
    remediation: Verify the client_id and client_secret from the API app settings.
    retryable: 'no'
  invalid_request:
    http_status: 400
    summary: The OAuth request is malformed or missing required parameters.
    cause: A required parameter is missing, or the request format is invalid.
    remediation: Check the request against the OAuth token endpoint documentation.
    retryable: 'no'
  unauthorized_client:
    http_status:
    - 401
    - 403
    summary: The OAuth client is not authorized to perform this action.
    cause: The app has not been approved, or the action is outside the granted scopes.
    remediation: Ensure the app is approved and the required scopes are granted.
    retryable: 'no'
  unsupported_grant_type:
    http_status: 400
    summary: The grant type is not supported.
    cause: The grant_type parameter value is not recognized.
    remediation: Use authorization_code or refresh_token as the grant_type.
    retryable: 'no'
  payment_required:
    http_status: 402
    summary: The account requires a paid plan to use this OAuth app.
    cause: The authorizing account does not have a plan that supports this integration.
    remediation: Upgrade the account to a plan that includes OAuth app access.
    retryable: 'no'
  addon_required:
    http_status: 402
    summary: An add-on is required to use this OAuth app.
    cause: The account plan does not include the add-on needed for this integration.
    remediation: Add the required add-on to the account subscription.
    retryable: 'no'
  invalid_scope:
    http_status: 400
    summary: The requested OAuth scope is invalid.
    cause: The scope parameter contains values not permitted for the app.
    remediation: Request only scopes that the app is configured to use.
    retryable: 'no'
  quota_reached:
    http_status: 402
    summary: The account has reached its usage quota for this OAuth app.
    cause: The authorizing account has exhausted its quota for the integration.
    remediation: Contact the app owner or upgrade the account quota.
    retryable: 'no'
  server_error:
    http_status: 500
    summary: An internal server error occurred during OAuth processing.
    cause: An unexpected error on the server side while handling the OAuth request.
    remediation: Retry the request; if it persists, contact support.
    retryable: 'yes'
    backoff: Retry with exponential backoff.
  temporary_unavailable:
    http_status: 503
    summary: The OAuth service is temporarily unavailable.
    cause: The service is under maintenance or experiencing temporary issues.
    remediation: Retry after a short delay.
    retryable: 'yes'
    backoff: Retry with exponential backoff.
x-error-events:
  signature_request_invalid:
    event_type: signature_request_invalid
    delivery: webhook
    summary: Asynchronous error while processing a signature request.
    cause: A signature request could not be processed (e.g. invalid tags, fields, or merge data).
    remediation: Inspect event.event_metadata.event_message in the callback, correct the request, and resend.
    retryable: conditional
  unknown_error:
    event_type: unknown_error
    delivery: webhook
    summary: An unspecified asynchronous processing error occurred.
    cause: An unexpected error occurred while processing the request asynchronously.
    remediation: Check the request status in the API dashboard; retry or contact support if it persists.
    retryable: conditional
  file_error:
    event_type: file_error
    delivery: webhook
    summary: Asynchronous error while processing an uploaded file.
    cause: A file attached to a request could not be processed.
    remediation: Resend the request with a supported, non-corrupt file.
    retryable: conditional
  template_error:
    event_type: template_error
    delivery: webhook
    summary: Asynchronous error while creating a template.
    cause: Template file processing failed (e.g. unsupported or corrupt file).
    remediation: Recreate the template with a valid file; check status in the API dashboard.
    retryable: conditional
  sign_url_invalid:
    event_type: sign_url_invalid
    delivery: webhook
    summary: An embedded signing URL has expired or become invalid.
    cause: The embedded sign_url is no longer valid (e.g. expired).
    remediation: Generate a fresh embedded sign_url via the embedded sign URL endpoint.
    retryable: 'yes'