Get regulated criminal reports

Request

Get a set of regulated criminal reports for the authenticated account.

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

Embed the profile in the response in place of profile_id.

Items Value	Description
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/criminal_reports?limit=10&skip=0&include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

Array [

One of:

A regulated criminal report with legal annotation checks included in results. Results are delivered asynchronously via webhook once processing is complete.

]

Response

[
  {
    "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
    "id": "2b8313e8-4efd-45a1-b578-952b8313e890",
    "status": "complete",
    "created_at": "2020-01-01T00:00:00Z",
    "completed_at": "2020-01-01T00:00:00Z",
    "results": [ … ],
    "excluded_records": [ … ],
    "check_type": "regulated_criminal_report",
    "reference_id": "ref-123",
    "run_notes": [ … ]
  }
]