Use this API to create an eSigning Request
A POST call has to be made to this API with name, email ID and/or Phone Number of the user(s). You can either pass a PDF file encoded in Base64 format or use a Template pre-configured in your account bypassing the Template ID and the values of the Template Keys. You can also use the optional parameters for additional Settings. On successful request creation, you get an ID & eSigning URL in response.
Request body
irn stands for Internal Reference Number. Use this value to set a custom Internal Reference Number to your document. You can later use the internal reference number to search for this document either through the Search API or your Dashboard.
Allowed Characters are:
- All Alphanumeric Characters
- Special Characters: + | - : () , _. [] &/ @
- Maximum Character Length: 255
folder id stands for the Unique ID of the folder obtained from your Dashboard. Pass this value in the Create API to add the document to a particular folder.
Can be used to define the timeout period after which an uncompleted transaction gets cancelled and reversed. -1 is for 45 minutes, 0 means same day (11:59 PM) , 1 stands for next day , 2 stands for 2 days and so on.
Pass 'false' if you want to activate all the signing invitations for a particular document instantly. By default, the invitations for subsequent users are only activated once all the previous invitations to that document are eSigned. This will be mandatory in case you use and invitee as a approver transaction.
Pass this parameter as true to allow configuring stamps specific to documents while sending a document with NeSL eSign configured. If you pass this parameter as true, configure NeSL eStamps and map eStamps to documents, then NeSL eStamps will be attached just before its corresponding documents. To map eStamps with documents, you need to mandatorily pass a value for documentIndex key in the array of stampData. The documentIndex key accepts natural numbers starting from 1. Note that documentIndex = 1 corresponds to the key file in the object file, and documentIndex = 2 corresponds to the first element in the additionalFiles array, and so on.
Pass 'true' if you want the documents to be automatically deleted on completion after 7 days of completion. The URLs sent to all signers will also be put to auto-delete after 7 days of completion unless the signer expressly saves it in his account. (Please setup a webhookUrl in this case as deleted documents cannot be recovered).
You can enter any customer message to send to the user which will be sent with the invitation. The message will also be displayed to the user on the signing page.
Unique stamp series number to be passed in case you want to use stamp paper along with the document. Stamp series can be found in Leegality stamp dashboard. If stamp series and stamp group both are passed in the API stamp series will be given higher priority.
Unique series group number to be passed in case you want to use stamp paper along with the document. Series group number can be found in Leegality stamp dashboard.
If you are using Series group stamp value is required. It signifies the value of stamp you want to use along with the document.
Unique stamp series number associated with a revenue stamp series to be passed in case you want to use a revenue stamp along with the document. Stamp series can be found in Leegality stamp dashboard. Revenue stamp series can be used along with either one of normal stamp series or stamp groups.
Pass the number of revenue stamps you want to attach to the document. Note- If the parameter is not passed, default value of 1 will be considered.
If this value is passed as TRUE, then for each invitee, in appearance, ‘page’ = 1 will corresponding to the coordinates of all stamps. In this case, ‘page’ = 2 would be the 1st page of the document.
Pass this value as TRUE to transfer the document, once completed via SFTP Note: The parameter sftpId needs to be passed with a correct value if sftp is passed as TRUE
This parameter requires the unique SFTP ID generated by Leegality for every SFTP configured in Department Level Settings of an admin account Note: The parameter sftp needs to be passed as TRUE in order to pass sftpId
Pass this parameter as ‘true’ to receive a URL in return for setting custom eSign coordinates for all signers in the API call. The eSign coordinates that are set through the URL will be in addition to any coordinates you pass in the Invitees array (Invitees. appearances).
Note 1: If you pass coordinate_picker as ‘true’ the response structure of the API call will be different.
Note 2: Invitations in the API call will become active only after the eSign coordinates are set through the URL received in return.
Note 3: If you pass coordinate_picker as ‘true’, we highly recommend that you also pass a URL in the “coordinate_picker_webhook” parameter to receive an update when the eSign coordinates are set and the invitations are active.
Enter the URL where you wish to receive a webhook notification when the eSign coordinates are set and the invitations are active.
If provided, custom headers mapped with the Profile ID would be added in the webhook Call. To obtain a Profile ID for your requirement, please contact your Leegality customer success manager.
The structure of the webhook response can be found here: https://docs.leegality.com/webhooks_resources#tag/Coordinate-Picker-Webhook.
This parameter is relevant only if you pass coordinate_picker as ‘true’.
Example request
{
"invitees": [
{
"signatures": [
{
"config": {
"authTypes": [
"OTP",
"BIO",
"IRIS",
"FACE"
]
}
}
]
}
]
}Response
Default Response
if success then 1, else 0.
Changes
No recorded changes to this endpoint across all 1 revision of this API.