Download the PHP package onfido/api-php-client without Composer
On this page you can find all versions of the php package onfido/api-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download onfido/api-php-client
More information about onfido/api-php-client
Files in onfido/api-php-client
Package api-php-client
Short Description The Onfido API (v3.6)
License MIT
Homepage https://documentation.onfido.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-php-client
Onfido PHP Library
The official PHP library for integrating with the Onfido API.
Documentation can be found at https://documentation.onfido.com.
This version uses Onfido API v3.6. Refer to our API versioning guide 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.
Installation
Composer
To install the bindings via Composer, add the following to composer.json:
Then run composer install
Manual Installation
Download the files and include autoload.php:
Getting Started
Please follow the installation procedure and then run the following:
Making a call to the API
Webhook event verification
Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
Recommendations
Do not use square bracket syntax
Except for accessing Task object's outputs, retain from using the square bracket syntax (i.e. []) to access not defined properties to avoid breaking changes when these fields will appear.
Contributing
This library is automatically generated using OpenAPI Generator (version: 7.9.0); therefore all the contributions, except tests files, should target Onfido OpenAPI specification repository instead of this repository.
For contributions to the tests instead, please follow the steps below:
- Fork repository
- Create your feature branch (
git checkout -b my-new-feature) - Make your changes
- Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Versioning policy
Semantic Versioning policy is used for library versioning, following guidelines and limitations below:
- MAJOR versions (x.0.0) might:
- target a new API version
- include non-backward compatible change
- MINOR versions (0.x.0) might:
- 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) might:
- fix a bug
- include backward compatible changes only
More documentation
More documentation and code examples can be found at https://documentation.onfido.com.
Support
Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via the Customer Experience Portal which also includes support documentation.
All versions of api-php-client with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0