The Envelope object

An envelope is the core resource in Annature. It represents a single transaction between one or more recipients, and contains one or more documents. Envelopes also include metadata about the sender, security settings, and the overall status of the transaction.

Not all recipients are required to sign the documents in an envelope. For example, a recipient with the viewer type is only required to view the documents.
For more information about recipient types and their roles, refer to the recipients section.

Envelopes are always created and sent from a specific account, using the account_id property. The envelope will automatically inherit the branding configuration of the group that the account belongs to. If no group is assigned, the organisation’s default branding will be used.

​

Envelope statuses

The status property indicates the current state of the envelope. Valid values include:

• draft – The envelope has been created but not yet sent. Draft envelopes can be sent programmatically using the Send envelope endpoint or from the Annature dashboard.
• created – The envelope is in the process of being prepared for delivery. This is a short-lived transitional state immediately before sending.
• sent – The envelope has been sent and is awaiting action from one or more recipients.
• completed – All recipients have completed their actions. The finalised document and certificate of completion are available for download.
• voided – The envelope was cancelled by the sender before completion. Recipients can no longer view or interact with it.

​

Downloadable copies

Envelopes expose several downloadable assets through temporary URLs, valid for 60 minutes by default.

• original – The combined document exactly as it was uploaded, before any fields (e.g. signatures, dates) were applied.
• master – The live, up-to-date version of the envelope with all completed actions applied. This is null while the envelope is still in created status.
• certificate – A certificate of completion PDF. Available only once the envelope is completed.
• combined – A single PDF file containing the master copy of the envelope and the certificate of completion appended to the end. This is available only once the envelope is completed.

​

Envelope sharing and group visibility

Envelope visibility is controlled by the sender’s role, group membership, and the shared property on the envelope.

• Administrators can view and manage all envelopes across the organisation, regardless of sender or group.
• Standard users can only see envelopes they have personally sent — unless additional access is granted through group sharing.

When a standard user is assigned to a group, they gain access to any envelope sent by another member of that group — but only if the envelope is marked as shared.

By default, standard users can choose whether an envelope is shared with their group or kept private. However, default sharing behavior or forced sharing rules can be configured at the account level via the Annature dashboard.

Each account can belong to only one group. Cross-group sharing is not supported.

This structure allows organisations to reflect real-world teams and permission boundaries — ensuring that users only access envelopes relevant to their role or department.

​

Attributes

GET /v1/envelopes
GET /v1/envelopes/:id
POST /v1/envelopes
POST /v1/envelopes/:id/void
PUT /v1/envelopes/:id
DELETE /v1/envelopes/:id

{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement",
  "message": "Lorem ipsum dolor sit amet.",
  "status": "sent",
  "shared": false,
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "voided": "2019-12-17T05:30:00Z",
  "declined": "2019-12-17T05:30:00Z",
  "completed": "2019-12-17T05:30:00Z",
  "master": "https://annature..",
  "certificate": "https://annature..",
  "combined": "https://annature..",
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "recipients": [],
  "metadata": {}
}