POST/createdocument
The Create Document API allows users to generate new documents by providing data with base64 encoded file.
Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF
+Below widgets are supported in the document:
+Common parameters of widgets:
+{
"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":"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"
}
}
{
"type":"name",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "name"
}
}
{
"type":"job title",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "job title"
}
}
{
"type":"company",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "company"
}
}
{
"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"
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "textbox",
"default": "name",
"hint": "provide name",
"regularexpression":""
}
}
{
"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,
"validation": {
"minselections": 0,
"maxselections": 0
}
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"values": ["male", "female", "other"],
"default": "male"
}
}
}
{
"type":"radio button",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "radio button",
"values": ["male", "female", "other"],
"default": "male"
}
}
}
- **values:** Provide options for the radio button list.
- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}
}
Body
required
signers
object[]
required
Array [
widgets
object[]
Array [
Allowed values - signature, stamp.
The page number on which the widget should appear. use our Debug UI to calculate the value.
x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.
y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.
Width of widget. use our Debug UI to calculate the value.
Height of widget. use our Debug UI to calculate the value.
]
]
This parameter allows you to specify whether you want emails to be sent to signers. The default value is "true". If the value of this parameter is "true" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.
Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.
Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.
Document created successfully!
Schema
{
"objectId": "hji2zxcv2P",
"url": "https://url-to-sign-document.com"
}
Something went wrong, please try again later!
Schema
{
"error": "Something went wrong, please try again later!"
}
Invalid API Token!
Schema
{
"error": "Invalid API token!"
}
POST/createtemplate
The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique template_id that can be used to generate documents based on the specified template.
Upload you pdf in our Debug UI here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.
+Below widgets are supported in the document:
+Common parameters of widgets:
+{
"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":"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"
}
}
{
"type":"name",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "name"
}
}
{
"type":"job title",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "job title"
}
}
{
"type":"company",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "company"
}
}
{
"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"
}
}
{
"type":"textbox",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "textbox",
"default": "name",
"hint": "provide name",
"regularexpression":""
}
}
{
"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,
"validation": {
"minselections": 0,
"maxselections": 0
}
}
}
{
"type":"dropdown",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "dropdown",
"values": ["male", "female", "other"],
"default": "male"
}
}
}
{
"type":"radio button",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "radio button",
"values": ["male", "female", "other"],
"default": "male"
}
}
}
- **values:** Provide options for the radio button list.
- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}
}
Body
required
signers
object[]
required
You can provide signer optionally if you it as default signer
Array [
widgets
object[]
Array [
Allowed values - signature, stamp.
The page number on which the widget should appear. use our Debug UI to calculate the value.
x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.
y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.
Width of widget. use our Debug UI to calculate the value.
Height of widget. use our Debug UI to calculate the value.
]
]
Template created successfully!
Schema
{
"objectId": "Bh2Hspnmch",
"message": "Template created successfully!"
}
Something went wrong, please try again later!
Schema
{
"error": "Something went wrong, please try again later!"
}
Invalid API Token!
Schema
{
"error": "Invalid API token!"
}