We believe managing HR compliance shouldn’t be hard. Whether you’re new to building integrations or a seasoned developer working on complex projects, the PeopleCheck REST API is built to be predictable, robust and easy to adopt. Our detailed documentation, ready-to-run code samples and quick-start guides will help you get up and running in no time. We’re excited to see what you’ll build with the PeopleCheck API. And remember, our tech team is just an email away. If you have questions, need guidance, or run into any challenges, reach out to us at techteam@peoplecheck.com.

​
Getting started

Initiating your API integration is straightforward. Begin by activating your account and setting up a password as instructed in your Welcome Email. Your account is automatically configured in our sandbox environment to facilitate testing and development. Once you’re ready, the typical flow looks like this:
1

Authenticate

Generate your API token and send it on every request. See Authentication.
2

Pick a package

List the check packages available to your organisation and choose the one to run.
3

Send a request

Create a request for a candidate. We email them to collect consent and the information needed to start the checks.
4

Track and retrieve results

Follow progress through screenings and receive real-time updates via webhooks.
Prefer to explore in your API client of choice? Download our Postman collection with ready-made sample requests.

​
Let’s build your integration

Environments

Test your integration safely before going live.

Authentication

Secure every request with your API token.

Requests

Start and manage your background check requests.

Results

Retrieve check results as soon as they’re ready.

Webhooks

Get notified automatically when something changes.

Support

Talk to our tech team whenever you need a hand.