{
  "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",
  "timezone": "UTC",
  "timestamp_format": "DD/MM/YYYY HH:mm:ss",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com",
    "organization": "Acme Enterprises"
  },
  "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",
        "show_alert": true,
        "service_provider": {
          "name": "Jane Smith",
          "organization": "ACME Global, Inc."
        },
        "client": {
          "name": "Michael J. Miller",
          "organization": "Miller Industries"
        }
      }
    }
  ],
  "recipients": [
    {
      "id": "re_26w2VVV5JVm4j459TY5BNM",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "provider",
      "name": "Emily Johnson",
      "email": "emily@example.com",
      "status": "completed",
      "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",
      "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..."
  },
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z"
}

The envelope is the most important resource in SignatureAPI.

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.

An envelope has many recipients, documents, and deliverables.

​
Attributes

id
uuid

The unique identifier of the envelope.

title
string

The title of the envelope, which is 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

timezone
string

The time zone for this envelope.

timestamp_format
string

The timestamp format for this envelope.

sender
object

The sender of 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.

deliverable
object

File generated as the result of the completion of an envelope.

It remains null until the envelope has been completed.

created_at
timestamp

Time at which the envelope was created, in ISO 8601 format.

completed_at
timestamp

Time at which the envelope was completed by all recipients, in ISO 8601 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",
  "timezone": "UTC",
  "timestamp_format": "DD/MM/YYYY HH:mm:ss",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com",
    "organization": "Acme Enterprises"
  },
  "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",
        "show_alert": true,
        "service_provider": {
          "name": "Jane Smith",
          "organization": "ACME Global, Inc."
        },
        "client": {
          "name": "Michael J. Miller",
          "organization": "Miller Industries"
        }
      }
    }
  ],
  "recipients": [
    {
      "id": "re_26w2VVV5JVm4j459TY5BNM",
      "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
      "type": "signer",
      "key": "provider",
      "name": "Emily Johnson",
      "email": "emily@example.com",
      "status": "completed",
      "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",
      "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..."
  },
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z"
}

Was this page helpful?

LocalizationEnvelope lifecycle