Signing order (API)

Modified on Sat, 3 Oct at 2:51 PM

Default behavior: the signing request goes out to everyone at once. If you want sequential signing, set it in settings using the signing_order parameter.

Options

Value Behavior
all_at_once Everyone gets the request immediately (default).
proposers_before_counterparties Proposers sign/approve first, then counterparties.
one_at_a_time One after another — the next person gets the request only after the previous one has signed.

With one_at_a_time, the order is determined by the order of people in the people array in the JSON instructions.

Example

The proposer approves, then Jan signs, followed by Petr:

{
    "people": [
        {
            "is_proposer": true,
            "email": "vas@email.cz",
            "contract_role": "approve"
        },
        {
            "is_proposer": false,
            "email": "jan@protistrana.cz",
            "contract_role": "sign",
            "first_name": "Jan",
            "last_name": "Novák",
            "person_type": "legal",
            "positions": [ { "x": 20, "y": 80, "page": 0 } ]
        },
        {
            "is_proposer": false,
            "email": "petr@protistrana.cz",
            "contract_role": "sign",
            "first_name": "Petr",
            "last_name": "Svoboda",
            "person_type": "legal",
            "positions": [ { "x": 70, "y": 80, "page": 0 } ]
        }
    ],
    "file": "uploaded_file_key",
    "settings": {
        "signing_order": "one_at_a_time"
    }
}

What you get back — note the difference from the default behavior: notifications contains only the person whose turn it currently is. The other people get the request (and the link) only when it's their turn:

{
    "contract_id": 1234567,
    "state": "pending",
    "notifications": [
        { "email": "vas@email.cz",
          "links": { "contract": "https://app.signi.com/dashboard/workspace/…/documents/1234567" } }
    ]
}

Where to go next

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article