A ceremony is a session where a recipient interacts with an envelope, such as by signing it.
If the recipient’s ceremony_creation property is set to automatic (or not set at all), a ceremony is automatically created with an authentication type of link via email.
If the recipient’s ceremony_creation property is set to manual, the ceremony is not automatically created. You must create it using the Create Ceremony endpoint. This allows you to embed the ceremony into a web or mobile app or send the ceremony URL directly to the recipient.
With link via email authentication, the recipient receives an email with a link to initiate the ceremony, sent by SignatureAPI.
Specifies the type of authentication.
For link via email authentication, this value must be email_link.
With custom authentication, your application receives a URL to share with the recipient. You can send this URL via email or embed it in a web or mobile application, enabling the recipient to initiate the ceremony.
A set of key-value pairs with metadata about the authentication, such as timestamps, session IDs, and correlation IDs. These values will be included in the audit log.
The values provided in data must be sufficient for verifying the recipient’s authentication. For instance, an expert witness in a legal proceeding should be able to correlate these values with the authentication details in your system.
When using custom authentication, you must retain all records necessary to prove the recipient’s authentication, such as session information. Please review our Terms & Conditions for more details.
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.
To ensure compatibility, we consider only the origin (scheme and host) of the URL and exclude the path.