List all packages

A package defines the set of check elements (identity, right to work, criminal, financial, and so on) that will run when you request a check for a candidate. Before creating a request, list your packages to find the id you want to use.

GET https://api.peoplecheck.com/packages

Request

This endpoint takes no parameters beyond your authentication header.

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;

Response

The payload is an array of packages. Each package includes the elements it runs (components) and its configuration (configs).

Field	Type	Description
`id`	number	The unique identifier of the package. Use this as the `package` value when creating a request.
`name`	string	The package’s name.
`status`	string	Current status — `enabled` or `disabled`.
`components`	array	The check elements included in the package.
`configs`	object	Package configuration such as address history span and DBS type.

Response

{
  "error": false,
  "payload": [
    {
      "id": 4030,
      "name": "Digital UK Right to Work",
      "status": "enabled",
      "components": [
        "Identity",
        "Right to work (visa and work permits)",
        "Additional remarks"
      ],
      "configs": {
        "yearAddress": 0,
        "typeActivity": null,
        "qtyActivity": 0,
        "qtyReference": 0,
        "dbsType": "Basic"
      }
    },
    {
      "id": 4028,
      "name": "Pre-Hire Clearance",
      "status": "enabled",
      "components": [
        "Identity",
        "Right to work (visa and work permits)",
        "Address history",
        "UK criminal check",
        "UK financial check",
        "Global sanction lists",
        "Additional remarks"
      ],
      "configs": {
        "yearAddress": 5,
        "typeActivity": null,
        "qtyActivity": 0,
        "qtyReference": 0,
        "dbsType": "None"
      }
    }
  ]
}

Keep a mapping of the package ids you use most often, so your integration can create requests without listing packages every time.

Get started

API essentials

Packages

Requests

Results

Webhooks

Request

Response

​Request

​Response

Request

Response