Skip to main content
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

A ceremony’s status tracks the recipient’s progress. See the ceremony lifecycle for details on each status.

​
Attributes

​
authentication
array of authentication object
​
redirect_url
string | null
An HTTPS URL to redirect the recipient to after the ceremony finishes.Learn more in Redirect URL.
​
redirect_delay
integer | null
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.
​
url_variant
enum
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.
​
embeddable_in
array of strings
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 ["*"].
Only the origin (scheme and host) is used. Paths are ignored.
​
url
string | null
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 ceremony uses email_link authentication. SignatureAPI delivers the URL by email in that case.
  • The ceremony is not active (for example, it is completed, revoked, or declined).
The URL expires 30 days after creation, or when a new ceremony is created for the same recipient.
{
  "authentication": [
    {
      "type": "email_link",
      "subject_override": null,
      "message_override": null
    }
  ],
  "redirect_url": null,
  "redirect_delay": 3,
  "embeddable_in": [],
  "url_variant": "standard",
  "url": null
}