Generate a report

Instead of requesting each check element individually, you can generate a consolidated report for a screening that returns every element in one response. Choose the format that best fits your workflow.

POST https://api.peoplecheck.com/screenings/{id}/report/{type}

Path parameters

number

required

Identification of the screening process.

string

required

Type of result report. One of json, xml, or pdf.

Request

curl --location --request POST 'https://api.peoplecheck.com/screenings/{id}/report/json' \
     --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/report/json", { method: "POST", 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/report/json',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array('x-peoplecheck-token: YOUR_API_TOKEN'),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Response

The payload contains every check element in the screening, keyed by element name. Elements that haven’t finished yet return a message instead of a result.

Response

{
  "error": false,
  "payload": {
    "identity": {
      "firstName": "Jhon",
      "middleName": "",
      "lastName": "Smith",
      "dob": "1988-10-02",
      "result": {
        "value": "passport",
        "status": "confirmed",
        "completed": "2023-04-04T13:49:51.000Z",
        "comment": null
      }
    },
    "right-to-work": {
      "result": {
        "value": "passport",
        "status": "confirmed",
        "expire": null,
        "validUntil": null,
        "completed": "2023-04-04T13:50:25.000Z",
        "comment": null
      }
    },
    "address": {
      "message": "Address result not completed"
    },
    "criminal": {
      "message": "Criminal UK result not completed"
    },
    "financial": {
      "message": "Creditsafe result not completed"
    },
    "sanction": {
      "result": {
        "value": "unlisted",
        "status": "confirmed",
        "completed": "2023-04-04T13:50:37.000Z",
        "comment": null
      }
    }
  }
}

Which elements appear in the report depends on the package used for the screening. To retrieve a single element on its own, use the individual check element endpoints.

Get started

API essentials

Packages

Requests

Results

Webhooks

Path parameters

Request

Response

​Path parameters

​Request

​Response

Path parameters

Request

Response