Browser Integration

Launch the flow directly in the user's browser by redirecting them to a launch URL generated by the Initiate Flow API.

How It Works

The browser integration uses a redirect-based flow. Your application redirects the user to the verification flow, and the user is redirected back to your application when the flow completes.

Integration Steps

1. Call the Initiate Flow API

Call the Initiate Flow API from your application to generate a launch URL for the browser-based verification flow. Include the redirection URLs where the user should be sent after the flow completes:

• successRedirectionUrl - where the user is redirected after completing the flow
• failureRedirectionUrl - where the user is redirected if the flow fails or is abandoned

2. Redirect the User to the Launch URL

Extract the launch URL from the Initiate Flow API response and redirect the user's browser to it. The user completes the identity verification steps directly in the browser window.

// After receiving the launch URL from the Initiate Flow API response
const launchUrl = initiateFlowResponse.launchUrl;

// Redirect the user to the verification flow
window.location.href = launchUrl;

3. Handle the Redirection Back

After the user completes (or exits) the flow, they are automatically redirected to the appropriate URL you specified in Step 1:

Query parameters appended to the redirect URL contain details about the flow outcome. Use these parameters to determine next steps in your application (e.g., fetching submission details or displaying an error message).

📄

For the full specification of query parameters and status codes returned during redirection, refer to the Partner Redirection document.