- Embedding the signing ceremony directly within your web or mobile application
- Redirecting users to their signing ceremony from within your application workflow
- Sending signing invitations through your own email infrastructure with custom branding and templates
When Ceremony URLs are available
You can access a Ceremony URL when the ceremony is active for the recipient and not yet completed. If the first authentication method isemail_link
, the URL will be sent by email and the url
property will be null
.
When SignatureAPI sends the Ceremony URL directly to recipients (such as with Email Link Authentication), the
url
property will be null
since you don’t need to handle the URL delivery yourself.How to obtain a Ceremony URL
To obtain a Ceremony URL, set the ceremony’s authentication method to one of these options:- Email Code
- Custom Authentication
- Multiple Authentication with Email Code or Custom Authentication as the first step
url
property of a Ceremony object. There are several ways to retrieve this URL.
From Envelope Operations
When you create or retrieve an envelope, the Ceremony URL is available in theurl
property of each recipient’s ceremony object.
Envelope object
From Recipient Operations
When you retrieve a recipient, the Ceremony URL is available in theurl
property of the recipient’s ceremony object.
Recipient object
From Ceremony Operations
When you create a ceremony using the Create Ceremony endpoint, the Ceremony URL is returned in theurl
property of the ceremony object.
Ceremony object
Short Ceremony URLs
Standard ceremony URLs are too long for some use cases, such as sharing the URL through space-constrained channels like SMS or push notifications. When creating the ceremony, seturl_variant
to short
to generate a shorter URL.
Example Request