Skip to main content

Configuring Signing Order

This use case describes how to set up or change the signing workflow for a draft session.

Overview​

The EasyInk API supports two types of signing workflows:

  • Parallel Signing (Default): All participants receive invitations simultaneously and can sign in any order.
  • Sequential Signing: Participants receive invitations one-by-one in a specific order.

Sequential Signing (One-by-One)​

Use this when business processes require documents to be signed in a specific sequence (e.g., Employee → Manager → HR).

Setting the Order​

To set a sequential order, you must provide an ordered array of participant IDs.

Endpoint: PUT /api/signingSessionDrafts/{id}/signingOrder/oneByOne

Example: Three-Step Approval Chain

{
  "participantsOrder": [
    "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
  ]
}

Sequential Workflow Behavior​

  1. The first participant in the list receives an invitation.
  2. Only after the first participant signs, the second participant receives their invitation.
  3. The process continues until the last participant completes their task.

Parallel Signing (All-At-Once)​

This is the default mode for all new signing sessions. If you have previously configured a sequential order and want to switch back to parallel mode, use the following endpoint.

Endpoint: PUT /api/signingSessionDrafts/{id}/signingOrder/allAtOnce

Note: This request does not require a body.

Parallel Workflow Behavior​

  • All participants receive invitation emails at the same time.
  • Participants can sign in any order.
  • No waiting for previous participants to complete.

Requirements and Restrictions​

  • Draft Only: Signing order can only be configured while the session is in Draft status. It cannot be changed once the session is started.
  • Completeness (Sequential): The participantsOrder array must include every participant added to the session.
  • Validation: If you add or remove a participant while in sequential mode, you must update the signing order accordingly.

Common Errors​

Possible error messages (for more info look at examples)

Error Message
Not all participants were included in the order array (sequential mode).
The array contains IDs that do not exist in this session.
The signing session draft was not found.