Partner Redirection

When the face verification process completes or encounters an error, IAB redirects the user back to one of the redirection URLs provided during Launch URL generation. IAB appends status and partner_session_id as query parameters to the redirect URL. Your frontend should read these parameters and route the user to the appropriate screen.

How It Works

You provide a successRedirectionUrl and failureRedirectionUrl when generating the Launch URL.
IAB processes the flow.
On completion or error, IAB redirects the user to the corresponding URL with query parameters appended.
Your frontend parses the query parameters and displays the appropriate screen.

Redirection Examples

Given the following configuration:

Parameter	Value
`successRedirectionUrl`	`https://partner.host.com/iab/face_verification_success/callback`
`failureRedirectionUrl`	`https://partner.host.com/iab/face_verification_failure/callback`
`x-partner-session-id`	`d6646921-f172-40ee-9cac-cfd3e91a8a50`

On completion (successfully matched or rejected):

https://partner.host.com/iab/face_verification_success/callback?status=COMPLETED&partner_session_id=d6646921-f172-40ee-9cac-cfd3e91a8a50

On failure (error):

https://partner.host.com/iab/face_verification_failure/callback?status=ERROR&partner_session_id=d6646921-f172-40ee-9cac-cfd3e91a8a50&error_code=SESSION_TIMEOUT

Query Parameters

`status`

Indicates the outcome of the face verification process.

Value	Description
`COMPLETED`	Flow completed. Fetch the result (valid or invalid) from IAB BE using the `partner_session_id`.
`ERROR`	An unexpected error occurred during the flow. Check `error_code` for details.

`partner_session_id`

The ID provided to the IAB BE library when generating the Launch URL. Use this to correlate the redirect with your original request and to fetch results from IAB BE.

`error_code`

Present only when status is ERROR. Identifies the specific failure reason.

Code	Description
`PENDING`	The user dropped off by pressing the back button before the process completed.
`SESSION_TIMEOUT`	The launched session expired.
`PERMISSION_ERROR`	The application was closed because the user denied camera permission.
`CAMERA_ERROR`	Camera initialization failed due to a camera device or service error and the user exited the application.
`GENERIC_ERROR`	An unknown error occurred and the flow could not be completed (e.g., network errors).
`ATTEMPTS_EXHAUSTED`	The user is not allowed to retry with the given `partner_session_id`.

Important Notes

⚠️
Do not include status, partner_session_id, or error_code as existing query parameters in your successRedirectionUrl or failureRedirectionUrl. IAB appends these parameters during redirection, and pre-existing parameters with the same names will be overridden.

ℹ️
Redirection URLs are configured via the IAB BE. In rare cases where the IAB frontend cannot reach IAB BE, the redirect may not function correctly.