View screenings

List the screenings for your organisation. A screening is created once a candidate completes their onboarding form, and tracks the progress of every check element in the package.

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

Query parameters

The samples below show the common filters used to narrow the list.

string

Filter by screening status, for example in_progress. See Understanding statuses.

number

Maximum number of records to return on the page.

Request

curl --location 'https://api.peoplecheck.com/screenings?status=in_progress&limit=10' \
     --header 'x-peoplecheck-token: YOUR_API_TOKEN'

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

fetch("https://api.peoplecheck.com/screenings?status=in_progress&limit=10", { 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/screenings?status=in_progress&limit=10',
  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 contains a pagination object and a data array of screenings.

Field	Type	Description
`id`	number	The unique identifier of the screening.
`firstName`	string	The candidate’s first name.
`middleName`	string	The candidate’s middle name.
`lastName`	string	The candidate’s last name.
`email`	string	The candidate’s email.
`progress`	object	Overall progress — see Understanding statuses.
`package`	object	The package being run, with its `id` and `name`.
`created`	string	Creation datetime.
`modified`	string	Last modification datetime.
`completed`	string	Completion datetime, or `null` while in progress.

Response

{
  "error": false,
  "payload": {
    "pagination": {
      "total": 2,
      "page": 1,
      "limit": 12
    },
    "data": [
      {
        "id": 20099,
        "firstName": "Jhon",
        "middleName": "Smith",
        "lastName": "",
        "email": "jhon.smith@testing.com",
        "progress": {
          "total": 60,
          "status": "in_progress"
        },
        "package": {
          "id": 4030,
          "name": "Digital UK Right to Work"
        },
        "created": "2023-11-13T16:32:00.000Z",
        "modified": "2023-11-13T16:32:00.000Z",
        "completed": null
      }
    ]
  }
}

Use a screening’s id to open its Screening overview or fetch individual check elements.

Get started

API essentials

Packages

Requests

Results

Webhooks

Query parameters

Request

Response

​Query parameters

​Request

​Response

Query parameters

Request

Response