Skip to main content

Installation

Requires PHP 8.1+ and the json extension.

Configuration

Use a qi_test_ key during development. Test keys return simulated results and are free to use.

Quick Start

KYC Sessions

Create a session

List sessions

Retrieve a session

Upload a document

Upload a selfie

Submit for evaluation

Call submit() only after all required documents and selfie have been uploaded. The session enters asynchronous processing and you will receive a webhook when it completes.

AML Screening

Screen a person

Retrieve a screening

Submit a decision

Transaction Monitoring

Screen a transaction

Batch screening

List, retrieve, and decide

Premium Features

Premium features require a paid plan. Calls made without an active subscription throw an InsufficientBalanceException.

Error Handling

All SDK exceptions extend VerilockException. Use specific classes for granular handling.
All resource methods accept an optional associative array of request options as the last argument for per-request overrides such as custom headers or timeouts.