Templates¶

{
  "id": "(UUID)",
  "name": "(template name)",
  "description": "(template description)",
  "signatureLevel": "(how the document shall be signed,
  default LTA)",
  "template": {
        "_comment":"This template defines how data objects
        and signatures are placed on the PDF",
    "textFields": [
      {
            "_comment":"Static text fields",
        "id": "(UUID)",
        "value": "(text of the text field)",
        "rectangle": {
                  "_comment":"Where to place the field,
                  typical for each object",
          "leftTop": {
            "x": "(Left Top point X coordinate)",
            "y": "(Left Top point Y coordinate)"
          },
          "rightBottom": {
            "x": "(Right Bottom point X coordinate)",
            "y": "(Left Bottom point Y coordinate)"
          },
          "page": "(Page of the object)"
        },
        "font": "(Font of the text)",
        "fontSize": "(Font size of the text)",
        "fontColor": {
                 "_comment":"Font color, as rgb",
          "red": 0,
          "green": 0,
          "blue": 0
        },
        "owner": "(Owner (email) of the object,
                typical for each object)"
      }
    ],
    "editTextFields": [
      {
           "_comment":"Text fields which are editable by the owners,
           only differences from Static Text Fields listed below",
        "defaultText": "(Default value, if not edited)",
        "isRequired": "(Is editing this field mandatory
                before signing)",
        "isMultiline": "(True for multiple lines,
                false for single line)"
      }
    ],
    "dateFields": [
      {
          "_comment":"Date fields which can be set by the owners,
          only differences from Text Fields listed below",
        "format": "Date Format"
      }
    ],
    "dropDownFields": [
      {
          "_comment":"Drop down fields which can be set by the owners,
          only differences from Text Fields listed below",
        "optionList": [
          "(List of options, as string)"
        ],
        "selected": "(Selected option)"
      }
    ],
    "radioButtonFields": [
      {
          "_comment":"Radio button fields which can be set by the owners,
          only differences from Text Fields listed below",
       "radioList": [
          { "_comment":"A radio button field is a set of radio button
                  items, for which details are listed below",

          }
        ],
        "selected": "(Selected radio button list id)"
      }
    ],
    "checkBoxFields": [
      {
          "_comment":"Check box fields which can be set by the owners,
          only differences from Text Fields listed below",
        "isSelected": "true if selected by default, false otherwise"

      }
    ],
    "signatures": [
      {
           "_comment":"Signature areas where owner signs the document
           by adding signature, signature specific areas listed below",
        "clickToSign": "(True if signing can be completed by
                only clicking)",
        "drawToSign": "(True if biometric signature information
                shall not be captured)",
        "properties": [
          {
                "_comment":"(Additional properties, can be left empty)",
            "key": "string",
            "value": "string"
          }
        ]
      }
    ]
  },
  "pdfId": "(PDF ID if of template)",
  "createdAt": "(template creation date)",
  "createdBy": "(template owner/created by)",
  "updatedAt": "(template update date)",
  "updatedBy": "(template updated by)",
  "recipients": [
    {
    "_comment":"Recipients of the template",
      "email": "(Email of the recipient)",
      "name": "(Name of the recipient)",
      "recipientType": "(Recipient type,
    can be signer/viewer)",
      "note": "(Notes for the recipient)",
      "authRequired": "(signer shall enter an authcode
    before signing, true/false)",
      "authCode": "(auth code, if required)",
      "authDeliveryType": "(how the auth code is delivered)",
      "orderNum": "(order of the recipient,
    if the recipients shall sign in order)"
    }
  ]
}