Face Liveness detection is one of the key requirements today leveraged by Banks, Fintechs and Regulated Entities (REs) to ascertain the identity of an individual. This document gives a way to integrate Bureau's Face Liveness detection as part of the Web Application flow using Bureau's JS SDK for Face Liveness.

This Web SDK provides a set of components for JavaScript applications to capture selfie photos for identity verification.

The SDK offers several benefits to help you create the best identity verification experience for your customers:

Carefully designed UI to guide your customers through the entire photo capture process
Modular design to help you seamlessly integrate the photo process into your application flow

Integration

The following content assumes you're using Bureau's APIv2 version for backend calls.

Obtain a clientID Token: To start integrating, you'll need a clientID. To obtain the clientID, contact us at [email protected]
Import the library: Within the HTML, the library can be included as a regular script tag

<script src="<https://liveness.app.bureau.id/static/js/main.js"></script>

If you are using our Sandbox environment, modify the script as shown below.

<script src="<https://liveness.app.stg.bureau.id/static/js/main.js"></script>

An empty HTML element at the bottom of the page can be added for the SDK interface to mount itself on

<div id="bureau-mount"></div>

Initialize the SDK

The SDK can be initialized using the SDK token

window.BureauFacelivenessSDK.init({
  clientId: '<SDK_clientID>',
  container: 'bureau-mount',
  redirectURL: ''
});

Parameter	Format	Notes
clientID	string	required The Web SDK client ID which will be required to initialize the SDK
container	string	required ID of the container element that the UI will mount to. This must be an empty element.
redirectURL	string	required A redirect URL to be passed once the operation is successful.

Typescript support and SDK Size

TypeScript is officially supported, providing typings for:

init() method
The GZip version of SDK is around 392KB

Browser Compatibility

Chrome	Firefox	Safari
Compatible with the latest release	Compatible with the latest release	Compatible with the latest release
M-Web, Android	M-Web, Android	MacOS

Test

You can check out our Bureau Demo Application for Liveness here: https://liveness.app.bureau.id/

To test this SDK locally make sure the HTML file is hosted on a server.

HTML file must be served on a server for testing. It will not work if you try to open the HTML file directly. Here is a simple guide to serve HTML files using Node.js.