{"id":37003494,"url":"https://github.com/onfido/onfido-php","last_synced_at":"2026-02-03T17:08:58.914Z","repository":{"id":14706809,"uuid":"80540314","full_name":"onfido/onfido-php","owner":"onfido","description":"PHP library for the Onfido API","archived":false,"fork":false,"pushed_at":"2025-10-17T14:16:28.000Z","size":2098,"stargazers_count":20,"open_issues_count":6,"forks_count":27,"subscribers_count":22,"default_branch":"master","last_synced_at":"2026-01-14T01:04:14.231Z","etag":null,"topics":["onfido","onfido-api","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onfido.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-01-31T16:48:43.000Z","updated_at":"2025-10-26T17:48:06.000Z","dependencies_parsed_at":"2024-04-09T19:34:07.890Z","dependency_job_id":"8ba3824d-2cd0-425a-b4b0-5d9aaf522ccd","html_url":"https://github.com/onfido/onfido-php","commit_stats":{"total_commits":46,"total_committers":16,"mean_commits":2.875,"dds":0.5217391304347826,"last_synced_commit":"65bf5f9252ce0638609a15de5bf64a819372b4a1"},"previous_names":["onfido/onfido-php","onfido/api-php-client"],"tags_count":58,"template":false,"template_full_name":null,"purl":"pkg:github/onfido/onfido-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onfido%2Fonfido-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onfido%2Fonfido-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onfido%2Fonfido-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onfido%2Fonfido-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onfido","download_url":"https://codeload.github.com/onfido/onfido-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onfido%2Fonfido-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479930,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["onfido","onfido-api","php"],"created_at":"2026-01-14T00:33:43.911Z","updated_at":"2026-01-16T16:33:39.523Z","avatar_url":"https://github.com/onfido.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Onfido PHP Library\n\nThe official PHP library for integrating with the Onfido API.\n\nDocumentation can be found at \u003chttps://documentation.onfido.com\u003e.\n\nThis 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.\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.4 and later. Should also work with PHP 8.0.\n\n[![Latest release](https://badge.fury.io/ph/onfido%2Fonfido-php.svg)](https://badge.fury.io/ph/onfido%2Fonfido-php)\n![Build Status](https://github.com/onfido/onfido-php/actions/workflows/php.yml/badge.svg)\n\n### Installation\n\n#### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/onfido/onfido-php.git\"\n    }\n  ],\n  \"require\": {\n    \"onfido/onfido-php\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n#### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/OpenAPIClient-php/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation instructions](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n$configuration = Onfido\\Configuration::getDefaultConfiguration();\n$configuration-\u003esetApiToken($_ENV['ONFIDO_API_TOKEN']);\n$configuration-\u003esetRegion(Onfido\\Region::EU);   // Supports `Region::EU`, `Region::US`, and `Region::CA`\n\n$onfidoApi = new Onfido\\Api\\DefaultApi(\n              new \\GuzzleHttp\\Client([\n                  'timeout'  =\u003e 30,\n                  'connect_timeout' =\u003e 30,\n                  'read_timeout' =\u003e 30\n              ]), $configuration);\n\n```\n\n### Making a call to the API\n\n```php\ntry {\n  $applicant = $onfidoApi-\u003ecreateApplicant(\n      new Onfido\\Model\\ApplicantBuilder(\n          [\n              'first_name' =\u003e 'First',\n              'last_name' =\u003e 'Last'\n          ])\n  );\n\n  // To access the information use the getter for the desired property on the object, for example:\n  $applicant-\u003egetFirstName();\n\n  // ...\n\n} catch (Onfido\\ApiException $ex) {\n  // Handle API exception\n  echo 'Caught exception: ',  $ex-\u003egetMessage(), \"\\n\";\n}\n```\n\n### Webhook event verification\n\nWebhook 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:\n\n```php\ntry {\n  $verifier = new Onfido\\WebhookEventVerifier(getenv('ONFIDO_WEBHOOK_SECRET_TOKEN'));\n\n  $signature = 'a0...760e';\n\n  $event = $verifier-\u003ereadPayload('{\"payload\":{\"r...3\"}}', $signature);\n} catch (Onfido\\OnfidoInvalidSignatureError $ex) {\n  // Invalid webhook signature\n}\n```\n\n### Recommendations\n\n#### Do not use square bracket syntax\n\nExcept 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.\n\n## Contributing\n\nThis 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.\n\nFor contributions to the tests instead, please follow the steps below:\n\n1. Fork the [repository](https://github.com/onfido/onfido-php/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Make your changes\n4. Commit your changes (`git commit -am 'Add detailed description of the feature'`)\n5. Push to the branch (`git push origin my-new-feature`)\n6. Create a new Pull Request\n\n## Versioning policy\n\nVersioning helps manage changes and ensures compatibility across different versions of the library.\n\n[Semantic Versioning](https://semver.org) policy is used for library versioning, following the guidelines and limitations outlined below:\n\n- MAJOR versions (x.0.0) may:\n  - target a new API version\n  - include non-backward compatible change\n- MINOR versions (0.x.0) may:\n  - add a new functionality, non-mandatory parameter or property\n  - deprecate an old functionality\n  - include non-backward compatible change to a functionality which is:\n    - labelled as alpha or beta\n    - completely broken and not usable\n- PATCH version (0.0.x) will:\n  - fix a bug\n  - include backward compatible changes only\n\n## More documentation\n\nAdditional documentation and code examples can be found at \u003chttps://documentation.onfido.com\u003e.\n\n## Support\n\nShould 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonfido%2Fonfido-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonfido%2Fonfido-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonfido%2Fonfido-php/lists"}