- api
- 2025-06-05
Short Ceremony URLs
You can now request a shorter ceremony URL when creating a ceremony for a recipient. This makes it easier to share signing links in space-constrained channels such as SMS or push notifications.
To use this feature, include the optional url_variant
property in your ceremony creation request. It accepts two values:
standard
(default): The full-length URL as before.short
: A condensed URL optimized for limited space.
This works seamlessly with custom authentication. Authenticate your recipient and obtain a short ceremony URL that you can send using SMS services like Twilio.
For example, to create a ceremony with a short URL:
// 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 will include the shortened URL in the url
field:
{
//...
"url": "https://sign.signatureapi.com/s/ZdxlxxxxxxxxxxsU",
//...
}
For more details on ceremony creation and custom authentication, see Create a Ceremony and Custom Authentication.
This feature is fully backward compatible and does not affect existing integrations using the standard ceremony URL.