Get regulated instant criminal profile check

Request

Get a single regulated instant criminal profile check with a given id.

Security

get-bearer-token-using-oauth2

Path

check_idstring, (uuid)required

the uuid identifying the check

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

Responses

Bodyapplication/json

One of:

idstring, (uuid)(uuid)

A universally unique identifier (UUID) in standard format.

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

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"

statusstring or null(profile_criminal_check_status)

The current status of a profile-family criminal check (driver_risk_signals, instant_criminal_profiles, regulated/instant_criminal_profiles). 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 `results` is authoritative. An empty `results` array here means the search had nothing to return -- either no identity matched, or every matched identity fell below the effective minimum match confidence (see `results` for the distinction).
error	The search could not be completed, so `results` is empty because nothing was searched, not because nothing was found. `completed_at` is `null`. Treat this as "no answer", never as a clear result.

Example:"complete"

check_typestring(regulated_instant_criminal_profile_type)

Value:"instant_criminal_profile_regulated"

input_typestring(input_type)

Always person for this product.

Default:"person"

Enum:"address""person"

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

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

Example:"ref-123"

results_infoobject

resultsArray of objects, <= 20 items(regulated_matched_profile)

Array of matched identities (profiles), each with its own nested, legally annotated records. Empty array when no identity matched at all, or when every matched identity fell below the effective minimum match confidence (high by default, or this request's min_match_confidence_level) -- a below-minimum match is excluded entirely, not included with records: [].

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 identifier for a matched identity is exposed; the top-level profile_id is the profile you submitted), so position in this array is the only way to refer to a specific match (e.g. "the 1st match").

Records, cases, and charges excluded by legal rules are omitted. If your account is configured as a consumer reporting agency (CRA), items marked investigate are included for you to review. A matched identity whose records were all removed -- by legal filtering, by a ruleset applied on the request, or by de-duplication -- still appears, with records as an empty array, and does not count toward results_info.profiles_returned.

profile_idstring, (uuid)(profile_id)required

Identifier of an existing profile containing search criteria.

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

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": {
    "profiles_returned": 0,
    "profiles_limit": 5,
    "profiles_truncated": true
  },
  "results": [
    { … }
  ],
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890"
}