Set redirect URLs per Applicant in Workflow Collect

You can now define where each Applicant is redirected at the end of their Workflow Collect journey, using the new redirect_urls object on the Applicant.

Until now, redirect URLs could only be set on the Custom Experience, and applied to every Workflow Session using it. With redirect_urls, you can send each Applicant to a page specific to their case, for example a URL carrying your own customer or file reference.

redirect_urls accepts two optional fields:

• success: the URL the Applicant is redirected to once every action is completed.
• error: the URL the Applicant is redirected to when an action is blocked.

Set it when you Create a new Applicant or Update an Applicant. It is returned on Get an Applicant and List Applicants.

"redirect_urls": {
  "success": "https://example.com/success",
  "error": "https://example.com/error"
}

How it works:

• A field left null falls back to the Custom Experience redirect URL, so you can override only one of the two.
• On update, an omitted field keeps its current value and a null field clears it.
• Redirect URLs apply when the Workflow Session link is opened outside an iframe.
• Redirect URLs can only be set on a parent Applicant. Setting them on a child Applicant (one with a parent_applicant_id) returns a 400 error.

Read the Custom Experience guide