Get a single profile criminal check with a given id.
Beta: Profile Criminal Checks are in beta and not yet generally available.
- Checkr Trust APIhttps://api.checkrtrust.com/v1/profile_criminal_checks/{check_id}
curl -i -X GET \
'https://api.checkrtrust.com/v1/profile_criminal_checks/2b8313e8-4efd-45a1-b578-952b8313e890?include%5B%5D=profile' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
A universally unique identifier (UUID) in standard format.
An ISO 8601 formatted date-time string.
An ISO 8601 formatted date-time string.
The current status of the profile criminal check. This is the only field that separates a search that failed from one that ran and had nothing to report -- completed_at, results_info and results look identical in both cases.
null on checks created before this field was introduced. A null status is not an error: those checks did run, so read completed_at and results_info to tell whether one finished.
| Enum Value | Description |
|---|---|
| pending | The search has been submitted and is awaiting results. Rare for this product, which completes synchronously on create. |
| complete | The search ran and |
| error | The search could not be completed, so |
Always person for this product -- profile_criminal_check has no address-based search path.
A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.
Array of matched identities (profiles), each with its own nested records. Empty array when no identity matched at all, or when every matched identity scored below the effective minimum match score (the account's configured minimum, or this request's score_threshold override) -- a below-threshold match is excluded entirely, not included with records: []. A matched profile that clears the score threshold but has all of its records excluded (by a ruleset applied on the request, or by de-duplication) still appears here, with records as an empty array -- the identity match itself remains reportable even when nothing survived filtering. Sorted by match_confidence_level's underlying score, descending -- the best match is always first. Capped at the request's limit (default 10, max 20). This ordering is a stable contract you can rely on: matched profiles are not otherwise individually identifiable (no profile_id is exposed), so position in this array is the only way to refer to a specific match (e.g. "the 1st match").
{ "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890" }