Skip to main content

Installation

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

Overview​

The Azakaw web SDK allows you to add customer onboarding in your web application using web components. It provides you with a custom element that encapsulates the functionality of the customer onboarding.

Installation​

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

Install the package using npm:

npm install @azakawcompliance/azakaw-web-sdk

Important Note​

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

Prerequisites​

The SDK does not take API credentials. Before you mount it you need a session-id issued by your backend via Session Management — your backend creates the session for the customer and hands the id to the browser.

Basic Setup​

Import the package in your main JavaScript file:

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

Then use the customer onboarding element in your HTML:

<az-customer-onboarding
  session-id="your-session-id"
  host-origin="http://localhost:4200"
  environment="Sandbox"
  region="UAE"
></az-customer-onboarding>

environment and region together select the portal the SDK loads. Both are case-sensitive — see Environment and region.

Next Steps​

After installation, proceed to: