https://github.com/onfido/onfido-php
PHP library for the Onfido API
https://github.com/onfido/onfido-php
onfido onfido-api php
Last synced: 5 months ago
JSON representation
PHP library for the Onfido API
- Host: GitHub
- URL: https://github.com/onfido/onfido-php
- Owner: onfido
- License: mit
- Created: 2017-01-31T16:48:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-10-17T14:16:28.000Z (9 months ago)
- Last Synced: 2026-01-14T01:04:14.231Z (6 months ago)
- Topics: onfido, onfido-api, php
- Language: PHP
- Homepage:
- Size: 2 MB
- Stars: 20
- Watchers: 22
- Forks: 27
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Onfido PHP Library
The official PHP library for integrating with the Onfido API.
Documentation can be found at .
This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
## Installation & Usage
### Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
[](https://badge.fury.io/ph/onfido%2Fonfido-php)
### Installation
#### Composer
To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/onfido/onfido-php.git"
}
],
"require": {
"onfido/onfido-php": "*@dev"
}
}
```
Then run `composer install`
#### Manual Installation
Download the files and include `autoload.php`:
```php
setApiToken($_ENV['ONFIDO_API_TOKEN']);
$configuration->setRegion(Onfido\Region::EU); // Supports `Region::EU`, `Region::US`, and `Region::CA`
$onfidoApi = new Onfido\Api\DefaultApi(
new \GuzzleHttp\Client([
'timeout' => 30,
'connect_timeout' => 30,
'read_timeout' => 30
]), $configuration);
```
### Making a call to the API
```php
try {
$applicant = $onfidoApi->createApplicant(
new Onfido\Model\ApplicantBuilder(
[
'first_name' => 'First',
'last_name' => 'Last'
])
);
// To access the information use the getter for the desired property on the object, for example:
$applicant->getFirstName();
// ...
} catch (Onfido\ApiException $ex) {
// Handle API exception
echo 'Caught exception: ', $ex->getMessage(), "\n";
}
```
### Webhook event verification
Webhook events payload needs to be verified before it can be accessed. The library allows easy decoding of the payload and verification of its signature before returning it as an object for user convenience:
```php
try {
$verifier = new Onfido\WebhookEventVerifier(getenv('ONFIDO_WEBHOOK_SECRET_TOKEN'));
$signature = 'a0...760e';
$event = $verifier->readPayload('{"payload":{"r...3"}}', $signature);
} catch (Onfido\OnfidoInvalidSignatureError $ex) {
// Invalid webhook signature
}
```
### Recommendations
#### Do not use square bracket syntax
Except for accessing Task object's outputs, avoid using the square bracket syntax (i.e. `[]`) to access undefined properties to prevent breaking changes when these fields appear.
## Contributing
This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.11.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
For contributions to the tests instead, please follow the steps below:
1. Fork the [repository](https://github.com/onfido/onfido-php/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Make your changes
4. Commit your changes (`git commit -am 'Add detailed description of the feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
## Versioning policy
Versioning helps manage changes and ensures compatibility across different versions of the library.
[Semantic Versioning](https://semver.org) policy is used for library versioning, following the guidelines and limitations outlined below:
- MAJOR versions (x.0.0) may:
- target a new API version
- include non-backward compatible change
- MINOR versions (0.x.0) may:
- add a new functionality, non-mandatory parameter or property
- deprecate an old functionality
- include non-backward compatible change to a functionality which is:
- labelled as alpha or beta
- completely broken and not usable
- PATCH version (0.0.x) will:
- fix a bug
- include backward compatible changes only
## More documentation
Additional documentation and code examples can be found at .
## Support
Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via the [Customer Experience Portal](https://public.support.onfido.com/) which also includes support documentation.