Redirect URL

Configure where recipients are sent after completing, declining, or failing a signing ceremony.

After a ceremony finishes (completed, declined, or failed), SignatureAPI redirects the recipient to the redirect_url you defined on the ceremony object.

SignatureAPI appends the following query parameters to the URL:

Parameter	Description
ceremony_result	The outcome: ceremony.completed, ceremony.declined, or ceremony.failed.
envelope_id	The ID of the envelope.
recipient_id	The ID of the recipient.

For example, if redirect_url is https://www.example.com, a successful ceremony redirects to:

https://www.example.com/?ceremony_result=ceremony.completed&envelope_id=5b7be28c-6c7c-4aaa-b25f-66879e8d0957&recipient_id=re_0sgQC0cejYRC8wRsT5N9ll

Use these query parameters to process the ceremony result in your application.

Redirect delay

By default, the redirect happens 3 seconds after the ceremony finishes. Set the redirect_delay property to change this.

// POST https://api.signatureapi.com/v1/recipients/{recipient_id}/ceremonies
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "authentication": [{ "type": "email_code" }],
    "redirect_url": "https://www.example.com/success",
    "redirect_delay": 0
}

Set redirect_delay to 0 for an immediate redirect. The maximum value is 20 seconds.

For embedded ceremonies, redirect_delay controls the delay before emitting ceremony.completed, ceremony.declined, or ceremony.failed Ceremony Events.

Embedded ceremonies ignore the redirect_url and do not navigate away. Use Ceremony Events to handle the outcome in embedded flows.