SignWell · Schema

TemplateFieldValues

Fields of your template(s) that you can prepopulate with values. Signature and Initials fields cannot be signed through the API.

E-SignatureElectronic SignatureDocumentsPDFSigningTemplatesWorkflowsHIPAASOC2
View JSON Schema on GitHub

JSON Schema

TemplateFieldValues.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/TemplateFieldValues.json",
  "title": "TemplateFieldValues",
  "type": "array",
  "description": "Fields of your template(s) that you can prepopulate with values. Signature and Initials fields cannot be signed through the API.",
  "items": {
    "type": "object",
    "properties": {
      "api_id": {
        "type": "string",
        "description": "The API ID of the field in your template. This field is case sensitive."
      },
      "value": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "boolean"
          },
          {
            "type": "number"
          }
        ],
        "description": "TextField value must be a string or a number."
      }
    },
    "required": [
      "api_id",
      "value"
    ]
  }
}