{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Dummy Agreement",
  "label": "Dummy Agreement for Order Ref. 25005",
  "message": "Please review the agreement at your convenience and provide your electronic signature.",
  "status": "completed",
  "mode": "live",
  "routing": "sequential",
  "language": "en",
  "timezone": "UTC",
  "timestamp_format": "DD/MM/YYYY HH:mm:ss",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com",
    "organization": "Acme Enterprises"
  },
  "topics": [
    "sales",
    "project_blue"
  ],
  "metadata": {
    "customer_ref": "x9550501",
    "account_annual_revenue": "$4,500,000"
  },
  "documents": [
    {
      "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "title": "Dummy Agreement",
      "page_count": 2,
      "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
      "format": "docx",
      "data": {
        "date": "December 31st, 2025",
        "showAlert": true,
        "serviceProvider": {
          "name": "Jane Smith",
          "organization": "ACME Global, Inc."
        },
        "client": {
          "name": "Michael J. Miller",
          "organization": "Miller Industries"
        }
      },
      "places" : [
        {
          "key": "provider_signs_here",
          "type": "signature",
          "recipient_key": "service_provider"
        },
        {
          "key": "client_signs_here",
          "type": "signature",
          "recipient_key": "client"
        }
      ]
    }
  ],
  "recipients": [
    {
      "id": "re_26w2VVV5JVm4j459TY5BNM",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "provider",
      "name": "Emily Johnson",
      "email": "emily@example.com",
      "status": "completed",
      "ceremony_creation": "automatic",
      "delivery_type": "email",
      "signature_options": ["typed", "drawn"],
      "completed_at": "2025-12-31T15:00:00.000Z",
      "status_updated_at": "2025-12-31T15:00:00.000Z"
    },
    {
      "id": "re_38UVwrWdCqX5kqeKFJUTtf",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "client",
      "name": "Michael Taylor",
      "email": "michael@example.com",
      "status": "completed",
      "ceremony_creation": "automatic",
      "delivery_type": "email",
      "signature_options": ["typed", "drawn"],
      "completed_at": "2025-12-31T14:00:00.000Z",
      "status_updated_at": "2025-12-31T14:00:00.000Z"
    }
  ],
  "deliverable": {
    "id": "del_1T7If8GgrTOf7zBVPaJf2e",
    "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
    "status": "generated",
    "type": "audit_log",
    "url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e...",
    "language": "en",
    "timezone": "America/New_York",
    "timestamp_format": "MM/DD/YYYY HH:mm:ss"
  },
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z"
}
An envelope is a container that holds documents to be sent to recipients. It defines and manages the signing process for those documents. When an envelope is completed, a deliverable is generated and sent to the recipients.

Relationships

An envelope:

Attributes

id
uuid
The unique identifier of the envelope.
title
string
The title of the envelope, which is shown to recipients.Additionally, you can use the label property to add an internal description that won’t be shown to recipients.
label
string
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
message
string
A message to include in emails to recipients.
status
enum
The current status of the envelope.Available options: draft, processing, in_progress, completed, failed, canceled
mode
enum
The mode affects both legal status and billing of an envelope. Live mode envelopes are legally binding and incur charges, whereas test mode envelopes are non-binding and are not counted towards billing.Available options: live, test
routing
enum
The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another. The default is parallel.Learn more about Recipient Routing
language
enum
The language for the signer interface and related emails.Refer to the list of available languages. The default value is en (English).
timezone
string
The time zone for this envelope.
timestamp_format
string
The timestamp format for this envelope.
sender
object
The sender of the envelope.
topics
array of strings
An array of up to 10 strings used to classify envelopes and filter webhook notifications.Each topic can have up to 32 lowercase alphanumeric characters and underscores, and must start with a letter.
metadata
object
A set of up to 10 custom key-value pairs containing metadata about the envelope.
documents
array of Documents
A collection of documents to be signed.
recipients
array of Recipients
People that signs the documents in an envelope.
attestation
enum
Specifies an attestation for the envelope, as required by certain country regulations. In most cases—including the US and EU member states—no special attestation is needed. For more information, see Attestation.
deliverable
object
File generated as the result of the completion of an envelope.It remains null until the envelope has been completed.
captures
object
Contains the values collected from input fields completed by recipients.
created_at
timestamp
Time at which the envelope was created, in format.
completed_at
timestamp
Time at which the envelope was completed by all recipients, in format.
{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Dummy Agreement",
  "label": "Dummy Agreement for Order Ref. 25005",
  "message": "Please review the agreement at your convenience and provide your electronic signature.",
  "status": "completed",
  "mode": "live",
  "routing": "sequential",
  "language": "en",
  "timezone": "UTC",
  "timestamp_format": "DD/MM/YYYY HH:mm:ss",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com",
    "organization": "Acme Enterprises"
  },
  "topics": [
    "sales",
    "project_blue"
  ],
  "metadata": {
    "customer_ref": "x9550501",
    "account_annual_revenue": "$4,500,000"
  },
  "documents": [
    {
      "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "title": "Dummy Agreement",
      "page_count": 2,
      "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
      "format": "docx",
      "data": {
        "date": "December 31st, 2025",
        "showAlert": true,
        "serviceProvider": {
          "name": "Jane Smith",
          "organization": "ACME Global, Inc."
        },
        "client": {
          "name": "Michael J. Miller",
          "organization": "Miller Industries"
        }
      },
      "places" : [
        {
          "key": "provider_signs_here",
          "type": "signature",
          "recipient_key": "service_provider"
        },
        {
          "key": "client_signs_here",
          "type": "signature",
          "recipient_key": "client"
        }
      ]
    }
  ],
  "recipients": [
    {
      "id": "re_26w2VVV5JVm4j459TY5BNM",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "provider",
      "name": "Emily Johnson",
      "email": "emily@example.com",
      "status": "completed",
      "ceremony_creation": "automatic",
      "delivery_type": "email",
      "signature_options": ["typed", "drawn"],
      "completed_at": "2025-12-31T15:00:00.000Z",
      "status_updated_at": "2025-12-31T15:00:00.000Z"
    },
    {
      "id": "re_38UVwrWdCqX5kqeKFJUTtf",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "client",
      "name": "Michael Taylor",
      "email": "michael@example.com",
      "status": "completed",
      "ceremony_creation": "automatic",
      "delivery_type": "email",
      "signature_options": ["typed", "drawn"],
      "completed_at": "2025-12-31T14:00:00.000Z",
      "status_updated_at": "2025-12-31T14:00:00.000Z"
    }
  ],
  "deliverable": {
    "id": "del_1T7If8GgrTOf7zBVPaJf2e",
    "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
    "status": "generated",
    "type": "audit_log",
    "url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e...",
    "language": "en",
    "timezone": "America/New_York",
    "timestamp_format": "MM/DD/YYYY HH:mm:ss"
  },
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z"
}