pipwave-ekyc-sdk v1.2.0

Project Name

Pipwave eKYC SDK for Javascript

Description

Welcome to the Pipwave eKYC SDK for JavaScript! This readme serves as your comprehensive guide to seamlessly integrate eKYC into your client app. Explore the Pipwave eKYC SDK's structure, delve into its extra features, and smoothly follow the installation process.

Implementing eKYC in your client app is simpler than ever. Just upload identity documents, submit a selfie, and effortlessly retrieve or update verification results.

Installation

Begin your journey with the Pipwave eKYC SDK using either the Npm or Yarn package manager.

Npm To install the Pipwave eKYC SDK via npm, ensure Node.js is on your system, and execute this command:

 $ npm install pipwave-ekyc-sdk

Yarn To install the SDK with Yarn, execute this command:

 $ yarn add pipwave-ekyc-sdk

Alternatively, if you prefer not to use a package manager, you can manually download the latest Pipwave eKYC SDK for JavaScript from the provided repository link:

• https://github.com/...

For manual download, include the SDK in your project using this script tag:

<script src="/your-own-path-to-sdk/PwEkyc.min.js"></script>

Usage

Kickstart your eKYC journey with the Pipwave eKYC SDK by initializing it at the outset of your project. All that's required is your Access Token to get started. Here's how:

import { PWSDK } from "pw-ekyc-web-sdk";

const pwInstance = new PWSDK();
await pwInstance.init(YOUR_ACCESS_TOKEN)

SDK Documentation

Once the Pipwave eKYC SDK is initialized, you can unlock its full potential by making use of its properties and functionalities. The SDK supports two vital verification types: Identity Document and Selfie.

Properties

1. Verification Types

Retrieve the verification types which a user requires to perform eKYC on, by using the following code:

const types = pwInstance.verificationTypes

Output

The result is an array of string with the following possible values:

• national_identity_document
• selfie

2. Default Issuing Country

Retrieve the default country using the following code:

const country = pwInstance.defaultCountry

Output

The result is a Country object with the following properties: | Property | Description | |--|--| | isocode | Country code in ISO2 format (Example: my, id) | | name | Full name of Country (Example: Malaysia, Indonesia)_ |

3. Issuing Country List

Retrieve all issuing countries in ISO2 format:

const issuingCountries = pwInstance.issuingCountries

Output

The result is an array of Country objects. Refer to the Country for more details.

4. Full Country List

Retrieve all countries in ISO2 format:

const countries = pwInstance.countries

Output

The result is an array of Country objects. Refer to the Country for more details.

Methods

1. Upload Identity Document

To upload an identity document, just provide a properly configured UploadDocParam object as an argument to the uploadDoc() method. Here's how:

const param = {
	front_doc_base64: YOUR_FRONT_DOC;
	back_doc_base64: YOUR_BACK_DOC;
	doc_type: YOUR_DOC_TYPE;
	issuing_country: YOUR_COUNTRY_ISO;
}
const result = await pwInstance.uploadDoc(param);

UploadDocParam

Output

* For available issuing countries, please refer to the default issuing country and issuing country list. These resources will provide you with comprehensive information on the valid options you can use when specifying the issuing country** for your identity documents.

2. Upload Selfie

To upload a selfie, provide a properly configured UploadSelfieParam object as an argument to the uploadSelfie() method:

const param = {
	selfie_base64: YOUR_SELFIE;
	liveness_score: YOUR_LIVENESS_SCORE;
}
const result = await pwInstance.uploadSelfie(param);

UploadSelfieParam

Output

3. Retrieve Verification Results

After completed the Upload Verification process, retrieve the verification results using the viewResult() method. No arguments are required for this method:

const result = await pwInstance.viewResult();

Output

DocResults

*** For available states and countries, please refer to the state/region list and country list. These resources will provide you with comprehensive information on the valid options you can use when specifying the state and country.

4. Update Verification Result

After retrieving the verification results, you can update them using the updateForm() method. Pass a properly configured UpdateFormParam object to update the results:

const param = {
	full_name: YOUR_FULL_NAME,
	id_number: YOUR_ID_NUMBER,
	date_of_birth: YOUR_DATE_OF_BIRTH,
	address: YOUR_ADDRESS,
	...
};
const result = await pwInstance.updateForm(param);

UpdateFormParam

*** Either full_name is required, or both given_name and surname are required.

Output

5. Retrieve State / Region List

Retrieve the states by passing the country code in ISO2 format as an argument to the fetchStates() method:

const states = await pwInstance.fetchStates(YOUR_COUNTRY_ISO);

Output

Acknowledgements

We extend our gratitude to the following open-source projects that greatly contributed to the development of the Pipwave eKYC SDK: webpack, axios, jwt-decode

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