https://github.com/bytesfield/sabi-customer
A Know Your Customer (KYC) Node JS Package to verify business's customer identity using SMILE IDENTITY, APPRUVE and CREDEQUITY KYC services.
https://github.com/bytesfield/sabi-customer
appruve-service sabi-customer smile smile-identity-service verification
Last synced: 4 months ago
JSON representation
A Know Your Customer (KYC) Node JS Package to verify business's customer identity using SMILE IDENTITY, APPRUVE and CREDEQUITY KYC services.
- Host: GitHub
- URL: https://github.com/bytesfield/sabi-customer
- Owner: bytesfield
- License: mit
- Created: 2021-05-25T17:01:59.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-09T21:26:15.000Z (about 5 years ago)
- Last Synced: 2025-10-02T11:47:52.186Z (9 months ago)
- Topics: appruve-service, sabi-customer, smile, smile-identity-service, verification
- Language: JavaScript
- Homepage:
- Size: 435 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sabi Customer
[](https://badge.fury.io/js/sabi-customer)
[](https://github.com/bytesfield/sabi-customer/blob/main/LICENSE.md)
[](https://scrutinizer-ci.com/g/bytesfield/sabi-customer/build-status/main)
[](https://scrutinizer-ci.com/g/bytesfield/sabi-customer/?branch=main)
[](https://github.com/bytesfield/sabi-customer/issues)
# Description
A Know Your Customer (KYC) Node Js Package to verify business's customer identity using [SMILE IDENTITY](https://docs.smileidentity.com/), [APPRUVE](https://www.appruve.co/) and [CREDEQUITY](https://credequity.com/) KYC services. This service currently support countries like Nigeria(NG), Ghana(GH), Kenya(KE), Uganda(UG).
## Installation
[Node](https://nodejs.org/en/) 13 + required.
To get the latest version of Sabi Customer, simply install it
```bash
npm install sabi-customer
```
## Configuration
Once Sabi-Customer is installed, you will need to add the following credentials gotten from the different KYC service providers to your `.env`. Click on their names it will redirect you to their websites where you can sign up and get there API KEYs.
_If you are using a hosting service like heroku, ensure to add the above details to your configuration variables._
- [SMILE IDENTITY](https://docs.smileidentity.com/)
```javascript
SMILE_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;
SMILE_PARTNER_ID = xxxx;
```
- [APPRUVE](https://www.appruve.co/)
```javascript
APPRUVE_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;
```
- [CREDEQUITY](https://credequity.com/)
```javascript
CREDEQUITY_API_URL = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;
```
## Usage
```javascript
const SabiCustomer = require("sabi-customer");
const sabiCustomer = new SabiCustomer();
```
###### Supported Handlers:
```javascript
SMILE, APPRUVE, CREDEQUITY;
```
_If you want a specific handler to handle your request you can pass a second argument to the verifyID() method as shown below, else ignore it and it will pass through sabi-customer's pipeline and return the result and the pipe that handled it_
_Note all data used here are dummy data, to get test data you can visit the individual KYC service provider's websites and get data to test_
_The implementation is Asynchronous make sure you use async function_
```javascript
const response = await sabiCustomer.verifyID(payload, "SMILE");
console.log(response);
```
### For Nigeria (NG)
#### APPRUVE SERVICE
##### ID Verification
###### Supported ID Types Values:
```javascript
NIN, BVN, DRIVERS_LICENSE, PASSPORT, TIN, VOTER_CARD;
```
```javascript
const payload = {
id: "48126406145",
id_type: "ID_TYPE_VALUE",
country: "NG",
first_name: "Michael",
last_name: "Olugbenga",
middle_name: "Peter",
date_of_birth: "1982-05-20",
};
const response = await sabiCustomer.verifyID(payload);
```
#### SMILE IDENTITY SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
NIN_SLIP, BVN, DRIVERS_LICENSE, CAC, TIN, VOTER_ID;
```
```javascript
const payload = {
id: "48126406145",
id_type: "ID_TYPE_VALUE",
country: "NG",
first_name: "Michael",
last_name: "Olugbenga",
user_id: "USER_UNIQUE_ID",
company: "COMPANY_NAME", //Include this for CAC
};
const response = await sabiCustomer.verifyID(payload);
```
#### CREDEQUITY SERVICE
##### ID Verification
###### Supported ID Types Values:
```javascript
NIN, BVN, DRIVERS_LICENSE;
```
```javascript
const payload = {
id: "00000000000",
id_type: "ID_TYPE",
first_name: "KAYODE",
last_name: "BABATUNDE",
date_of_birth: "24-11-1975",
phone_number: "1234567890",
};
const response = await sabiCustomer.verifyID(payload);
```
### For Ghana (GH)
#### SMILE IDENTITY SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
SSNIT, VOTER_ID, DRIVERS_LICENSE;
```
```javascript
const payload = {
id: "48126406145",
id_type: "ID_TYPE_VALUE",
country: "GH",
first_name: "Michael",
last_name: "Olugbenga",
user_id: "USER_UNIQUE_ID",
};
const response = await sabiCustomer.verifyID(payload);
```
#### APPRUVE SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
SSNIT, TIN, DRIVERS_LICENSE, PASSPORT, VOTER_CARD;
```
```javascript
const payload = {
id: "48126406145", //For TIN change this to tin
id_type: "ID_TYPE_VALUE",
country: "GH",
first_name: "Michael",
last_name: "Olugbenga",
date_of_birth: "24-11-1975",
};
const response = await sabiCustomer.verifyID(payload);
```
### For Kenya (KE)
#### SMILE IDENTITY SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
ALIEN_CARD, NATIONAL_ID, PASSPORT;
```
```javascript
const payload = {
id: "48126406145",
id_type: "ID_TYPE_VALUE",
country: "KE",
first_name: "Michael",
last_name: "Olugbenga",
user_id: "USER_UNIQUE_ID",
};
const response = await sabiCustomer.verifyID(payload);
```
#### APPRUVE SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
NATIONAL_ID, KRA, PASSPORT;
```
```javascript
const payload = {
id: "48126406145", //For KRA Change this to pin
id_type: "ID_TYPE_VALUE",
country: "KE",
first_name: "Michael",
last_name: "Olugbenga",
date_of_birth: "24-11-1975",
};
const response = await sabiCustomer.verifyID(payload);
```
_Credequity not supported for Kenya_
### For South Africa (ZA)
#### SMILE IDENTITY SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
NATIONAL_ID, NATIONAL_ID_NO_PHOTO;
```
```javascript
const payload = {
id: "48126406145",
id_type: "ID_TYPE_VALUE",
country: "ZA",
first_name: "Michael",
last_name: "Olugbenga",
user_id: "USER_UNIQUE_ID",
};
const response = await sabiCustomer.verifyID(payload);
```
_Credequity and Appruve not supported for South Africa_
### For Uganda (UG)
#### APPRUVE SERVICE
##### ID Verification
Supported ID Types Values:
```javascript
TELCO_SUBSCRIBER;
```
```javascript
const payload = {
id: "48126406145",
id_type: "ID_TYPE_VALUE",
country: "UG",
phone: "+256000000003",
};
const response = await sabiCustomer.verifyID(payload);
```
_Credequity and Smile not supported for Uganda_
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email abrahamudele@gmail instead of using the issue tracker.
## Credits
- [Abraham Udele](https://github.com/bytesfield)
Find me on
Twitter.
Linkedin.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.