{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dropbox Sign Account Signature Request API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Signature Request",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Embedded Bulk Send with Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/bulk_create_embedded_with_template",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\n**NOTE:** Only available for Standard plan and higher."
        },
        {
          "info": {
            "name": "Bulk Send with Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/bulk_send_with_template",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.\n\n**NOTE:** Only available for Standard plan and higher."
        },
        {
          "info": {
            "name": "Cancel Incomplete Signature Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/cancel/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the incomplete SignatureRequest to cancel."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Cancels an incomplete signature request. This action is **not reversible**.\n\nThe 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.\n\nThis 200 OK response does n"
        },
        {
          "info": {
            "name": "Create Embedded Signature Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/create_embedded",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Create Embedded Signature Request with Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/create_embedded_with_template",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Edit Signature Request",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.hellosign.com/v3/signature_request/edit/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to edit."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota."
        },
        {
          "info": {
            "name": "Edit Embedded Signature Request",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.hellosign.com/v3/signature_request/edit_embedded/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to edit."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota."
        },
        {
          "info": {
            "name": "Edit Embedded Signature Request with Template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.hellosign.com/v3/signature_request/edit_embedded_with_template/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to edit."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota."
        },
        {
          "info": {
            "name": "Edit Signature Request With Template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.hellosign.com/v3/signature_request/edit_with_template/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to edit."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota."
        },
        {
          "info": {
            "name": "Download Files",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/signature_request/files/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to retrieve."
              },
              {
                "name": "file_type",
                "value": "",
                "type": "query",
                "description": "Set to `pdf` for a single merged document or `zip` for a collection of individual documents."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file.\n\nIf the files are currently being prepared, a status code of `409` will be returned instead."
        },
        {
          "info": {
            "name": "Download Files as Data Uri",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/signature_request/files_as_data_uri/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to retrieve."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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).\n\nIf the files are currently being prepared, a status code of `409` will be returned instead."
        },
        {
          "info": {
            "name": "Download Files as File Url",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/signature_request/files_as_file_url/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to retrieve."
              },
              {
                "name": "force_download",
                "value": "",
                "type": "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."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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).\n\nIf the files are currently being prepared, a status code of `409` will be returned instead."
        },
        {
          "info": {
            "name": "Get Signature Request",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/signature_request/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to retrieve."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Returns the status of the SignatureRequest specified by the `signature_request_id` parameter."
        },
        {
          "info": {
            "name": "List Signature Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/signature_request/list",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "query",
                "description": "Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Which page number of the SignatureRequest List to return. Defaults to `1`."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "String that includes search terms and/or fields to be used to filter the SignatureRequest objects."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\nTake a look at our [search guide](/api/reference/search/) to learn more about querying signature requests."
        },
        {
          "info": {
            "name": "Release On-Hold Signature Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/release_hold/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to release."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Send Request Reminder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/remind/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to send a reminder for."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\n**NOTE:** This action can **not** be used with embedded signature requests."
        },
        {
          "info": {
            "name": "Remove Signature Request Access",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/remove/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to remove."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Removes your access to a completed signature request. This action is **not reversible**.\n\nThe 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).\n\nUnlike /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."
        },
        {
          "info": {
            "name": "Send Signature Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/send",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Send with Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/send_with_template",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter."
        },
        {
          "info": {
            "name": "Update Signature Request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/signature_request/update/:signature_request_id",
            "params": [
              {
                "name": "signature_request_id",
                "value": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
                "type": "path",
                "description": "The id of the SignatureRequest to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "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.\n\nUpdating the email address of a signer will generate a new `signature_id` value.\n\n**NOTE:** This action cannot be performed on a signature request with an appended signature page."
        }
      ]
    }
  ],
  "bundled": true
}