email_link
authentication. To take manual control, provide a ceremony
object when creating the recipient to specify authentication and other options, or create additional ceremonies later using the Create Ceremony endpoint.
A ceremony belongs to a recipient.
Attributes
A URL to redirect the recipient to after a ceremony is finished.Learn more in Redirect URL.
The type of ceremony URL returned for sharing flexibility.Available options are
short
and standard
. The default is standard
.Use short
when you need to share the URL in space-constrained channels such as SMS or push notifications.List of sources allowed to embed this ceremony (for web embedding).These sources will be used in the frame-ancestor directive of the ceremony’s HTTP Content Security Policy (CSP).Sources usually take the form of a scheme and host, like
https://app.example.com
, but can also use wildcards, like https://*.example.com
. For all available options, refer to the frame‑ancestors documentation.Defaults to an empty list ([]
), meaning the ceremony cannot be embedded unless you explicitly allow at least one origin. To allow embedding in all origins (not recommended for production), use ["*"]
.To ensure compatibility, only the origin (scheme and host) is considered; paths are ignored.
The URL where recipients can access and complete the signing ceremony. This can be embedded in a web or mobile app, or shared by other means.This property will be
null
in the following cases:- The recipient is expected to access the ceremony via an internal delivery method (for example, authentication via
email_link
). - The ceremony is not currently active (for example, it has been completed, revoked, or declined).