Document lifecycle (API)

Modified on Sat, 3 Oct at 2:49 PM

Every document in Signi goes through states. The state tells you what's happening with the document and what you can do with it at that moment.

Overview of states

State What it means
draft In progress — the document is created but hasn't been sent to anyone. Signing invitations are not yet being sent.
pending Waiting for signatures — an email with an invitation has been sent to the signers.
waiting_for_answers Waiting for data to be filled in — the counterparty must first complete the required fields in the document.
completed Completed — everyone has signed or approved. Only now can you download the PDF with signatures.
rejected Rejected — one of the parties rejected the document.
expired Expired — the draft's validity lapsed before everyone signed.
deleted Deleted.

How states follow each other

  1. You create a document via the API — either directly for signing (pending), or as a draft (draft) by setting "state": "draft" in the JSON instructions.
  2. For documents with fillable fields, signing may be preceded by the counterparty filling in data (waiting_for_answers).
  3. In the pending state the individual parties sign.
  4. It ends in one of three states: completed, rejected, or expired.

How to find out the state

By querying the document detail:

curl -H "x-api-key: VAS_API_KLIC" https://api.signi.com/api/v1/contract/ID_DOKUMENTU

In the response the state is in the state field:

{ "contract_id": "1234567", "contract_name": "…", "state": "pending", "creator": { "email": "…" } }

It's more convenient to have changes reported automatically via a webhook — Signi calls your application when a document transitions to the pending, completed, rejected, or expired state. For details see the article Webhooks — automatic notifications of document state changes.

What to watch out for

  • The PDF with signatures can only be downloaded in the completed state — earlier you'll get the document without signatures.
  • Deleting documents has restrictions depending on the state — details in the article Cancelling and deleting a document.

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