README

Onfido REST API 的 Composer 库

要求

PHP 5.5

安装

1. 添加到 Composer 文件

{
    "require": {
        "favor/onfido": "dev-master"
    }
}

1. 安装

composer install

使用

几乎所有调用都将通过 Onfido 客户端来生成和更新内容。

$client = new Onfido\RestClient(ONFIDO_TOKEN);

申请人

申请人是 Onfido 中检查和报告的主题。

创建

创建申请人时，唯一必需的字段是 first_name 和 last_name。

$params = array(
    'title' => 'Mr',
    'first_name' => 'Tester',
    'middle_name' => 'Test',
    'last_name' => 'McTesterson',
    'email' => 'test@mail.com',
    'gender' => 'male',
    'dob' => '1990-11-23',
    'telephone' => '123-456-7890',
    'mobile' => '987-654-3210',
    'country' => 'usa',
    'addresses' => array(
        array(
            'flat_number' => '13',
            'building_number' => '2411',
            'street' => 'Main Avenue',
            'sub_street' => null,
            'state' => 'TX',
            'town' => 'Austin',
            'postcode' => '78702',
            'country' => 'usa',
            'start_date' => '1999-02-28',
            'end_date' => null
        )
    ),
    'id_numbers' => array(
        array(
            'type' => 'ssn',
            'value' => '433-54-3937'
        )
    )
);

$applicant = $client->createApplicant($params);

检索

$applicant = $client->retrieveApplicant('1030303-123123-123123');

检查

所有检查都需要在 Onfido 系统中存在申请人。

身份检查

创建

针对美国居民的身份检查需要在申请人记录中包含电子邮件地址、出生日期和社保号码。

$identity_report = $client->runIdentityCheck('1030303-123123-123123');