andrevalentin / laravel-onfido
Onfido PHP 客户端的 Laravel 包装器
v5.1.0
2022-02-17 15:03 UTC
Requires
- php: ^7.1.3 || ^8.0
- illuminate/support: ^8.0
- onfido/api-php-client: ^5.2 || ^6.0
Requires (Dev)
- graham-campbell/testbench: ^5.5
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-17 20:53:20 UTC
README
Onfido PHP API 客户端的 Laravel 包装器。
安装
使用 composer 安装
composer require andrevalentin/laravel-onfido
在 Laravel 应用的 app.php 文件中,在 providers 数组下添加 Service Provider
'providers' => [
...,
AndreValentin\Onfido\OnfidoServiceProvider::class,
],
同样,在 aliases 数组下添加 Class Alias
'aliases' => [
...,
'Onfido' => AndreValentin\Onfido\Facades\Onfido::class,
],
在您的 config 目录中添加 onfido.php 配置文件,内容如下
<?php
return [
"api_key" => env("ONFIDO_API_KEY", "api_testing.default"),
];
配置
请记住,将您的 Onfido API 密钥添加到 .env
文件中。
ONFIDO_API_KEY=api_sandbox.ABC...
使用方法
我总是鼓励每个人使用官方 PHP 包作为参考,这只是一个 Laravel 包装器。然而,我会提供一个创建申请人的示例。
记住在文件顶部添加 use Onfido;
来导入 Onfido Facade。
创建申请人和发送检查
$applicant = Onfido::createApplicant([
'first_name' => 'John',
'last_name' => 'Doe',
'email' => 'johndoe@example.org',
]);
$onfido_check = Onfido::createCheck([
'applicant_id' => $applicant['id'],
'report_names' => ['right_to_work'],
'applicant_provides_data' => true,
]);
以上是创建申请人和通过 Onfido 发送工作许可检查所需的所有内容。
然后您可以将检查结果作为数组进行查询
$applicant['id']
$onfido_check['id']
$onfido_check['status']
$onfido_check['form_uri']
要查看所有可能的返回数据,请查看官方 PHP 包文档,链接为 https://github.com/onfido/api-php-client