You may want to redirect the participant to a customized web page after s/he has completed his/her action. That’s what web redirection is for.
Configure authorized redirection URLs
From your account’s Developer menu, you can configure web redirection. To do so, navigate to the Integration section of the Developer menu and whitelist the domains of your choice (example https://www.myredirecturl.com).
Note that only https URLs are allowed.
Specify a redirection URL for a participant
Use case 1 : You manage invitation email sending
This is done in 3 steps:
1. Create a transaction with at least one participant.
2. Retrieve the action.URL in the API response.
"actions" : [ {
"id" : "act_PrDr5KEnVOlZW",
"actor" : "john@company.com",
"state" : "open",
"started_at" : "2022-11-07T17:27:16Z",
"url" : "https://apps.universign.net/npds/act_PrDr5KEnVOlZW",
"tasks" : [ {
"type" : "signature",
"state" : "todo",
"field" : "fld_vbO"
} ],
3. Add the complete redirection URL to the action URL, prefixed with ?redirect_url, as follows:
https://apps.universign.net/npds/act_PrDr5KEnVOlZW?redirect_url=https://www.myredirecturl.com/sample_page
Once the participant has performed his/her action, s/he will be redirected to the URL you previously passed.
Use case 2 : Universign handles invitation email sending
This is done in 2 steps:
1. Create a transaction via single request and pass the complete redirection URL of your choice in the invitation_redirect_url argument.
{
"participants" :
{
"email" : "Jane@company.com",
"schedule" : [0],
"fullname_prerequisite" : "Jane Doe",
"invitation_subject" : "This is an invitation subject",
"invitation_message" : "This is an invitation message",
"invitation_redirect_url" : "https://www.myredirect_url.com/sample_page"
}
}
2. Our system captures the redirection URL you passed, compares it to your whitelisted domains and adds it to the links of:
- invitation emails
- reminder emails
Once the participant has performed his/her action, s/he will be redirected to the URL you previously passed.
Transaction outcomes
Depending on whether the participant has completed his/her action or refused to complete it, you can retrieve the participant action state from the URL.
The participant completed his/her action
If the participant has successfully completed his/her action, s/he will be redirected to the URL of your choice. You will receive an addtional parameter outcome=success that is added to the redirection URL:
https://www.myredirecturl.com?outcome=success
The participant refused to complete his/her action
If the participant refused to complete his/her action (by clicking Refuse the documents), s/he will be redirected to the URL of your choice. You will receive an additional parameter outcome=refusal that is added to the redirection URL:
https://www.myredirecturl.com?outcome=refusal
