{
"type":"image",
"page":1,
"x": 327,
"y": 628,
"w": 114,
"h": 21,
"options": {
"required": true,
"name": "image"
}
}
Body
required
time to complete days is used to calculate expiry date of your document
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}}.
If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'.
true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.
true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.
Specifies the URL where the signer will be redirected upon completing the document signing process.
The name of the person or organization on whose behalf the email is being sent.
The email address of the person or organization that users can reply to.
true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.
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!"
}
Document created successfully!
Schema
signurl
object[]
Array [
]
{
"objectId": "hji2zxcv2P",
"signurl": [
{
"email": "mail@example.com",
"url": "https://url-to-sign-document.com"
}
],
"message": "Document sent 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!"
}