{"id":44638344,"url":"https://github.com/bytesfield/sabi-customer","last_synced_at":"2026-02-14T18:06:20.977Z","repository":{"id":65492256,"uuid":"370768573","full_name":"bytesfield/sabi-customer","owner":"bytesfield","description":"A Know Your Customer (KYC) Node JS Package to verify business's customer identity using SMILE IDENTITY, APPRUVE and CREDEQUITY KYC services.","archived":false,"fork":false,"pushed_at":"2021-06-09T21:26:15.000Z","size":445,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-02T11:47:52.186Z","etag":null,"topics":["appruve-service","sabi-customer","smile","smile-identity-service","verification"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bytesfield.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-25T17:01:59.000Z","updated_at":"2025-03-11T17:12:01.000Z","dependencies_parsed_at":"2023-01-25T19:35:15.543Z","dependency_job_id":null,"html_url":"https://github.com/bytesfield/sabi-customer","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/bytesfield/sabi-customer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesfield%2Fsabi-customer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesfield%2Fsabi-customer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesfield%2Fsabi-customer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesfield%2Fsabi-customer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bytesfield","download_url":"https://codeload.github.com/bytesfield/sabi-customer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesfield%2Fsabi-customer/sbom","scorecard":{"id":260393,"data":{"date":"2025-08-11","repo":{"name":"github.com/bytesfield/sabi-customer","commit":"8a78d914b04cc2b0b4bb03fc10f2e4f78cd27170"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/26 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"26 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T10:42:55.450Z","repository_id":65492256,"created_at":"2025-08-17T10:42:55.450Z","updated_at":"2025-08-17T10:42:55.450Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29452092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T15:52:44.973Z","status":"ssl_error","status_checked_at":"2026-02-14T15:52:11.208Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appruve-service","sabi-customer","smile","smile-identity-service","verification"],"created_at":"2026-02-14T18:06:20.916Z","updated_at":"2026-02-14T18:06:20.970Z","avatar_url":"https://github.com/bytesfield.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"/images/preview.png\" alt=\"Sweet Pipeline Preview\"\u003e\u003c/p\u003e\n\n# Sabi Customer\n\n[![npm version](https://badge.fury.io/js/sabi-customer.svg)](https://badge.fury.io/js/sabi-customer)\n[![GitHub license](https://img.shields.io/github/license/bytesfield/sabi-customer)](https://github.com/bytesfield/sabi-customer/blob/main/LICENSE.md)\n[![Build Status](https://scrutinizer-ci.com/g/bytesfield/sabi-customer/badges/build.png?b=main)](https://scrutinizer-ci.com/g/bytesfield/sabi-customer/build-status/main)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bytesfield/sabi-customer/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/bytesfield/sabi-customer/?branch=main)\n[![GitHub issues](https://img.shields.io/github/issues/bytesfield/sabi-customer)](https://github.com/bytesfield/sabi-customer/issues)\n\n# Description\n\nA 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).\n\n## Installation\n\n[Node](https://nodejs.org/en/) 13 + required.\n\nTo get the latest version of Sabi Customer, simply install it\n\n```bash\nnpm install sabi-customer\n```\n\n## Configuration\n\nOnce 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.\n\n_If you are using a hosting service like heroku, ensure to add the above details to your configuration variables._\n\n- [SMILE IDENTITY](https://docs.smileidentity.com/) \u003cbr/\u003e\n\n```javascript\nSMILE_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;\nSMILE_PARTNER_ID = xxxx;\n```\n\n- [APPRUVE](https://www.appruve.co/) \u003cbr/\u003e\n\n```javascript\nAPPRUVE_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;\n```\n\n- [CREDEQUITY](https://credequity.com/) \u003cbr/\u003e\n\n```javascript\nCREDEQUITY_API_URL = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;\n```\n\n## Usage\n\n```javascript\nconst SabiCustomer = require(\"sabi-customer\");\n\nconst sabiCustomer = new SabiCustomer();\n```\n\n###### Supported Handlers:\n\n```javascript\nSMILE, APPRUVE, CREDEQUITY;\n```\n\n_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_\n\n_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_\n\n_The implementation is Asynchronous make sure you use async function_\n\n```javascript\nconst response = await sabiCustomer.verifyID(payload, \"SMILE\");\n\nconsole.log(response);\n```\n\n### For Nigeria (NG)\n\n#### APPRUVE SERVICE\n\n##### ID Verification\n\n###### Supported ID Types Values:\n\n```javascript\nNIN, BVN, DRIVERS_LICENSE, PASSPORT, TIN, VOTER_CARD;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\",\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"NG\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  middle_name: \"Peter\",\n  date_of_birth: \"1982-05-20\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n#### SMILE IDENTITY SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nNIN_SLIP, BVN, DRIVERS_LICENSE, CAC, TIN, VOTER_ID;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\",\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"NG\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  user_id: \"USER_UNIQUE_ID\",\n  company: \"COMPANY_NAME\", //Include this for CAC\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n#### CREDEQUITY SERVICE\n\n##### ID Verification\n\n###### Supported ID Types Values:\n\n```javascript\nNIN, BVN, DRIVERS_LICENSE;\n```\n\n```javascript\nconst payload = {\n  id: \"00000000000\",\n  id_type: \"ID_TYPE\",\n  first_name: \"KAYODE\",\n  last_name: \"BABATUNDE\",\n  date_of_birth: \"24-11-1975\",\n  phone_number: \"1234567890\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n### For Ghana (GH)\n\n#### SMILE IDENTITY SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nSSNIT, VOTER_ID, DRIVERS_LICENSE;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\",\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"GH\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  user_id: \"USER_UNIQUE_ID\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n#### APPRUVE SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nSSNIT, TIN, DRIVERS_LICENSE, PASSPORT, VOTER_CARD;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\", //For TIN change this to tin\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"GH\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  date_of_birth: \"24-11-1975\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n### For Kenya (KE)\n\n#### SMILE IDENTITY SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nALIEN_CARD, NATIONAL_ID, PASSPORT;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\",\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"KE\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  user_id: \"USER_UNIQUE_ID\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n#### APPRUVE SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nNATIONAL_ID, KRA, PASSPORT;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\", //For KRA Change this to pin\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"KE\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  date_of_birth: \"24-11-1975\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n_Credequity not supported for Kenya_\n\n### For South Africa (ZA)\n\n#### SMILE IDENTITY SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nNATIONAL_ID, NATIONAL_ID_NO_PHOTO;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\",\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"ZA\",\n  first_name: \"Michael\",\n  last_name: \"Olugbenga\",\n  user_id: \"USER_UNIQUE_ID\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n_Credequity and Appruve not supported for South Africa_\n\n### For Uganda (UG)\n\n#### APPRUVE SERVICE\n\n##### ID Verification\n\nSupported ID Types Values:\n\n```javascript\nTELCO_SUBSCRIBER;\n```\n\n```javascript\nconst payload = {\n  id: \"48126406145\",\n  id_type: \"ID_TYPE_VALUE\",\n  country: \"UG\",\n  phone: \"+256000000003\",\n};\n\nconst response = await sabiCustomer.verifyID(payload);\n```\n\n_Credequity and Smile not supported for Uganda_\n\n### Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n### Security\n\nIf you discover any security related issues, please email abrahamudele@gmail instead of using the issue tracker.\n\n## Credits\n\n- [Abraham Udele](https://github.com/bytesfield) \u003cbr/\u003e\n  Find me on \u003cbr/\u003e\n  \u003ca href=\"https://twitter.com/SaintAbrahams/\"\u003eTwitter.\u003c/a\u003e \u003cbr/\u003e\n  \u003ca href=\"https://www.linkedin.com/in/abraham-udele-246003130/\"\u003eLinkedin.\u003c/a\u003e\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytesfield%2Fsabi-customer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytesfield%2Fsabi-customer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytesfield%2Fsabi-customer/lists"}