{
  "authentication": {
    "type": "custom",
    "provider": "SuperApp",
    "data": {
      "Session ID": "se_88620999344",
      "Authenticated At": "Dec 31, 2025 23:59:59"
      }
  },
  "embeddable_in": [
      "https://app.example.com"
  ],
  "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
}

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.

A ceremony belongs to a recipient.

​
Attributes

​
authentication
authentication object

Defines how the recipient authenticates to this ceremony.

Authentication methods can be either link via email or custom.

​
redirect_url
string

A URL to redirect the recipient to after a ceremony is finished.

Learn more in Redirect URL.

​
embeddable_in
array of strings

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).

​
url
string

The URL the recipient must visit to initiate the ceremony, either directly or embedded in a web or mobile application.

If the authentication type is email_link, this field will be null, as the recipient will receive the URL via email directly from SignatureAPI.

{
  "authentication": {
    "type": "custom",
    "provider": "SuperApp",
    "data": {
      "Session ID": "se_88620999344",
      "Authenticated At": "Dec 31, 2025 23:59:59"
      }
  },
  "embeddable_in": [
      "https://app.example.com"
  ],
  "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
}

Was this page helpful?

Get a deliverableCeremony URL