Skip to content

Get driver check

Request

Get a previously created driver check with a given id

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

the uuid identifying the driver check

Example:2b8313e8-4efd-45a1-b578-952b8313e890
Query
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"]
unmask_ssnboolean

Controls whether SSN values in results.requested_profile.ssn (and results_v2.requested_profile.ssn for driver license status checks) are returned in full or masked as XXX-XX-{last4}.

Used by driver check endpoints. For identity verification endpoints, see unmask_ssn_identity_verification instead — precedence rules differ.

When omitted, the account's product configuration unmask_ssn setting determines whether SSNs are unmasked. When explicitly set to true or false, the query parameter overrides the product configuration.

Defaults to masked when the product configuration has no unmask_ssn setting.

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

Responses

OK

Bodyapplication/json
One of:
One of:
profile_idstring, (uuid)(profile_id)required

Identifier of an existing profile containing search criteria.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"
check_typestring(check_type_driver_license_status)
Value:"driver_license_status"
Response
{
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890",
  "check_type": "driver_license_status"
}