PHPackages diego-ninja/verisoul-api - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. diego-ninja/verisoul-api ActiveLibrary[API Development](/categories/api) diego-ninja/verisoul-api ======================== A modern php 8.3+ verisoul api client implementation v1.1.5(10mo ago)08101MITPHPPHP ^8.3CI passing Since Jul 30Pushed 10mo agoCompare [ Source](https://github.com/diego-ninja/verisoul-api)[ Packagist](https://packagist.org/packages/diego-ninja/verisoul-api)[ RSS](/packages/diego-ninja-verisoul-api/feed)WikiDiscussions main Synced today READMEChangelog (7)Dependencies (15)Versions (12)Used By (0) Verisoul API Client for PHP =========================== [](#verisoul-api-client-for-php) [![Latest Version on Packagist](https://camo.githubusercontent.com/9bb49ed683c35c8d2ada003d6f96d751fd359ce6c8d1fe968f93ee5f95e10fee/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646965676f2d6e696e6a612f76657269736f756c2d6170692e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)](https://packagist.org/packages/diego-ninja/verisoul-api)[![Total Downloads](https://camo.githubusercontent.com/3bdfc3f8ab5785efc3f7f2165c1fd5f68e550f8054d4b36319bff8eae4cf643f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f646965676f2d6e696e6a612f76657269736f756c2d6170692e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)](https://packagist.org/packages/diego-ninja/verisoul-api)[![PHP Version](https://camo.githubusercontent.com/47792f75b6e72190018a9844fea13dc9da0ff135ac596d5a8ad1c211de445a6b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f646965676f2d6e696e6a612f76657269736f756c2d6170692e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)](https://camo.githubusercontent.com/47792f75b6e72190018a9844fea13dc9da0ff135ac596d5a8ad1c211de445a6b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f646965676f2d6e696e6a612f76657269736f756c2d6170692e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)[![License: MIT](https://camo.githubusercontent.com/76fe2092d35371ec80a7aa2e57d649bf28726f186b3198e8c013b52e59c9885b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)](https://opensource.org/licenses/MIT)[![GitHub last commit](https://camo.githubusercontent.com/b2ed0f28b8a1900d52516b58bff720f3d5d45f3262dcdab24293be3f73bc72b1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f646965676f2d6e696e6a612f76657269736f756c2d6170693f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)](https://camo.githubusercontent.com/b2ed0f28b8a1900d52516b58bff720f3d5d45f3262dcdab24293be3f73bc72b1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f646965676f2d6e696e6a612f76657269736f756c2d6170693f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)[![wakatime](https://camo.githubusercontent.com/e4d23548918db20baf81085fbbd64e1c042a8f724b09ab8d43c809aedb0f9474/68747470733a2f2f77616b6174696d652e636f6d2f62616467652f757365722f62643635663035352d633966332d346637332d393261612d3363393831306637306363332f70726f6a6563742f33636332656336302d613862342d346464632d616561632d6561373865333761303934622e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c7565266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)](https://wakatime.com/badge/user/bd65f055-c9f3-4f73-92aa-3c9810f70cc3/project/3cc2ec60-a8b4-4ddc-aeac-ea78e37a094b) ![Tests](https://camo.githubusercontent.com/09f54a352aa5cbe69dc541e35c735e3a05d7853e3dfb5f5d638b06ebc6406740/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f646965676f2d6e696e6a612f6772616e6974652f74657374732e796d6c3f6272616e63683d6d61696e267374796c653d666c61742d737175617265266c6f676f3d676974687562266c6162656c3d506573742532305465737473266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)![Static Analysis](https://camo.githubusercontent.com/ac3ededa91edcd08a838ad10efba2af64840576c2acebf4a56ffa2ac49156b7a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f646965676f2d6e696e6a612f6772616e6974652f7374617469632d616e616c797369732e796d6c3f6272616e63683d6d61696e267374796c653d666c61742d737175617265266c6f676f3d676974687562266c6162656c3d5048505374616e2532303130266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)![Code Style](https://camo.githubusercontent.com/05645812247c111ec3a5a2985877484fd571494bed7e4eab7568a3396cd3f3b8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f646965676f2d6e696e6a612f6772616e6974652f636f64652d7374796c652e796d6c3f6272616e63683d6d61696e267374796c653d666c61742d737175617265266c6f676f3d676974687562266c6162656c3d50696e74253341253230504552266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530)![Coveralls](https://camo.githubusercontent.com/0f9d97a205c5acaa98592070eb1ca5596f4d50194eb29e5fafa81b03ae3114bf/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c73436f7665726167652f6769746875622f646965676f2d6e696e6a612f76657269736f756c2d6170693f6272616e63683d6d61696e267374796c653d666c61742d737175617265266c6f676f3d636f766572616c6c73266c6f676f436f6c6f723d253233393439636134266c6162656c436f6c6f723d253233336634373530266c696e6b3d6874747073253341253246253246636f766572616c6c732e696f253246676974687562253246646965676f2d6e696e6a612532466772616e697465) Description ----------- [](#description) This is a PHP API client designed to interact with the [Verisoul API](https://docs.verisoul.ai/api-reference/introduction). It provides a simple and effective way to access Verisoul's services, which include account management, session authentication, biometric identity verification, and list management. The client is designed to be flexible and easy to use, with a focus on the immutability of Data Transfer Objects (DTOs) to ensure data integrity throughout your application. This documentation has been generated almost in its entirety using 🦠 Claude 4 Sonnet based on source code analysis. Some sections may be incomplete, outdated or may contain documentation for planned or not-released features. For the most accurate information, please refer to the source code or open an issue on the package repository. ❤️ Features ----------- [](#️-features) - **Account Management**: Allows you to get, update, and delete user accounts, as well as query associated sessions and linked accounts. - **Session Authentication**: Offers methods to authenticate sessions for both registered and anonymous users, providing a detailed risk analysis. - **Identity Verification**: Includes functionalities for identity verification through facial recognition (FaceMatch) and identity document validation (IDCheck). - **List Management**: Enables the creation and management of account lists to group users based on different criteria, such as whitelists, blacklists, or high-risk user lists. - **Error Handling**: The client handles API errors in a structured manner, with custom exceptions that facilitate debugging and error flow control. 📦 Installation -------------- [](#-installation) To use this library, you can install it via Composer. First, make sure you have Composer installed in your project, and then run the following command: ``` composer require diego-ninja/verisoul-api ``` 🎛️ Configuration ---------------- [](#️-configuration) To start using the client, you need a Verisoul API key. You can get one from the Verisoul dashboard. Next, you can instantiate the main `Verisoul` client as follows: ``` use Ninja\Verisoul\Verisoul; use Ninja\Verisoul\Enums\VerisoulEnvironment; $apiKey = 'your_api_key'; $environment = VerisoulEnvironment::Sandbox; // Or VerisoulEnvironment::Production $verisoul = new Verisoul($apiKey, $environment); ``` ⚙️ Basic Usage -------------- [](#️-basic-usage) #### Account Management [](#account-management) You can interact with user accounts using the accounts client: ``` // Get account details $accountDetails = $verisoul->accounts()->getAccount('account_id'); // Update an account $updateData = ['email' => 'new_email@example.com']; $updatedAccount = $verisoul->accounts()->updateAccount('account_id', $updateData); // Delete an account $deleteResponse = $verisoul->accounts()->deleteAccount('account_id'); ``` #### Session Authentication [](#session-authentication) To authenticate a session and get a risk analysis, you can use the sessions client: ``` use Ninja\Verisoul\DTO\UserAccount; // User account data $userAccount = new UserAccount( id: 'user_id', email: 'user@example.com' ); // Authenticate the session $authenticationResponse = $verisoul->sessions()->authenticate($userAccount, 'session_id'); ``` #### Identity Verification with FaceMatch [](#identity-verification-with-facematch) If you need to verify a user's identity via facial recognition, you can use the FaceMatch client: ``` // Start a FaceMatch session $sessionResponse = $verisoul->faceMatch()->session(); // Once the user completes the process, you can verify the session $verificationResult = $verisoul->faceMatch()->verify($sessionResponse->sessionId); ``` #### List Management [](#list-management) You can also manage lists of accounts to group users: ``` // Create a new list $verisoul->lists()->createList('risk_list', 'Users with suspicious activity'); // Add an account to the list $verisoul->lists()->addAccountToList('risk_list', 'account_id'); // Get all accounts in a list $accountsInList = $verisoul->lists()->getList('risk_list'); ``` 🙏 Credits --------- [](#-credits) This project is developed and maintained by 🥷 [Diego Rin](https://diego.ninja) in his free time. If you find this project useful, please consider giving it a ⭐ on GitHub! ### Health Score 36 — LowBetter than 79% of packages Maintenance54 Moderate activity, may be stable Popularity14 Limited adoption so far Community9 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor1 Top contributor holds 78.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~4 days Total 7 Last Release 310d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/dff5b0a76de3d555cb236c400384058ba23982bce2e859cc1b2f0c1f0161a3e6?d=identicon)[diego.ninja](/maintainers/diego.ninja) --- Top Contributors [![diego-ninja](https://avatars.githubusercontent.com/u/78662279?v=4)](https://github.com/diego-ninja "diego-ninja (26 commits)")[![CristianPeter](https://avatars.githubusercontent.com/u/102976077?v=4)](https://github.com/CristianPeter "CristianPeter (7 commits)") ### Code Quality TestsPest Static AnalysisPHPStan, Rector Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/diego-ninja-verisoul-api/health.svg) ``` [![Health](https://phpackages.com/badges/diego-ninja-verisoul-api/health.svg)](https://phpackages.com/packages/diego-ninja-verisoul-api) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.8k543.8M20.1k](/packages/laravel-framework)[statamic/cms The Statamic CMS Core Package 4.8k3.6M987](/packages/statamic-cms)[oro/platform Business Application Platform (BAP) 645143.5k115](/packages/oro-platform)[algolia/algoliasearch-client-php API powering the features of Algolia. 69735.1M159](/packages/algolia-algoliasearch-client-php)[civicrm/civicrm-core Open source constituent relationship management for non-profits, NGOs and advocacy organizations. 751291.4k43](/packages/civicrm-civicrm-core)[craftcms/cms Craft CMS 3.6k3.6M3.1k](/packages/craftcms-cms) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)