The PeopleCheck API is a standard REST API. If you’ve integrated with a REST API before, you’ll feel right at home. This guide walks you through the conventions you’ll see across every endpoint.

​
Base URL

Each environment has its own base URL. Send your requests to the one that matches the environment you’re integrating against: The examples throughout this documentation use the Production base URL. Swap it for the Sandbox URL while you’re testing.

​
Conventions

  • HTTPS only: Requests must be made over HTTPS.
  • JSON: Request and response bodies are JSON. Send Content-Type: application/json when posting data.
  • Authentication: Every request carries your token in the x-peoplecheck-token header. See Authentication.
  • Resource IDs: Requests and screenings are identified by a numeric id in the path, for example /screenings/{id}.

​
Response envelope

Most endpoints wrap their result in a consistent envelope, making responses predictable to parse:
  • error: A boolean indicating whether the request failed. false means the request was processed successfully.
  • payload: The data returned by the endpoint — an object or an array, depending on the resource.
Always check the error flag before reading payload. A 200 response with "error": true indicates the request reached the API but could not be fully processed — inspect the payload for details.

​
Pagination

List endpoints that can return many records include a pagination object so you can page through results:

​
Try it yourself

Head over to Authentication to get set up, then make your first call by listing your packages.