pipwave-ekyc-sdk v2.0.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.

Upgrading to version 2

Attention users! Please note that the following methods in the SDK have been renamed for better clarity and consistency:

• uploadDoc is now renamed to uploadId
• viewResult is now renamed to viewIdResult
• updateForm is now renamed to updateIdForm

Please update your codebase accordingly to reflect these changes. Thank you for your understanding and cooperation.

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

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 3 vital verification types: Identity Document, Selfie, and Credit Card.

M/O/C:

• M: Mandatory
• C: Required when
• O: Optional

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
• cc
• poa

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 UploadIdParam object as an argument to the uploadId() 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.uploadId(param);

UploadIdParam

Output

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 Id Verification Results

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

const result = await pwInstance.viewIdResult();

Output

IdResults

4. Update Id Verification Result

After retrieving the id verification results, you can update them using the updateIdForm() method. Pass a properly configured UpdateIdFormParam 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.updateIdForm(param);

UpdateIdFormParam

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

6. Upload Credit card

To upload an credit card, just provide a properly configured UploadCcParam object as an argument to the uploadCc() method. Here's how:

const param = {
	front_doc_base64: YOUR_FRONT_DOC;
	back_doc_base64: YOUR_BACK_DOC;
}
const result = await pwInstance.uploadCc(param);

UploadCcParam

Output

7. Retrieve Credit Card Verification Results

After completing the upload credit card verification process, retrieve the credit card verification results using the viewCcResult() method. No arguments are required for this method:

const result = await pwInstance.viewCcResult();

Output

CcResults

8. Update Credit Card Verification Result

After retrieving the credit card verification results, you can update them using the updateCcForm() method. Pass a properly configured UpdateCcFormParam object to update the results:

const param = {
	full_name: YOUR_FULL_NAME,
	cc_number_first_6: YOUR_CC_FIRST_6_NO,
	cc_number_last_4: YOUR_CC_LAST_4_NO,
	doe_year: YOUR_CC_EXPIRY_YEAR,
	doe_month: YOUR_CC_EXPIRY_MONTH,
 };
const result = await pwInstance.updateCcForm(param);

UpdateCcFormParam

Output

9. Upload Proof Of Address

To upload proof of address, just provide a properly configured UploadPoaParam object as an argument to the uploadPoa() method. Here's how:

const param = { poa_base64: YOUR_DOC }
const result = await pwInstance.uploadCc(param);

UploadPoaParam

Output

10. Retrieve Proof Of Address Verification Results

After completing the upload proof of address verification process, retrieve the proof of address verification results using the viewPoaResult() method. No arguments are required for this method:

const result = await pwInstance.viewPoaResult();

Output

PoaResults

11. Update Proof Of Address Result

After retrieving the proof of address results, you can update them using the updatePoaForm() method. Pass a properly configured UpdatePoaFormParam object to update the results:

const param = {
	receiver_name: RECEIVER_NAME,
	receiver_address: RECEIVER_ADDRESS,
	receiver_city: RECEIVER_CITY,
	...
};
const result = await pwInstance.updatePoaForm(param);

UpdatePoaFormParam

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.