Envelope lifecycle
An envelope moves through a set of statuses from creation until it reaches a terminal state. This page describes those statuses and when transitions happen from an API and event perspective.
Statuses
Section titled “Statuses”- uploading - Document is being uploaded; the envelope is not yet editable. When the upload finishes, the envelope
moves to
draft. - draft - The envelope can be edited: add or remove documents, attachments, recipients, and blocks. You can update
title, tags, and options. Sending the envelope moves it to
signing. - signing - The envelope has been sent. Recipients can open and sign. When all required signatures are collected, the
envelope moves to
complete. It can also move todeclined,canceled, orexpired. - complete - All required signatures have been collected. You can download the signed document and proof.
- declined - A recipient declined to sign.
- canceled - The envelope was canceled (e.g. by the sender or an admin).
- expired - The invitation link expired before all required signatures were collected.
Lifecycle diagram
Section titled “Lifecycle diagram”
When transitions happen
Section titled “When transitions happen”- uploading → draft: Document upload completes (e.g. after
create-from-fileor upload + complete). - draft → signing: You call the send endpoint (e.g.
envelope/send). The envelope must be indraftand have at least one document and required recipients/blocks. - signing → complete: The last required signer signs. Subnoto sends an
ENVELOPE_COMPLETEDwebhook. - signing → declined: A recipient declines. Subnoto can send
ENVELOPE_DECLINED. - signing → canceled: The envelope is canceled via the API or UI. Subnoto can send
ENVELOPE_CANCELED. - signing → expired: The invitation validity period ends before completion.