Redirect URL

After a standalone 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:

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 result page shows for 3 seconds before the redirect. 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 how long the result page shows before the ceremony sends ceremony.completed or ceremony.declined. Set it to 0 to hand control back to your app immediately, so your app can show its own result screen. Learn more in Ceremony Events.