The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique objectId (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a url is provided, which offers a user interface for editing the template and facilitating document distribution.
Tip: Upload your PDF document to our Debug UI, where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API.
When document is created this webhook event will trigger
-{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE",
"url": "SIGNING_URL"
}
],
"createdAt": "TIMESTAMP"
}
{
"event": "created",
"type": "DOCUMENT_TYPE",
"objectId": "DOCUMENT_ID",
"file": "DOCUMENT_URL",
"name": "DOCUMENT_NAME",
"note": "Please review and sign this document",
"signers": [
{
"name": "SIGNER_NAME",
"email": "SIGNER_EMAIL",
"phone": "SIGNER_PHONE",
"url": "SIGNING_URL"
}
],
"createdAt": "TIMESTAMP"
}
Supported Widgets:
Below are the common parameters that are required with all widgets:
List of all supported widgets:
{
"type":"signature",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21
}
{
"type": "signature",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21
}
{
"type":"stamp",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "stamp"
}
}
{
"type": "stamp",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "stamp"
}
}
{
"type":"initials",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "initials"
}
}
{
"type": "initials",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "initials"
}
}
{
"type":"email",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
}
}
{
"type": "email",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "email",
"color": "black",
"fontsize": 12
}
}
{
"type":"name",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
}
}
{
"type": "name",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "name",
"color": "black",
"fontsize": 12
}
}
{
"type":"job title",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
}
}
{
"type": "job title",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "job title",
"color": "black",
"fontsize": 12
}
}
{
"type":"company",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
}
}
{
"type": "company",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "company",
"color": "black",
"fontsize": 12
}
}
{
"type":"date",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "date",
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
}
}
{
"type": "date",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "date",
"default": "04-15-2024",
"format": "mm-dd-yyyy",
"color": "black",
"fontsize": 12
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"name": "textbox",
"required": true,
"readonly": false,
"default": "name",
"hint": "provide name",
"regularexpression":"",
"color": "black",
"fontsize": 12
}
}
{
"type": "textbox",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"name": "textbox",
"required": true,
"readonly": false,
"default": "name",
"hint": "provide name",
"regularexpression": "",
"color": "black",
"fontsize": 12
}
}
{
"type":"checkbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "checkbox",
"values": ["male", "female", "other"],
"selectedvalues": [ "male", "female" ],
"readonly": false,
"hidelabel": false,
"color": "black",
"fontsize": 12,
"validation": {
"minselections": 0,
"maxselections": 0
}
}
}
{
"type": "checkbox",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "checkbox",
"values": ["male", "female", "other"],
"selectedvalues": ["male", "female"],
"readonly": false,
"hidelabel": false,
"color": "black",
"fontsize": 12,
"validation": {
"minselections": 0,
"maxselections": 0
}
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"readonly": false,
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"type": "dropdown",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"readonly": false,
"values": ["male", "female", "other"],
"default": "",
"color": "black",
"fontsize": 12
}
}
{
"type":"radio button",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "radio button",
"readonly": false,
"values": ["male", "female", "other"],
"default": "male",
"color": "black",
"fontsize": 12
}
}
{
"type": "radio button",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "radio button",
"readonly": false,
"values": ["male", "female", "other"],
"default": "male",
"color": "black",
"fontsize": 12
}
}
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}
{
"type": "image",
"page": 1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}