Skip to main content
After a ceremony is finished (completed, declined, or failed), the recipient can be redirected to the redirect_url defined in the Ceremony. The following query parameters are appended to the URL:
Parameter NameDescription
envelope_idThe ID of the envelope.
recipient_idThe ID of the recipient.
ceremony_resultThe result of the ceremony: ceremony.completed, ceremony.declined, or ceremony.failed.
For example, if the redirect_url is set to https://www.example.com, after a successful ceremony it will redirect to: https://www.example.com/?ceremony_result=ceremony.completed&envelope_id=5b7be28c-6c7c-4aaa-b25f-66879e8d0957&recipient_id=re_0sgQC0cejYRC8wRsT5N9ll You can 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 when creating a ceremony 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, or up to 20 seconds for a longer delay. For embedded ceremonies, redirect_delay controls the delay before emitting the ceremony.completed, ceremony.declined, or ceremony.failed Ceremony Events.
Embedded ceremonies ignore the redirect and do not navigate to the redirect_url. For embedded flows, use Ceremony Events instead.