Skip to content

Regulated Instant Criminal Profile

Regulated Instant Criminal Profile provides FCRA-compliant, profile-centric criminal record results. results is an array of matched identities (profiles) -- each with a conservative identity summary and its own nested criminal records -- so you can review which identity matched before drilling into its records. Every record is evaluated against applicable legal rules, and records your account is not permitted to see are omitted. A permissible purpose and date of birth are required. Previously run checks can be retrieved individually or listed as your account's check history.

List regulated instant criminal profile checks

Request

Get your account's regulated instant criminal profile checks, newest first -- for example for audits, disputes, and reconciliation against your own reference_ids. Each check has the same shape and legal filtering as Get regulated instant criminal profile check.

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

limit the number of checks returned

Default:10
skipinteger, [ 0 .. 999999 ]

skip a number of checks before returning (for paging)

Default:0
include[]Array of strings

Embed the profile in the response in place of profile_id.

Items ValueDescription
profile

Embeds the full profile object in place of profile_id.

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

Responses

OK

Bodyapplication/json
Array [
One of:
]
Response
[ { "id": "2b8313e8-4efd-45a1-b578-952b8313e890", "created_at": "2020-01-01T00:00:00Z", "completed_at": "2020-01-01T00:00:00Z", "status": "complete", "check_type": "instant_criminal_profile_regulated", "input_type": "person", "reference_id": "ref-123", "results_info": { … }, "results": [ … ], "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890" } ]