Recipient routing

The routing property controls the order in which recipients receive and act on the envelope. Two options are available: sequential and parallel. The default is sequential.

Sequential routing

With sequential routing, the envelope is delivered to one recipient at a time, in the order listed in the recipients array. Each recipient must complete their part before the next one is notified.

• Recipients act in the order defined in the recipients array.
• Each recipient must complete before the next one is notified.
• Recipients acting later can see signatures and data entered by those who acted before them.
• Recipients waiting for a previous recipient will have a status of awaiting.
• Use this when the order of signatures matters.

Parallel routing

With parallel routing, all recipients receive the envelope at the same time and can act in any order.

• All recipients are notified simultaneously.
• Recipients can act in any order.
• Use this when signing order does not matter.

Setting routing on an envelope

Set the routing property when creating an envelope. If omitted, sequential routing is used.

// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "title": "Service Agreement",
  "routing": "parallel",
  "documents": [
    //...
  ],
  "recipients": [
    //...
  ]
}