Skip to main content

One post tagged with "agreements"

View All Tags

· 2 min read
David Jurio

Until now, signers and approvers got the main document and its attachments, and it was up to them to read them.

API version 3.6.0 adds a guided signing flow: each signer and approver acknowledges the main document and each attachment, in order, before they can sign or approve.

Two flows​

Agreements now have a signing_flow field with two values:

  • standard is how signing has always worked. Participants are presented with the documents, and reading them is their responsibility. It's the default, so existing integrations behave the same after upgrading.
  • guided walks each signer and approver through the main document first, then each attachment in order. The sign or approve step stays locked until every document is acknowledged.

Turning it on​

Set signing_flow to guided when you create the agreement:

POST /agreements
{
    "signing_flow": "guided"
}

You can also change it with PUT /agreements/{agreement_id} while the agreement is draft or open. The current value comes back on the agreement object.

Following along​

Each acknowledgement fires sign_event.document.acknowledged. Subscribe to it with a webhook to see how far each participant has come through the documents.

If you edit the agreement and send it again, earlier acknowledgements no longer count. Participants acknowledge each document again from the point it was resent, and the earlier acknowledgements stay in the history.

When it's worth it​

Guided signing fits agreements where the attachments matter as much as the main document, such as terms and conditions, policies, or appendices that people tend to scroll past. Keep standard for short agreements where an extra step per document would only slow people down.

Learn more about signing flows

Get started​

Upgrade your API client to version 3.6.0. You can do this from your API client settings on zigned.se by clicking "Upgrade".