Box · Schema

Signer fields for GET Sign Request response

The schema for a Signer in a GET Sign Request request body

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-signrequestsigner-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignRequestSigner",
  "title": "Signer fields for GET Sign Request response",
  "type": "object",
  "description": "The schema for a Signer in a GET Sign Request request body",
  "required": [
    "email"
  ],
  "allOf": [
    {
      "$ref": "#/components/schemas/SignRequestCreateSigner"
    },
    {
      "properties": {
        "has_viewed_document": {
          "type": "boolean",
          "readOnly": true,
          "example": true,
          "description": "Set to `true` if the signer views the document"
        },
        "signer_decision": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "signed",
                "declined"
              ],
              "example": "signed",
              "description": "Type of decision made by the signer"
            },
            "finalized_at": {
              "type": "string",
              "format": "date-time",
              "example": "2021-04-26T08:12:13.982Z",
              "description": "Date and Time that the decision was made"
            },
            "additional_info": {
              "type": "string",
              "example": "Requesting changes before signing.",
              "description": "Additional info about the decision, such as the decline reason from the signer",
              "nullable": true
            }
          },
          "description": "Final decision made by the signer",
          "nullable": true
        },
        "inputs": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SignRequestSignerInput"
          },
          "readOnly": true
        },
        "embed_url": {
          "type": "string",
          "readOnly": true,
          "example": "https://example.com",
          "description": "URL to direct a signer to for signing",
          "nullable": true
        },
        "iframeable_embed_url": {
          "type": "string",
          "nullable": true,
          "example": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4",
          "description": "This URL is specifically designed for\nsigning documents within an HTML `iframe` tag.\nIt will be returned in the response\nonly if the `embed_url_external_user_id`\nparameter was passed in the\n`create sign request` call."
        }
      }
    }
  ]
}