Docusign · Schema

Text

A text input tab for free-form text entry.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name Type Description
tabId string
tabLabel string
documentId string
pageNumber string
recipientId string
xPosition string
yPosition string
anchorString string
value string
required string When true, the recipient must fill in this tab.
locked string When true, the tab value cannot be changed.
maxLength string Maximum length of text input.
width string
height string
font string
fontSize string
fontColor string
bold string
italic string
underline string
validationPattern string Regular expression for input validation.
validationMessage string Error message displayed when validation fails.
concealValueOnDocument string When true, the value is concealed on the document.
View JSON Schema on GitHub

JSON Schema

docusign-esignature-text-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Text",
  "type": "object",
  "description": "A text input tab for free-form text entry.",
  "properties": {
    "tabId": {
      "type": "string"
    },
    "tabLabel": {
      "type": "string"
    },
    "documentId": {
      "type": "string"
    },
    "pageNumber": {
      "type": "string"
    },
    "recipientId": {
      "type": "string"
    },
    "xPosition": {
      "type": "string"
    },
    "yPosition": {
      "type": "string"
    },
    "anchorString": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "required": {
      "type": "string",
      "description": "When true, the recipient must fill in this tab."
    },
    "locked": {
      "type": "string",
      "description": "When true, the tab value cannot be changed."
    },
    "maxLength": {
      "type": "string",
      "description": "Maximum length of text input."
    },
    "width": {
      "type": "string"
    },
    "height": {
      "type": "string"
    },
    "font": {
      "type": "string"
    },
    "fontSize": {
      "type": "string"
    },
    "fontColor": {
      "type": "string"
    },
    "bold": {
      "type": "string"
    },
    "italic": {
      "type": "string"
    },
    "underline": {
      "type": "string"
    },
    "validationPattern": {
      "type": "string",
      "description": "Regular expression for input validation."
    },
    "validationMessage": {
      "type": "string",
      "description": "Error message displayed when validation fails."
    },
    "concealValueOnDocument": {
      "type": "string",
      "description": "When true, the value is concealed on the document."
    }
  }
}