Box · Schema

Sign Request Prefill Tag

Prefill tags are used to prefill placeholders with signer input data. Only one value field can be included.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
document_tag_id	string	This references the ID of a specific tag contained in a file of the sign request.
text_value	string	Text prefill value
checkbox_value	boolean	Checkbox prefill value
date_value	string	Date prefill value

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignRequestPrefillTag",
  "title": "Sign Request Prefill Tag",
  "type": "object",
  "description": "Prefill tags are used to prefill placeholders with signer input data. Only\none value field can be included.",
  "properties": {
    "document_tag_id": {
      "type": "string",
      "example": "1234",
      "description": "This references the ID of a specific tag contained in a file of the sign request.",
      "nullable": true
    },
    "text_value": {
      "type": "string",
      "example": "text",
      "description": "Text prefill value",
      "nullable": true
    },
    "checkbox_value": {
      "type": "boolean",
      "example": true,
      "description": "Checkbox prefill value",
      "nullable": true
    },
    "date_value": {
      "type": "string",
      "format": "date",
      "example": "2021-04-26",
      "description": "Date prefill value",
      "nullable": true
    }
  }
}