pipwave-ekyc-uikit v1.3.3

pipwave ekyc uikit

Overview

Pipwave ekyc uikit provides a predesigned graphical user interface(GUI) for user to undergo the electronic know your customer (eKYC) process. User may need to submit their identity card, driving license, passport and selfie throughout the process.

The pipwave ekyc uikit offers a number of benefits to help you create the best identity verification experience for your customers:

• Predesigned UI to help user go through the eKYC process for card id and selfie from start to finish.
• Easy to integrate with user own application or web app.
• The images will be uploaded to pipwave service, thus simplifying the integration process.

Installation

Import the library

To install the package:

• npm install pw-ekyc-uikit

Initializing the HTML

You need to provide one html div element along with id attributes

<div id="pw-sdk-container"></div>

Initializing Javascript

Add the scripts below to your project, to start render the uikit. The script first initialized the uikit, then call the init method and passed in an object at the first init function parameter. The object requires three key to be passed in as listed below:

target: The id of the container that will be used to display the ekyc accessToken: The accessToken for the user that need to undergo the ekyc process displayMode: To determine the display of the ekyc gui. Supported value is 'in-page' and 'hpp'. Default: 'in-page'

import PWUISDK from 'pipwave-ekyc-uikit';

const pw = new PWUISDK()
pw.init({
  target: 'pw-sdk-container',
  accessToken: //<AccessToken>
  displayMode: //'in-page' | 'hpp'
})

onSuccess {Function} optional

Call back that fires when the eKYC process is done.

Example onSuccess callBack:

pw.onSuccess(() => {
  // do your own handling here
});

onFailed {Function} optional

Call back that fires when the eKYC process is failed due to maximum number attempts reached.

Example onFailed callBack:

pw.onFailed((err) => {
  // do your own handling here
});

onClose {Function} optional

Call back that fires when the eKYC process is closed

Example onClose callBack:

pw.onClose(() => {
  // do your own handling here
});

Configuration

Installation on Angular Base Project

For Angular-based projects, you'll need to include the face-api.js library in your project's angular.json configuration:

"architect": {
  "build": {
    "options": {
      "scripts": ["./node_modules/face-api.js/dist/face-api.min.js"]
    }
   }
}

Acknowledgements

We extend our gratitude to the following open-source projects that greatly contributed to the development of the Pipwave Ekyc Uikit: pipwave-ekyc-sdk,webpack, face-api.js, moment, pikaday

Thank you to these remarkable projects and their dedicated teams for making our Uikit possible. Your efforts are truly appreciated.