lyal/checkr

A PHP client for checkr.io, a background screening service

0.14 2019-11-13 18:37 UTC

Requires

• php: >=7.0.0
• guzzlehttp/guzzle: ~6.0|~5.0|~4.0
• illuminate/routing: ~5.6|^5.5
• illuminate/support: ~5.6|~5.5

Requires (Dev)

• mockery/mockery: 0.9.*
• phpunit/phpunit: ~7.0

BSD-2-Clause

• lyal

• laravel
• checkr
• symphony

README

A simple PHP package for interacting with the www.checkr.com's API (documentation at https://docs.checkr.com/), focusing on ease of use.

Requirements

PHP 7.1+

Installation

composer require lyal/checkr

Basic Usage

<?php
use Lyal\Checkr\Client;

$client = new Client('insert_checkr_api_key_here');

/**
 * Create a new user and send them an invitation
 */

$client->candidate(['email' => '[e-mail]'])->create()->invitation(['package' => 'tasker_pro'])->create();

Environment Variables

There are several helpful environment variables. In order for the API testing package to work, you must set checkr_test_key either with the environment variable checkr_test_key or in PHPUnit's XML file.

checkr_api_key = 'xxxxxxxxxxx'
checkr_test_key = 'xxxxxxxxxxxx'
use_collections = true