bytesfield / simple-kyc
一款用于了解客户(KYC)的PHP包
v1.0.1
2021-06-15 09:06 UTC
Requires
- php: >=7.4
- guzzlehttp/guzzle: ^7.0.1
- hassankhan/config: 9999999-dev
- mpociot/pipeline: 9999999-dev
Requires (Dev)
- phpunit/phpunit: >=7
README
Simple KYC
描述
一个用于验证企业客户身份的KYC PHP包,使用SMILE IDENTITY、APPRUVE和CREDEQUITY KYC服务。此服务目前支持尼日利亚(NG)、加纳(GH)、肯尼亚(KE)、乌干达(UG)等国家。
安装
需要PHP 7.4+和Composer。
要获取Simple-Kyc的最新版本,只需要求即可。
composer require bytesfield/simple-kyc
或者将以下行添加到您的composer.json文件的require块中。
"bytesfield/simple-kyc": "1.0.*"
然后,您需要运行composer install或composer update来下载它并更新自动加载器。
配置
安装simple-kyc后,您需要将以下从不同的KYC服务提供商获得的凭据添加到您的.env文件中。点击它们的名称,将重定向到他们的网站,在那里您可以注册并获取他们的API密钥。
如果您使用的是像heroku这样的托管服务,请确保将上述详细信息添加到您的配置变量中。
SMILE_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx; SMILE_PARTNER_ID = xxxx;
- APPRUVE 必需
APPRUVE_API_KEY = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;
- CREDEQUITY 可选
CREDEQUITY_API_URL = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx;
用法
require 'vendor/autoload.php'; //Exclude this when using Frameworks like Laravel etc. use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $response = $simpleKyc->verifyId($payload = []);
支持的处理器
SMILE, APPRUVE, CREDEQUITY;
请求将通过simple-kyc的管道传递,并返回结果和处理的验证请求的管道
注意这里使用的数据都是示例数据,要获取测试数据,您可以访问单个KYC服务提供商的网站并获取数据进行测试
针对尼日利亚(NG)
APPRUVE服务
身份验证
支持的ID类型值
NIN, BVN, DRIVERS_LICENSE, PASSPORT, TIN, VOTER_CARD;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $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', ]; $response = $simpleKyc->verifyId($payload);
SMILE IDENTITY服务
身份验证
支持的ID类型值
NIN_SLIP, BVN, DRIVERS_LICENSE, CAC, TIN, VOTER_ID;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $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 ]; $response = $simpleKyc->verifyId($payload);
CREDEQUITY服务
身份验证
支持的ID类型值
NIN, BVN, DRIVERS_LICENSE;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '00000000000', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'NG', 'first_name' => 'KAYODE', 'last_name' => 'BABATUNDE', 'date_of_birth' => '24-11-1975', 'phone_number' => '1234567890', ]; $response = $simpleKyc->verifyId($payload);
针对加纳(GH)
SMILE IDENTITY服务
身份验证
支持的ID类型值
SSNIT, VOTER_ID, DRIVERS_LICENSE;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '48126406145', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'GH', 'first_name' => 'Michael', 'last_name' => 'Olugbenga', 'user_id' => 'USER_UNIQUE_ID', ]; $response = $simpleKyc->verifyId($payload);
APPRUVE服务
身份验证
支持的ID类型值
SSNIT, TIN, DRIVERS_LICENSE, PASSPORT, VOTER_CARD;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '48126406145', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'GH', 'first_name' => 'Michael', 'last_name' => 'Olugbenga', 'date_of_birth': '24-11-1975', ]; $response = $simpleKyc->verifyId($payload);
针对肯尼亚(KE)
SMILE IDENTITY服务
身份验证
支持的ID类型值
ALIEN_CARD, NATIONAL_ID, PASSPORT;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '48126406145', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'KE', 'first_name' => 'Michael', 'last_name' => 'Olugbenga', 'user_id' => 'USER_UNIQUE_ID', ]; $response = $simpleKyc->verifyId($payload);
APPRUVE服务
身份验证
支持的ID类型值
NATIONAL_ID, KRA, PASSPORT;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '48126406145', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'KE', 'first_name' => 'Michael', 'last_name' => 'Olugbenga', 'date_of_birth' => "24-11-1975", ]; $response = $simpleKyc->verifyId($payload);
Credequity不支持肯尼亚
针对南非(ZA)
SMILE IDENTITY服务
身份验证
支持的ID类型值
NATIONAL_ID, NATIONAL_ID_NO_PHOTO;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '48126406145', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'ZA', 'first_name' => 'Michael', 'last_name' => 'Olugbenga', 'user_id' => "USER_UNIQUE_ID", ]; $response = $simpleKyc->verifyId($payload);
Credequity和Appruve不支持南非
针对乌干达(UG)
APPRUVE服务
身份验证
支持的ID类型值
TELCO_SUBSCRIBER;
require 'vendor/autoload.php'; use Bytesfield\SimpleKyc\SimpleKyc; $simpleKyc = new SimpleKyc(); $payload = [ 'id' => '48126406145', 'id_type' => 'ID_TYPE_VALUE', 'country' => 'UG', 'phone_number' => '+256000000003', ]; $response = $simpleKyc->verifyId($payload);
Credequity和Smile不支持乌干达
更新日志
有关最近更改的更多信息,请参阅更新日志。
贡献
请参阅贡献以获取详细信息。
安全
如果您发现任何安全问题,请通过电子邮件abrahamudele@gmail而不是使用问题跟踪器。
致谢
- Abraham Udele
在Twitter上找到我。Linkedin。
许可
MIT许可证(MIT)。有关更多信息,请参阅许可文件。
