Box · Schema

Template Signer Input

Input created by a Signer on a Template

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-templatesignerinput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TemplateSignerInput",
  "title": "Template Signer Input",
  "type": "object",
  "description": "Input created by a Signer on a Template",
  "required": [
    "page_index"
  ],
  "allOf": [
    {
      "$ref": "#/components/schemas/SignRequestPrefillTag"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "signature",
            "date",
            "text",
            "checkbox",
            "attachment",
            "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": "text"
        },
        "is_required": {
          "type": "boolean",
          "description": "Whether or not the input is required.",
          "example": true
        },
        "page_index": {
          "type": "integer",
          "description": "Index of page that the input is on.",
          "example": 4
        },
        "document_id": {
          "type": "string",
          "description": "Document identifier.",
          "example": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
          "nullable": true
        },
        "dropdown_choices": {
          "type": "array",
          "example": [
            "Yes",
            "No",
            "Maybe"
          ],
          "description": "When the input is of the type `dropdown` this values will be filled with all the dropdown options.",
          "nullable": true,
          "items": {
            "type": "string"
          }
        },
        "group_id": {
          "type": "string",
          "description": "When the input is of type `radio` they can be grouped to gather with this identifier.",
          "nullable": true,
          "example": "da317330-225a-4c72-89ad-0d6dcaaf4df6"
        },
        "coordinates": {
          "type": "object",
          "description": "Where the input is located on a page.",
          "properties": {
            "x": {
              "type": "number",
              "example": 0.672258592471358,
              "description": "Relative x coordinate to the page the input is on, ranging from 0 to 1."
            },
            "y": {
              "type": "number",
              "example": 0.18654283173599448,
              "description": "Relative y coordinate to the page the input is on, ranging from 0 to 1."
            }
          }
        },
        "dimensions": {
          "type": "object",
          "description": "The size of the input.",
          "properties": {
            "width": {
              "type": "number",
              "example": 0.2618657937806874,
              "description": "Relative width to the page the input is on, ranging from 0 to 1."
            },
            "height": {
              "type": "number",
              "example": 0.05311728090109673,
              "description": "Relative height to the page the input is on, ranging from 0 to 1."
            }
          }
        },
        "label": {
          "type": "string",
          "description": "The label field is used especially for text, attachment, radio, and checkbox type inputs.",
          "nullable": true,
          "example": "Legal name"
        },
        "read_only": {
          "type": "boolean",
          "description": "Whether this input was defined as read-only(immutable by signers) or not",
          "example": true
        }
      }
    }
  ]
}