craymend/accuratebackground-php

Php SDK for Accurate background checks API

dev-master 2021-04-22 16:30 UTC

Requires

• guzzlehttp/guzzle: ^7.0.1

MIT

• Cray Mend

README

Query Accurate API for Candidates and Orders

Installation

Via composer.

composer require craymend/accuratebackground-php

Run

artisan vendor:publish

Now in your .env file, define your Accurate credentials:

ACCURATE_API_CLIENT_ID=<your Accurate API client id>
ACCURATE_API_SECRET=<your Accurate API secret>

Check Accurate API is available example

use Craymend\AccurateSdk\Api\ApiBase;

$queryObj = new ApiBase();
        
$response = $queryObj->checkAlive();

Create Accurate candidate example

use Craymend\AccurateSdk\Api\Candidate;

$data = [
    'firstName' => 'John',
    'lastName' => 'PASS',
    'email' => '[e-mail]',
    'address' => '123 Main St.',
    'city' => 'Irvine',
    'region' => 'CA',
    'country' => 'US',
    'postalCode' => '12345',
    'dateOfBirth' => '1990-01-01', 
    'phone' => '1231231234',
    'ssn' => '123121234',
];

$queryObj = new Candidate();
$response = $queryObj->createCandidate($data);

if($response->status === 'success'){
    $candidate = $response->data;
    $candidateId = $candidate->id;
}

Create Accurate order example

use Craymend\AccurateSdk\Api\Order;

$data = [
    'candidateId' => $candidateId,
    'packageType' => 'PKG_BASIC',
    'workflow' => 'EXPRESS',
    'jobLocation.city' => 'Hollywood',
    'jobLocation.region' => 'CA',
    'jobLocation.country' => 'US'
];

$queryObj = new Order();
$response = $queryObj->createOrder($data);

if($response->status === 'success'){
    $order = $response->data;

    echo json_encode($order);
}

License

The MIT License (MIT).