This is a PHP API client for Onfido's REST API.
We have kept this library as close to the original as possible and so can be used as the documentation states.
In order to run the tests, you must update the AbstractTest file with your api token. The tests are poor as they depend upon data on your Onfido account (e.g. customer ids).
These are the original unit tests that Onfido provided.
You can obtain onfido-php from source
$ git clone https://github.com/onfido/php-onfido.git
or you can install via composer:
$ composer require partfire/onfido
At the beginning, You need is to import the autoload.php file, Initiate the Config, and Set the Token:
require_once('autoload.php');
\Onfido\Config::init()->set_token('YOUR TOKEN');
The applicant endpoint supports two operations - create()
and get()
:
$applicant = new \Onfido\Applicant();
$applicant->first_name = 'John';
$applicant->last_name = 'Smith';
$applicant->email = '[email protected]';
$address1 = new \Onfido\Address();
$address1->postcode = 'abc';
$address1->town = 'London';
$address1->country = 'GBR';
$applicant->addresses = Array($address1);
$response = $applicant->create();
APPLICANT_ID
to be the ID of the Applicants You want to retrieve.
$applicant = (new \Onfido\Applicant())->get(APPLICANT_ID);
->paginate(2, 5)
means to get page #2 where each page has 5 Applicants, Any of both can be null to ignore
\Onfido\Config::init()->set_token('YOUR TOKEN')->paginate(2, 5);
$applicants = (new \Onfido\Applicant())->get();
The documents endpoint supports one operation - upload_for():
$document = new \Onfido\Document();
$document->file_name = 'file.jpg';
$document->file_path = '/path/to/file.jpg';
$document->file_type = 'image/jpg';
$document->type = 'passport';
$document->side = 'front';
$response = $document->upload_for(APPLICANT_ID);
The checks endpoint supports two operations - create_for()
and get()
:
$check = new \Onfido\Check();
$check->type = 'standard';
$report1 = new \Onfido\CheckReport();
$report1->name = 'identity';
$check->reports = Array(
$report1
);
$response = $check->create_for(APPLICANT_ID);
$check = (new \Onfido\Check())->get(APPLICANT_ID, CHECK_ID);
\Onfido\Config::init()->set_token('YOUR TOKEN')->paginate(null, 5);
$checks = (new \Onfido\Check())->get(APPLICANT_ID);
The reports endpoint supports one operation - get()
:
$report = (new \Onfido\Report())->get(CHECK_ID, REPORT_ID);
$report = (new \Onfido\Report())->get(CHECK_ID);
You can get use of the Onfido Address Picker, like:
$address = new \Onfido\AddressPicker();
$address->postcode = 'SW4 6EH';
$addresses = $address->pick();
You will need to have latest version of phpunit installed. Then:
phpunit Applicants.php
will run the tests related to Applicant endpoint operations, and shows the results in a readable way. You can run other tests like: Checks, Documents and Reports.