Envelopes

Mint a short-lived embedded signing URL

post/api/v1/envelopes/{id}/recipients/{recipientId}/embedded-url

Request

  • Base URL: https://swiftsign.ca
  • URL: https://swiftsign.ca/api/v1/envelopes/{id}/recipients/{recipientId}/embedded-url
  • Auth: HTTP bearer

Path parameters

idstring required
recipientIdstring required

Request body

returnUrlstring uri

https URL to return the signer to after signing.

Example request

{
  "returnUrl": "https://acme.com/signed"
}

Response

A single-use iframe URL valid for 30 minutes.

urlstring uri required
expiresAtstring required

Example response

{
  "url": "https://swiftsign.ca/embed/abc123…",
  "expiresAt": "2026-03-14T16:32:11.000Z"
}

Changes

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