Sign Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignRequest",
  "title": "Sign Request",
  "type": "object",
  "x-box-resource-id": "sign_request",
  "x-box-tag": "sign_requests",
  "x-box-variants": [
    "standard",
    "base"
  ],
  "x-box-variant": "standard",
  "description": "A Sign Request Object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignRequest--Base"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "example": "sign-request",
          "enum": [
            "sign-request"
          ],
          "description": "object type"
        },
        "source_files": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/File--Base"
          },
          "description": "List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file."
        },
        "signers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SignRequestSigner"
          },
          "description": "Array of signers for the sign request"
        },
        "signature_color": {
          "type": "string",
          "example": "blue",
          "description": "Force a specific color for the signature (blue, black, or red).",
          "nullable": true
        },
        "id": {
          "type": "string",
          "example": "12345",
          "description": "Sign request ID"
        },
        "prepare_url": {
          "type": "string",
          "example": "https://prepareurl.com",
          "description": "This URL is returned if `is_document_preparation_needed` is\nset to `true` in the request. It is used to prepare the sign request\nvia UI. The sign request is not sent until preparation is complete.",
          "nullable": true
        },
        "signing_log": {
          "allOf": [
            {
              "$ref": "#/components/schemas/File--Mini"
            },
            {
              "description": "Reference to a file that holds a log of all signer activity for\nthe request"
            }
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "converting",
            "created",
            "sent",
            "viewed",
            "signed",
            "cancelled",
            "declined",
            "error_converting",
            "error_sending",
            "expired",
            "finalizing",
            "error_finalizing"
          ],
          "example": "converting",
          "description": "Describes the status of the sign request"
        },
        "sign_files": {
          "type": "object",
          "properties": {
            "files": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/File--Mini"
              }
            },
            "is_ready_for_download": {
              "type": "boolean",
              "example": true,
              "description": "Indicates whether the `sign_files` documents are processing\nand the PDFs may be out of date. A change to any document\nrequires processing on all `sign_files`. We\nrecommended waiting until processing is finished\n(and this value is true) before downloading the PDFs."
            }
          },
          "description": "List of files that will be signed, which are copies of the original\nsource files. A new version of these files are created as signers sign\nand can be downloaded at any point in the signing process."
        },
        "auto_expire_at": {
          "type": "string",
          "format": "date-time",
          "example": "2021-04-26T08:12:13.982Z",
          "description": "Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.",
          "nullable": true
        },
        "parent_folder": {
          "nullable": false,
          "allOf": [
            {
              "$ref": "#/components/schemas/Folder--Mini"
            },
            {
              "description": "The destination folder to place final, signed document and signing\nlog.\n\nWhen this value was not passed in when the signature request was \ncreated, then we will use a default folder which is either the parent\nfolder of the first source file in the payload if we have the permission\nto upload to that folder or a folder called \"My Sign Requests\"."
            }
          ]
        }
      }
    }
  ]
}