Authentication

Before you can start requesting checks or pulling results, you’ll need to authenticate your requests. Don’t worry, it’s a simple process. Every request to the PeopleCheck API is authenticated with a token sent in the request headers. This token identifies your organisation and verifies that the request is coming from an authorised source.

Obtaining your API token

Activate your account

Follow the instructions in your Welcome Email to activate your account and set your password. New accounts start in the Sandbox environment.

Locate your token

Your API token is available in your PeopleCheck account settings. If you can’t find it, contact techteam@peoplecheck.com.

Sandbox and Production use different tokens. Use the token that matches the environment you’re calling.

Using the token

Include your token in the x-peoplecheck-token header of every request:

Header

x-peoplecheck-token: YOUR_API_TOKEN

A complete request looks like this:

curl --location 'https://api.peoplecheck.com/packages' \
     --header 'x-peoplecheck-token: YOUR_API_TOKEN'

const headers = new Headers();
headers.append("x-peoplecheck-token", "YOUR_API_TOKEN");

fetch("https://api.peoplecheck.com/packages", { method: "GET", headers })
  .then((response) => response.json())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.peoplecheck.com/packages',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array('x-peoplecheck-token: YOUR_API_TOKEN'),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Testing the connection

To verify your integration is set up correctly, start with a simple request that lists the check packages available to your organisation. A successful response confirms your token is valid and your environment is reachable.

Security reminders

Keep your token secret: Never share it publicly or commit it to your code repositories.
Rotate tokens regularly: Rotate your token periodically and update your integration accordingly.
Use HTTPS: Always call the API over HTTPS to keep credentials and data secure in transit.

Get started

API essentials

Packages

Requests

Results

Webhooks

Obtaining your API token

Using the token

Testing the connection

Security reminders

​Obtaining your API token

​Using the token

​Testing the connection

​Security reminders

Obtaining your API token

Using the token

Testing the connection

Security reminders