Skip to content

Criminal Checks

Criminal Checks provide criminal record check results asynchronously. Results become available via GET once the check completes; when a webhook is configured, they are also delivered to that endpoint.

Operations

Get criminal checks

Request

Get a set of criminal checks. Results are only available after the check completes (completed_at is set).

Always check completed_at before interpreting the results array. An empty results array is ambiguous unless completed_at is set: when completed_at is null the check is still pending and results have not yet been populated, whereas an empty results array on a check with completed_at set means the check completed with no records found.

Security
get-bearer-token-using-oauth2
Query
limitinteger, [ 0 .. 999999 ]

limit the number of records returned

Default:10
skipinteger, [ 0 .. 999999 ]

skip a number of records before returning (for paging)

Default:0
include[]Array of strings

Request optional response fields. Repeat the parameter for multiple values.

Items Enum ValueDescription
profile

Embeds the full profile object in place of profile_id.

results_found

Returns results_found (boolean) instead of the full results array.

Examples:
Single value
include[]=["profile"]
Single value
include[]=["results_found"]
Multiple values
include[]=["profile","results_found"]
curl -i -X GET \
  'https://api.checkrtrust.com/v1/criminal_checks?limit=10&skip=0&include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Array [
One of:

A criminal check result. Results are only available after the check completes (completed_at is set). Before completion, the results array will be empty. Always check completed_at before interpreting the results array: an empty results array is ambiguous unless completed_at is set. When completed_at is null the check is still pending, whereas an empty results array with completed_at set means the check completed with no records found.

]
Response
[
  {
    "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
    "completed_at": null,
    "results": null
  }
]