A Composer library for Onfido's REST API
PHP 5.5
- Add to Composer file
{
"require": {
"favor/onfido": "dev-master"
}
}- Install
composer install
Almost all calls will go through the Onfido client to generate and update content.
$client = new Onfido\RestClient(ONFIDO_TOKEN);Applicants are the subjects of checks and reports in Onfido.
The only required fields when creating an applicant are first_name and 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');All checks require the existence of an applicant in the Onfido system.
Identity checks that are run on U.S. residents require the applicant record to have an e-mail address, date of birth, and a social security number.
$identity_report = $client->runIdentityCheck('1030303-123123-123123');