CoE Flow Submission

Before You Begin

Review the Requirements section to confirm your environment meets all browser, operating system, and permission criteria before starting integration.

Integration Steps

1. Launching the flow

1. Call the Get Partner Token API from your application, this token will be used to call Initiate Flow API.
2. Call the Initiate Flow API from your application to generate a launch URL for the browser-based verification flow.
3. Extract the launch URL from the Initiate Flow API response and use it to launch the IAB flow.

ℹ️

For devices without a camera, the IAB supports a Smart QR mode that redirects the flow to the user's mobile device. Refer to the Smart QR Mode guide for more details.

⚙️

You can customize the flow's appearance and behavior — including portrait mode enforcement, dark/light theme, and more. See Flow Configuration Options for all available parameters.

2. What happens during the flow?

After the browser loads the launch URL, the H5 Web app guides the user through the verification process:

1. Camera permission - The user is prompted to grant camera access in the browser.
2. Image capture - The user captures a selfie with real-time feedback to ensure proper framing and lighting.
3. Processing - The captured image(s) are sent to the backend for processing.

Once processing completes, the user is automatically redirected back to your application.

3. Sending callback to the partner

After the user completes (or exits) the flow, IAB FE sends a callback to the partner application which may be in the form of redirection (in case of webview and browser) and a message to the iframe's parent window (in case of iframe).

Parameters containing details about the flow outcome and session information are attached to the callback. The partner application should use these parameters to determine next steps in their application (e.g., fetching submission details or displaying an error message).

Integration Guides

Choose the guide that matches your target environment:

Customisation

You can customise the look and feel of the IAB web application to match your brand. See Theme Customisation for available options.