Introducing Short Ceremony URLs

Standard ceremony URLs carry a signed token and can be long. That is rarely a problem for email, but it is a real constraint when you want to deliver a signing link by SMS or push notification. Short ceremony URLs solve that.

What It Does

When creating a ceremony, you can now request a condensed URL using the new url_variant property. It accepts two values, standard (the default) and short. Standard URLs continue to look exactly as before. Short URLs use the https://sign.signatureapi.com/s/... format and fit comfortably inside a single SMS message.

Short URLs work with any authentication method that returns a ceremony URL to you, including Custom Authentication and Email Code Authentication.

How to Use It

Set url_variant to short when creating the ceremony:

// POST https://api.signatureapi.com/v1/recipients/{recipientId}/ceremonies

{
  "authentication": [
    {
      "type": "custom",
      "provider": "ACME App",
      "data": {
        "correlation id": "a4f9e8b2-7c1d-4b2d-9a4b-e0c5d6f7a1b3",
        "session id": "se_88620999344"
      }
    }
  ],
  "url_variant": "short"
}

The response includes the shortened URL in the url field, ready to send through Twilio, a push notification provider, or any channel you prefer.

{
  "url": "https://sign.signatureapi.com/s/ZdxlxxxxxxxxxxsU"
}

Short URLs do not refresh automatically. If you need a new one, create a new ceremony. For more details, see Ceremony URL and Create a Ceremony.