Box · Schema

Sign Request Signer Input

Input created by a Signer on a Sign Request

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-signrequestsignerinput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignRequestSignerInput",
  "title": "Sign Request Signer Input",
  "type": "object",
  "description": "Input created by a Signer on a Sign Request",
  "required": [
    "page_index"
  ],
  "allOf": [
    {
      "$ref": "#/components/schemas/SignRequestPrefillTag"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "signature",
            "date",
            "text",
            "checkbox",
            "radio",
            "dropdown"
          ],
          "description": "Type of input",
          "example": "text"
        },
        "content_type": {
          "type": "string",
          "enum": [
            "signature",
            "initial",
            "stamp",
            "date",
            "checkbox",
            "text",
            "full_name",
            "first_name",
            "last_name",
            "company",
            "title",
            "email",
            "attachment",
            "radio",
            "dropdown"
          ],
          "description": "Content type of input",
          "example": "signature"
        },
        "page_index": {
          "type": "integer",
          "description": "Index of page that the input is on",
          "example": 4
        },
        "read_only": {
          "type": "boolean",
          "description": "Whether this input was defined as read-only(immutable by signers) or not",
          "example": true
        }
      }
    }
  ]
}