Introduction

The liveness web SDK is a versatile component that allows you to easily handle authentication process in your web application. The purpose of the SDK is to simplify the integration of our clients to the authentication app.

How the SDK works

The main highlights of the SDK are as the following:

The SDK can be easily embedded in any web application as a reusable web component, declared just like any other HTML element. By using the SDK as an embedded component, the entire journey can be handled within your own domain without the need for redirection to a new domain.

With a customised configuration object, you can set up the SDK according to your preferences.

The SDK event broadcast is a useful tool that provides visibility into user activity from the beginning to the end of the journey and allows you to respond to user interactions during the process by implementing a desired event handler.

SDK Integration Guide

Integrating liveness web SDK into your web application is a simple and straightforward process. You can follow the integration steps outlined in the following recipe:

Note: If you are loading your web page inside a React Native WebView, make sure to set the 'allowsInlineMediaPlayback' property to true. This ensures that the iOS camera functions correctly within the WebView. Please note that this property is iOS-specific and is set to false by default. Here’s an example of how to set it in your WebView component:

export default function Index() {
  return (
    <SafeAreaView style={{ flex: 1 }}>
      <WebView
        allowsInlineMediaPlayback={true}
        source={{ uri: '****' }} // replace with your web page URL
      />
    </SafeAreaView>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: '#25292e',
    alignItems: 'center',
    justifyContent: 'center',
  },
  text: {
    color: '#fff',
  },
});

How to initialise the SDK

To initialise the SDK, you can use the LivenessWebSdk.init(config) method, which takes a configuration JSON object as input.

In the config object, you can provide specific values for the properties based on your requirements. Adjust the property names and values accordingly to customise the initialisation of the SDK for your web application.

config (JSON Object): The customised configuration used to initialise the SDK. The schema of the config JSON object is defined as follows:

Logging Event Information

As mentioned, the SDK Event broadcast helps provide visibility into user activity from the beginning to the whole journey and allows you to respond to user interactions during the process by implementing a desired event handler in your code.

The "detail" property of each event provides details about that event. The fields of the "detail" property dispatched by the SDK are as follows:

• type: It specifies the main event types triggered during the verification submission process. You can find a full list of event types in the following table.
• body: This is an optional field that provides additional details about the event type. You can find more information about the body structure in the following table.

• Error Codes

Mobile and Desktop Browser Support

The liveness web SDK supports the following browsers on different platforms:

• iOS: iOS Safari, Chrome and Firefox.
• Android: Chrome, Samsung Internet browser and Firefox.
• Desktop: Chrome, Safari, Firefox

Please ensure that the specified browser versions are met for optimal compatibility and functionality with the SDK.