Envelopes

Create an envelope (inline or from a template)

post/api/v1/envelopes

Request

  • Base URL: https://swiftsign.ca
  • URL: https://swiftsign.ca/api/v1/envelopes
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional. Replays the original response for a duplicate request body.

Example:a1b2c3d4-e5f6-7890-abcd-ef0123456789

Request body

OR

Example request

{
  "subject": "Mutual NDA for countersignature",
  "message": "Please sign at your convenience.",
  "documents": [
    {
      "name": "mutual-nda.pdf",
      "base64": "JVBERi0xLjcKJ…"
    }
  ],
  "recipients": [
    {
      "name": "Steve Park",
      "email": "steve@acme.com",
      "role": "SIGNER",
      "routingOrder": 1
    }
  ],
  "fields": [
    {
      "page": 1,
      "x": 12,
      "y": 64,
      "width": 30,
      "height": 5,
      "anchor": "Party B — Signature",
      "yOffset": -2,
      "options": [
        "Yes",
        "No"
      ]
    }
  ]
}

Response

Envelope created (DRAFT). Call POST /api/v1/envelopes/{id} with action:"send".

idstring required
subjectstring required
messagestring nullable required
status'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'VOIDED' required
livemodeboolean required
createdAtstring required

Example response

{
  "id": "b8f1c0a2-3d4e-5f60-7182-93041a2b3c4d",
  "createdAt": "2026-03-14T16:02:11.000Z",
  "recipients": [
    {
      "status": "PENDING"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.