Skip to main content

Create Document

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: Indicates the type of widget.
  • page: Specifies the page number on which you want to place the respective widget.
  • x, y: Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.
  • w, h: Represents the width and height of the widget. You can adjust these values using the debug UI.
  • required: Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.
  • name: Provides a different name for widgets if you are providing more than one widget.
  1. signature:
{
  "type":"signature", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21
}
  • Note: At least one signature is required for each signer. All signature fields are compulsory by default.
  1. stamp:
{
  "type":"stamp", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "stamp"
  }
}
  1. initials:
{
  "type":"initials", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "initials"
  }
}
  1. email:
{
  "type":"email", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "email"
  }
}
  1. name:
{
  "type":"name", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "name"
  }
}
  1. job title:
{
  "type":"job title", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "job title"
  }
}
  1. company:
{
  "type":"company", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "company"
  }
}
  1. date:
{
  "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" 
  }
}
  • default: Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.
  • format: Specify the date format of your choice from the options below.
    • "dd/MM/yyyy",
    • "dd-mm-yyyy",
    • "yyyy-mm-dd",
    • "mm.dd.yyyy",
    • "mm-dd-yyyy",
    • "mmm dd, yyyy",
    • "mmmm dd, yyyy",
    • "dd mmm, yyyy",
    • "dd mmmm, yyy"
  1. textbox:
{
  "type":"textbox", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "textbox",
    "default": "name",
    "hint": "provide name",
    "regularexpression":""
  }
}
  • default: Provide a default value for the textbox (Optional).
  • hint: Provide a hint for the textbox (Optional).
  • regularexpression: Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).
  1. checkbox:
{
  "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 
    }
  }
}
  • values: Provide options for the checkbox list.
  • selectedvalues: Provide values that need to be selected by default (Optional).
  • readonly: Set to true if you want to set the checkbox as readonly. By default, it's false
  • hidelabel: Set to true if you want to hide labels of the checkbox. By default, it's false.
  • minselections: Provide the minimum number of checkboxes that must be selected by the user.
  • maxselections: Provide the maximum number of checkboxes that can be selected by the user.
  1. dropdown:
{
 "type":"dropdown", 
 "page":1,  
 "x": 327, 
 "y": 628, 
 "w": 114, 
 "h": 21, 
 "options": {
   "required": true, 
   "name": "dropdown",
   "values": ["male", "female", "other"],
   "default": "male"
   }
 }
}
  • values: Provide options for the dropdown list.
  • default: Provide the value that needs to be selected by default. Only one value is accepted. (Optional).
  1. radio button:
{
  "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).
  1. image:
{
  "type":"image", 
  "page":1,  
  "x": 327, 
  "y": 628, 
  "w": 114, 
  "h": 21, 
  "options": {
    "required": true, 
    "name": "image"
    }
  }
}

Request​

Body

required

    file base64required
    title stringrequired
    description string
    note string
    timeToCompleteDays number

    time to complete days is used to calculate expiry date of your document

    signers

    object[]

    required

  • Array [

    • role string
    email string
    name string
    phone string

    widgets

    object[]

  • Array [

    • type string

    Allowed values - signature, stamp.

    page number

    The page number on which the widget should appear. use our Debug UI to calculate the value.

    x number

    x co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    y number

    y co-ordinate (left upper corner) from which widget should appear. use our Debug UI to calculate the value.

    w number

    Width of widget. use our Debug UI to calculate the value.

    h number

    Height of widget. use our Debug UI to calculate the value.

  • ]

  • ]

    • folderId string
    send_email boolean

    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.

    email_subject string

    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}}.

    email_body string

    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}}.

    sendInOrder boolean

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...