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

Request​

Body

required

    file base64required
    title stringrequired
    description string
    note string

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