Ceremonies
Ceremony
The ceremony object represents a signing session where a recipient interacts with an envelope.
A ceremony is the session where a recipient authenticates and acts on an envelope. Depending on the recipient type, those actions include signing, approving, or preparing documents.
Each recipient has one active ceremony at a time. Creating a new ceremony for a recipient automatically revokes any previous ceremony.
A ceremony belongs to a recipient.
Lifecycle
The ceremony object has no status property. Read the recipient’s status and the ceremony’s url to tell where the ceremony is. See the ceremony lifecycle for the transitions and what each one looks like in the API.
Attributes
An HTTPS URL to redirect the recipient to after they complete or decline the ceremony. Embedded ceremonies ignore it.
Learn more in Redirect URL.
The delay in seconds before the ceremony redirects to redirect_url (standalone ceremonies) or emits completion events (embedded ceremonies).
Defaults to 3. Allowed range: 0 to 20.
Learn more in Redirect URL.
The format of the ceremony URL.
Available options:
standard(default): Full-length URL. Works for most use cases.short: Shortened URL. Use this when sharing through space-constrained channels such as SMS or push notifications.
Origins allowed to embed this ceremony in an iframe.
These values set the frame-ancestors directive in the ceremony’s Content Security Policy (CSP) header. Sources typically take the form of a scheme and host (for example, https://app.example.com). Wildcards are supported (for example, https://*.example.com). For all available options, see the frame-ancestors documentation.
Defaults to an empty list ([]), which means embedding is not allowed. To allow embedding from all origins (not recommended for production), use ["*"].
The URL where the recipient can access the ceremony. You can share this link with the recipient directly or embed it in your application.
This property is null when:
- The first authentication method is
email_link, even when other methods follow it. SignatureAPI delivers the URL by email in that case. - The ceremony is not active (for example, it is completed, revoked, or declined) or the recipient is still
awaitingtheir turn.
A standard URL is valid for 30 days, and every read of the envelope or recipient returns a new one. A short URL stays the same until it expires. Creating a new ceremony for the same recipient invalidates the earlier URLs. Learn more in Ceremony URL.
{
"authentication": [
{
"type": "email_link",
"subject_override": null,
"message_override": null
}
],
"redirect_url": null,
"redirect_delay": 3,
"embeddable_in": [],
"url_variant": "standard",
"url": null
}{
"authentication": [
{
"type": "email_code"
}
],
"redirect_url": null,
"redirect_delay": 3,
"embeddable_in": [],
"url_variant": "standard",
"url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXMiOiJzZXNfMWNoSUVrTE9tdFVNRG9hTDhwOUEifQ.c2lnbmF0dXJl"
}{
"authentication": [
{
"type": "custom",
"provider": "Acme Portal",
"data": {
"Session ID": "se_88620999344",
"Authenticated At": "2026-11-02T14:03:11Z"
}
}
],
"redirect_url": "https://acme.example/signing-complete",
"redirect_delay": 5,
"embeddable_in": [
"https://app.acme.example"
],
"url_variant": "standard",
"url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXMiOiJzZXNfMWNoSUVrTE9tdFVNRG9hTDhwOUEifQ.c2lnbmF0dXJl"
}