Integrate via web
Beta

Last updated: June 11, 2025

For Identity Verification and Face Authentication, the applicant can start their journey in your mobile app, mobile website, or desktop website. Checkout.com securely redirects them to the attempt in their mobile browser. After completing the attempt, we redirect the applicant back to your app or website, which is updated in real time.

Set up your redirect integration using any of the following options:

Web redirection – App and website
iframes – App and website
WebView – App only

You can also customize the web user interface (UI), and check which languages are supported.

For web redirection from your app or website, Checkout.com supports the following environments and minimum browser versions:

Chrome 53 or later
Firefox 52 or later
Safari 11.1 or later
Edge 16 or later
Opera 58 or later

After you create an attempt and receive the attempt URL, pass the URL to your web app and add it as a link:


1<a href="`${verificationUrl}`"></a>

Information

See an example web integration on our Identity Verification GitHub repository.

When the applicant completes or drops out of the attempt, they are redirected to your return page at the redirect_url you provided when you created the attempt.

The redirect URL includes:

The check ID
The attempt status
The response code if the check was unsuccessful


1https://your-redirect-url.com?id=idv_01h2623ysfkhpn7czed0bw8fd6&event=identity_verification_capture_aborted&response_code=61101

For iframe (or inline frame) redirection from your app or website, use the following SDK:

Include the SDK as a script tag:


1<script
2  src="https://cdn.ubble.ai/iframe-sdk-1.0.0.js"
3  type="application/javascript"
4></script>

Add a global method called onUbbleReady to the page that is triggered when the SDK is loaded:


1function onUbbleReady() {
2
3}

Initialize a new IDV object:


1function onUbbleReady() {
2  const ubbleIDV = new Ubble.IDV(document.getElementById("ubble"), options);
3}

Occurs when the applicant completes the attempt


1{
2  "event": "capture_completion",
3  "redirectUrl": "https://your-redirect-url.com?id=<verification id>&event=identity_verification_capture_completed"
4}

Occurs when the applicant refuses to start the attempt


1{
2  "event": "capture_refusal",
3  "responseCode": 63001,
4  "redirectUrl": "https://your-redirect-url.com?id=<verification id>&event=identity_verification_capture_refused"
5}

Occurs when the applicant drops out of the attempt


1{
2  "event": "capture_abortion",
3  "responseCode": 61111,
4  "redirectUrl": "https://your-redirect-url.com?id=<verification id>&event=identity_verification_capture_aborted&response_code=63001"
5}

Occurs when the attempt URL expires


1{
2  "event": "expiration",
3  "redirectUrl": "https://your-redirect-url.com?id=<identity verification id>&event=identity_verification_link_expired&response_code=63001"
4}

When the applicant completes or drops out of the attempt, use the destroy() method to return them to your return page redirect_url:


1const ubbleIDV = new Ubble.IDV("id", {
2  events: {
3    onComplete(event) {
4      console.log(`Done with ubble flow: ${event}`);
5      ubbleIDV.destroy();
6    },
7  },
8});


1const ubbleIDV = new Ubble.IDV("idv", {
2  width: "500",
3  height: "600",
4  allowCamera: true,
5  verificationUrl: "https://idv.checkout.com/4hryu5cei5",
6  events: {
7    onComplete(event) {
8      ubbleIDV.destroy();
9    },
10    onAbort(event) {
11      ubbleIDV.destroy();
12    },
13    onExpired(event) {
14      ubbleIDV.destroy();
15    }
16    onRefused(event) {
17      ubbleIDV.destroy();
18    }
19  },
20});

Note

If you encounter issues, ensure that:

You included a semicolon in the Content-Security-Policy: frame-src https://*.domain_name.fr; header.
The applicant gave permission to use their mobile device camera.

If the applicant starts the journey in your mobile app, you can redirect them to the attempt using WebView for a smooth, integrated experience. WebView redirection is supported by the following platforms:

Android
iOS 13 or later – Via WebRTC running inside a WKWebView
iOS 12 or older – Via the Safari browser by passing the verificationUrl to the UIApplication.open() method in your app code
React Native
Flutter – Using the flutter_inappwebview dependency, with the WebRTC API so Identity Verification can launch a video stream

For a WebView integration, you must provide a deeplink to redirect the applicant on your mobile app.

Information

See example WebView integrations for each platform on our Identity Verification GitHub repository.

When the applicant completes or drops out of the attempt, they're redirected to your return page at the redirect_url you provided when you created the attempt.

The redirect URL includes:

The check ID
The attempt status
The response code if the check was unsuccessful


1https://your-redirect-url.com?id=idv_01h2623ysfkhpn7czed0bw8fd6&event=identity_verification_capture_aborted&response_code=61101

You can customize the following elements of the web UI:

Logo
Colors
Fonts
Button radius
Message prompt text

Information

Use the customization tool to create the HTML to send to your account manager or [email protected].

The UI supports the following languages:

Chinese (simplified)
Dutch
English (UK)
English (US)
Estonian
Finnish
French
German
Italian
Latvian
Polish
Portuguese
Romanian
Slovak
Spanish
Swedish

Integrate via web
Beta

How it works

Web redirection

Information

Iframe redirection

Iframe SDK

API

Events

Methods

Full example

Note

WebView redirection

Information

Customize the user interface

Information

Supported languages