Skip to main content

Installation

This guide will help you integrate the azakaw-liveness Web SDK into your web application.

Overview​

The azakaw-liveness Web SDK allows you to add customer liveness verification to your web application using web components. It provides a custom element that encapsulates the customer liveness functionality.

Installation​

The SDK is published on npm: @azakawcompliance/azakaw-liveness-sdk.

Install the package using npm:

npm install @azakawcompliance/azakaw-liveness-sdk

Important Note​

The web components are registered on the web page itself, so the library must be imported on your website before using it in your code.

Prerequisites​

The SDK does not accept AppSecret. Before you mount it you need a session-id issued by your backend via the Standalone Session flow — your backend mints the session and hands the id to the browser, and the SDK validates it server-side before starting capture.

Basic Setup​

Import the package in your main JavaScript file:

import '@azakawcompliance/azakaw-liveness-sdk';

In the HTML file you can then use the custom <azakaw-liveness> element, for example:

<azakaw-liveness
  id="azakaw-liveness"
  session-id="YOUR_SESSION_ID"
  host-origin="YOUR_HOST_ORIGIN"
  environment="Sandbox"
></azakaw-liveness>

Next Steps​

After installation, proceed to: