Get regulated criminal report

Request

Get a single regulated criminal report with a given id.

Security

get-bearer-token-using-oauth2

Path

idstring, (uuid)required

The uuid identifying the regulated criminal report

Example:2b8313e8-4efd-45a1-b578-952b8313e890

Query

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/2b8313e8-4efd-45a1-b578-952b8313e890?include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

One of:

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

idstring, (uuid)(uuid)

A universally unique identifier (UUID) in standard format.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"

statusstring

The current status of the report.

Enum:"pending""complete""failed"

Example:"complete"

created_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"

completed_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"

resultsArray of objects(regulated_record)

The fully-disclosed records found for this report. When there are no results found, this will be an empty array. A record excluded by legal rules never appears here -- see excluded_records.

excluded_recordsArray of objects(regulated_record_stripped)

Records excluded by legal rules, reduced to an identifier, classification, jurisdiction, and per-charge offense classification. Present only when the account's excluded_record_disclosure setting is stripped; omitted (or empty) otherwise, and always separate from results.

check_typestring(criminal_report_check_type)

The type of check performed for this report.

Default:"regulated_criminal_report"

Value:"regulated_criminal_report"

reference_idstring(reference_id)^[a-zA-Z0-9_-]{1,64}$

A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.

Example:"ref-123"

run_notesArray of strings

An unstructured array of human-readable notes about this particular report. May contain notes about how input was parsed or other information about results.

profile_idstring, (uuid)(profile_id)

Identifier of an existing profile containing search criteria.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"

Response

{
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890"
}