README

Description

This is a PHP API client designed to interact with the Verisoul API. 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.

❤️ 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

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

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

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

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

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

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

This project is developed and maintained by 🥷 Diego Rin in his free time.

If you find this project useful, please consider giving it a ⭐ on GitHub!

diego-ninja / verisoul-api

Maintainers

Details