Documill Leap
Documill Leap
Breadcrumbs

Starting a Signing Process

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.

Request

Method

POST

API endpoint path

https://api.leap.documill.com/api/v1/external/sign-only-api/projects/launch-new

Content-Type

header

multipart/form-data

Accept

header

application/json

Authorization

header

Your External API Key

Request body

name

(string)

Name of the signing process. We recommend to use the same name as the document.

projectOwner

(object)

Details of the person who owns the signing process.

Example:

{
  "name": "Tester",
  "organization": "Test Organization",
  "email": "tester@test.documill.com",
  "title": "Manager"
}

signers

(object)

The personal details of those who will sign the document.

Example of adding 2 signers:

{
  "signers": [
    {
      "name": "Signer 1",
      "organization": "Acme",
      "email": "signer1@test.acme.com",
      "title": "CEO"
    },
    {
      "name": "Signer 2",
      "organization": "Test Organization",
      "email": "signer2@test.documill.com",
      "title": "Sales"
    }
  ]
}


document

(binary)

The document that will be signed. Sign API supports below file formats:

  • DOCX

  • PDF

orderedSigners

(boolean)

true

Signers will take turn to sign the document. The signing order is based on the array in the signers parameter.

false

All Signers can sign the document at the same time.

additionalRecipients

(array)

List of email address to also receive the signed document besides the signers.

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:
Understanding Signing Process Data

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.