Screening overview

Retrieve the full overview of a single screening by its id. The overview combines candidate details, overall progress, and a timeline of everything that has happened so far.

GET https://api.peoplecheck.com/screenings/{id}

Path parameters

number

required

Identification of the screening process.

Request

curl --location 'https://api.peoplecheck.com/screenings/{id}' \
     --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/54687", { 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/54687',
  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 includes the candidate’s details, the package, overall progress, and a timeline of events, each with a title, description, optional summary, and date.

Response

{
  "error": false,
  "payload": {
    "id": 54687,
    "name": "Jhon Smith",
    "email": "jhon.smith@testing.com",
    "birthDay": "1988-10-02T03:00:00.000Z",
    "primaryCode": "XXX89752",
    "secondaryCode": "TTTHT1",
    "documents": 3,
    "package": {
      "id": 4028,
      "name": "Pre-Hire Clearance"
    },
    "progress": {
      "total": 85,
      "status": "in_progress"
    },
    "timeline": [
      {
        "title": "Check element completed",
        "description": "Right to work (visa and work permits)",
        "summary": "Completed",
        "date": "2023-04-04T13:50:25.000Z"
      },
      {
        "title": "New check request",
        "description": "Pre-Hire Clearance",
        "summary": "Requested by: David Runner",
        "date": "2023-04-04T13:33:31.000Z"
      }
    ],
    "created": "2023-04-04T13:47:46.000Z",
    "completed": null
  }
}

Get started

API essentials

Packages

Requests

Results

Webhooks

Path parameters

Request

Response

​Path parameters

​Request

​Response

Path parameters

Request

Response