Checks the candidate against UK criminal records (DBS) to identify any relevant convictions.Retrieve the uk criminal result for a screening by its
id. This element is only available if it is part of the package used for the screening.
GET https://api.peoplecheck.com/screenings/{id}/criminalPath parameters
number
required
Identification of the screening process.
Request
Response
Theresult object reports the outcome of the check: value (the finding), status (typically confirmed once complete), the completed datetime, and any comment.
Response
If the element hasn’t finished yet, the endpoint returns a
message explaining that the result is not completed. See Managing results for status meanings.
