POST
/
v1
/
envelopes
// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
{
  "title": "Dummy Agreement",
  "label": "Dummy Agreement for Order Ref. 25005",
  "message": "Please review the agreement at your convenience and provide your electronic signature.",
  "documents": [
    {
      "title": "Dummy Agreement",
      "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": [
    {
      "type": "signer",
      "key": "service_provider",
      "name": "Jane Smith",
      "email": "jane@example.com"
    },
    {
      "type": "signer",
      "key": "client",
      "name": "Michael J. Miller",
      "email": "michael@example.com"
    }
  ]
}

{
  "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": "processing",
  "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": "pending",
      "completed_at": null,
      "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": "pending",
      "completed_at": null,
      "status_updated_at": "2025-12-31T14:00:00.000Z"
    }
  ],
  "deliverable": null,
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": null
}

This operation creates an envelope and starts the signing process, sending the documents to the recipients.

​
Body Parameters

title
string
required

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.

timezone
string

The time zone for this envelope.

timestamp_format
string

The timestamp format for this envelope.

sender
object

The sender of the envelope. This overrides the account’s default sender.

documents
array of Documents
required

A collection of documents to be signed, ranging from 1 to 10 documents.

recipients
array of Recipients
required

A collection of people that sign the documents in an envelope, ranging from 1 to 10 recipients.

​
Returns

Returns a 201 Created status code along with an envelope object after successful creation, or an error otherwise.

// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
{
  "title": "Dummy Agreement",
  "label": "Dummy Agreement for Order Ref. 25005",
  "message": "Please review the agreement at your convenience and provide your electronic signature.",
  "documents": [
    {
      "title": "Dummy Agreement",
      "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": [
    {
      "type": "signer",
      "key": "service_provider",
      "name": "Jane Smith",
      "email": "jane@example.com"
    },
    {
      "type": "signer",
      "key": "client",
      "name": "Michael J. Miller",
      "email": "michael@example.com"
    }
  ]
}

{
  "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": "processing",
  "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": "pending",
      "completed_at": null,
      "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": "pending",
      "completed_at": null,
      "status_updated_at": "2025-12-31T14:00:00.000Z"
    }
  ],
  "deliverable": null,
  "created_at": "2025-12-31T12:00:00.000Z",
  "completed_at": null
}

Was this page helpful?

Envelope lifecycleList envelopes