README

ComplyCube PHP Library

The official PHP library for integrating with the ComplyCube API.

Get started with our API integration docs and check out our full API reference.

Requirements

PHP 7.4.

Composer Install

$ composer require complycube/complycube

Use composers generated loader.

require_once __DIR__ . '/vendor/autoload.php';

Usage

Initialise the ComplyCubeClient with the API key from your developer dashboard.

use ComplyCube\ComplyCubeClient;
$complycube = new ComplyCubeClient($apiKey);

Create a new client and complete a check

$newclient = $complycube->clients()->create([
    'type' => 'person',
    'email' => 'john@doe.com',
    'personDetails' => ['firstName' => 'John',
                        'lastName' => 'Smith']]);

$result = $complycube->checks()->create($newclient->id,
                                        ['type' => 'extensive_screening_check']);

Webhooks

ComplyCube uses webhooks to notify your application when an event happens in your account.

You can use the EventVerifier to validate the messages sent to your application.

$verifier = new \ComplyCube\EventVerifier('WEBHOOK_SECRET');

$event = $verifier->constructEvent($data, $headers[SIGNATURE_KEY]);

Check out the Webhooks guide

Integration Checklist

When you’re done developing your ComplyCube integration and you’re ready to go live, refer to this checklist to ensure you have covered all critical steps.

About ComplyCube

ComplyCube, the award-winning SaaS & API platform, specializes in innovative solutions for Identity Verification (IDV), Anti-Money Laundering (AML), and Know Your Customer (KYC) compliance. With a vast clientele across multiple industries such as financial services, transport, healthcare, e-commerce, cryptocurrency, FinTech, and telecoms, ComplyCube is a leading entity in the IDV domain.

This ISO-certified platform is distinguished by its ability to integrate quickly across channels and the comprehensive nature of its service suite, including Low/No-Code solutions, extensive API, Mobile SDKs, Client Libraries, and seamless CRM integrations.

complycube / complycube-php

Maintainers

Details