Managing results

The PeopleCheck API is designed to keep you closely connected with the status of your background checks, providing real-time updates so you stay informed at every step. Whether results come back clear, are still in progress, or require your attention because they’ve been flagged, you can easily access detailed insights to guide your decisions. Once a candidate completes their onboarding form, a screening begins. A screening runs each check element defined by the package and tracks overall progress.

Results are available in two formats

We make it easy to access results in two convenient ways:

By screening — a consolidated view of a candidate’s whole screening, including overall progress and a timeline. See Screening overview and Generate a report.
By individual element — the detailed result of a single check element, such as Identity or Right to work.

By offering both formats, you get the insights you need to make informed decisions quickly, while keeping your compliance process organised.

Understanding statuses

Each screening reports its overall progress with a progress object:

"progress": {
  "total": 85,
  "status": "in_progress"
}

total — the percentage (%) of the screening completed so far.
status — the current state of the screening.

The status field can take the following values:

Status	Meaning
`in_progress`	The screening is currently being conducted. Expect ongoing updates as the system gathers information.
`no_risk`	The checks completed with no adverse findings.
`confirmed_with_alert`	The checks completed, but there are notable findings or discrepancies that require your attention.
`unable_to_verify`	The system could not complete verification due to missing information or issues with the data provided.
`cancelled`	The screening was cancelled by your team or due to a change in requirements.
`purged`	The screening data has been purged in line with data-retention policies.
`not_applicable`	This check does not apply to the candidate or package.

Individual check elements report their own result.status, most commonly confirmed when an element has completed.

Keeping up to date

You can poll the screenings endpoints for progress, but the most efficient way to stay informed is to let updates come to you. Configure webhooks to receive a notification the moment a request or result changes.

Get started

API essentials

Packages

Requests

Results

Webhooks

Results are available in two formats

Understanding statuses

Keeping up to date

​Results are available in two formats

​Understanding statuses

​Keeping up to date

Results are available in two formats

Understanding statuses

Keeping up to date