Purpose
This endpoint initiates a new signing process. Integrators can define the required details such as:
-
The name of the signing process
-
The owner of the signing process
-
The signer list
-
The document that needs to be signed
-
Whether signing must follow a specific order
-
Optionally, additional recipients who will receive the signed document.
-
Optionally, a callback URL to inform when the document is fully signed.
Request
|
Method |
POST |
||||
|
API endpoint path |
|
||||
|
Content-Type |
header |
|
|||
|
Accept |
header |
|
|||
|
Authorization |
header |
Your External API Key |
|||
|
Request body |
(string) |
Name of the signing process. We recommend to use the same name as the document. |
|||
|
(object) |
Details of the person who owns the signing process. Example:
|
||||
|
(object) |
The personal details of those who will sign the document. Example of adding 2 signers:
|
||||
|
(binary) |
The document that will be signed. Sign API supports below file formats:
|
||||
|
(boolean) |
|
||||
|
(array) |
List of email address to also receive the signed document besides the signers. |
||||
|
(string) |
A URL that the system will call when the entire signing process has been successfully completed. Read more about this callback URL below: Starting a Signing Process | Callback URL signTasksCompletedCallbackUrl |
||||
Response
|
Code |
Notes |
|---|---|
|
200 |
OK A successful call returns the full signing process data. The signing process data follows the same structure as Leap Project data, which means it also includes the workflow structure of the process. Read more about signing process data here:
|
|
400 |
BAD_REQUEST Please see the “message” part of the response body for more information. One possibility is that the document file format is not supported. |
|
403 |
FORBIDDEN Please check if the External API Key is valid. |
|
500 |
INTERNAL_SERVER_ERROR Please check if the request body is valid. This error may occur if one or more request body parameters contain invalid syntax. |
Additionally, task notifications are sent via email to the signers. If orderedSigners is set to true, the notification will be sent only when it is that signer's turn to sign the document.
Callback URL - signTasksCompletedCallbackUrl
Provide a URL that our system will call when the document has been fully signed by all required parties. This allows integrators to receive a real‑time notification once the signing process is complete.
Details about the expected signTasksCompletedCallbackUrl
-
Must use
https. -
Must accept a POST request.
-
Recommended to be unique per signing process.
This could help integrators to correctly associate the callback with the corresponding document. A common pattern is to embed your system document ID in the URL, for example:
https://<callback-base-url>/<your-system-document-id>
How we will call your URL
|
Method |
POST |
|
|
API endpoint path |
|
|
|
Content-Type |
header |
|
|
Request body |
|
|