Skip to content

Beta
Get a regulated driver score

Request

Get a single regulated driver score with a given id.

Available on Test and Pilot accounts only. Live accounts receive 403 Forbidden.

Beta: This product is in beta and not yet generally available. Request/response shapes may change, and availability may be limited to certain accounts or account stages -- check with your Checkr Account Executive.

Security
get-bearer-token-using-oauth2
Path
idstring, (uuid)(uuid)required

the uuid identifying the driver score

Example:2b8313e8-4efd-45a1-b578-952b8313e890
Query
include[]Array of strings

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

Items ValueDescription
profile

Embeds the full submitted profile object in place of profile_id.

curl -i -X GET \
  'https://api.checkrtrust.com/v1/regulated/driver_scores/2b8313e8-4efd-45a1-b578-952b8313e890?include%5B%5D=profile' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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(regulated_driver_score_status)
Enum:"pending""complete""error"
Example:"complete"
check_typestring(regulated_driver_score_type)
Value:"regulated_driver_score"
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"
results_updated_atstring, (date-time)(datetime)

When results last changed -- moves again when a later customer-ordered motor vehicle record lands on an already-complete run (see the regulated_driver_score.updated webhook).

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

Which driver_score test scenario (see GET /test_scenarios) matched this run, keyed by driver_license_number. Present only for test-stage accounts.

Example:"driver_score_ds0001"
driver_license_statusobject(driver_license_status)

A single DLSC (driver license status check), run once per request against the driver license the customer submitted -- a fact about the request, not about any one matched identity. Reported as pending until the check resolves. The public commitment for this block is exactly status and validity; no per-license detail (address, class, restrictions) is exposed here.

Example:
{
  "status": "included",
  "validity": "VALID"
}
resultsArray of objects(regulated_driver_score_matched_profile)

Array of matched identities. Populated as soon as the People Data Graph search completes -- readable on the 201 response, before driver_license_status resolves -- because this product's premise is that results display as they show up rather than all at once.

profile_idstring, (uuid)(profile_id)required

Identifier of an existing profile containing search criteria.

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