Envelopes

An Envelope is the fundamental unit of a transaction in SignEngine. It serves as a container for all the documents, recipients, and interactions required to complete a digital signature process.

Anatomy of an Envelope

An envelope consists of three main components:

1. Documents: The files (PDF, DOCX) that need to be signed or viewed.
2. Recipients: The individuals who interact with the envelope (signers, viewers, etc.).
3. Status: The current state of the workflow (e.g., sent, completed, voided).

Lifecycle

The lifecycle of an envelope typically follows these stages:

1. Draft: The envelope is being created. You can add documents, recipients, and fields. It has not been sent yet.
2. Sent: The envelope has been sent to the first recipient in the routing order.
3. Delivered: The current recipient has viewed the envelope.
4. Completed: All recipients have completed their actions (signed, viewed, approved). The final signed documents are now available.
5. Voided: The sender canceled the transaction before it was completed.
6. Declined: A recipient refused to sign the document.

Creating an Envelope

You can create an envelope using a single API call:

POST /api/v1/envelopes
{
  "name": "NDA Agreement",
  "emailSubject": "Please sign the NDA",
  "documents": [...],
  "recipients": [...]
}

Envelope Settings

• Expiration: Set a date/time when the envelope expires.
• Reminders: Configure automatic email reminders for recipients who haven't signed yet.
• Brand: Apply a specific brand (logo, colors) to the email notifications and signing ceremony.