worksome/laravel-onfido

Onfido PHP客户端的Laravel包装器

v6.0.0 2024-08-15 08:28 UTC

This package is auto-updated.

Last update: 2024-09-15 08:39:21 UTC


README

这是一个Laravel包装器,用于Onfido PHP API客户端。

安装

使用composer安装

composer require worksome/laravel-onfido

使用以下命令发布配置文件

php artisan vendor:publish --provider "Worksome\Onfido\OnfidoServiceProvider"

配置

请记住将您的Onfido API密钥添加到您的.env文件中。

ONFIDO_API_KEY=api_sandbox.ABC...

使用方法

我总是鼓励每个人使用官方的PHP包作为参考,这只是一个Laravel包装器。然而,我会提供一个创建申请人的例子。

请记得在文件顶部添加use Worksome\Onfido\Facades\Onfido;来导入Onfido门面。

创建申请人和发送检查

use Onfido\Model\ApplicantBuilder;
use Onfido\Model\CheckBuilder;
use Worksome\Onfido\Facades\Onfido;

$applicant = Onfido::createApplicant(new ApplicantBuilder([
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => 'johndoe@example.org',
]));

$onfidoCheck = Onfido::createCheck(new CheckBuilder([
    'applicant_id' => $applicant['id'],
    'report_names' => ['right_to_work'],
    'applicant_provides_data' => true,
]));

以上是创建申请人和通过Onfido向申请人发送工作权检查所需的所有步骤。

然后您可以咨询申请人的结果或检查

/** @var \Onfido\Model\ApplicantResponse $applicant */
$applicant->getId();

/** @var \Onfido\Model\CheckResponse $onfidoCheck */
$onfidoCheck->getId();

// The responses can also be accessed as an arrayable.
$applicant['id'];
$onfidoCheck['id'];
$onfidoCheck['status'];
$onfidoCheck['form_uri'];

要查看所有可能的返回数据,请参阅官方PHP包文档