# Get driver checks

Get a set of previously created driver checks

Endpoint: GET /driver_checks
Version: 1.0
Security: get-bearer-token-using-oauth2

## Security:

  - `get-bearer-token-using-oauth2` (unknown)
    oauth2

## Query parameters:

  - `limit` (integer)
    limit the number of records returned

  - `skip` (integer)
    skip a number of records before returning (for paging)

  - `include[]` (array)
    Embed the profile in the response in place of `profile_id`.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `id` (string)
    A universally unique identifier (UUID) in standard format.
    Example: 2b8313e8-4efd-45a1-b578-952b8313e890

  - `created_at` (string)
    An ISO 8601 formatted date-time string.
    Example: 2020-01-01T00:00:00Z

  - `completed_at` (any)
    A datetime, or null if not completed.

  - `results` (any)
    Results, or null if not completed. The structure depends on the value of check_type.

  - `results.requested_profile` (object)
    The inputs used to create the driver check. Fields that weren't provided will not be included.

  - `results.requested_profile.full_name` (string)
    The full name of the person. Must not be combined with first_name, middle_name, or last_name.
May be combined with `no_middle_name` on create/update; when that flag is `true`, parsing
stores only a first name and surname (any middle token is folded into the last name).

  - `results.requested_profile.first_name` (string)
    The first name of the person.

  - `results.requested_profile.middle_name` (string)
    The middle name of the person. Can be null if not provided.

  - `results.requested_profile.no_middle_name` (boolean)
    Set to `true` to declare that the subject does not have a middle name.
**Mutually exclusive with a non-empty `middle_name`:** the API rejects requests that
supply both a present `middle_name` and `no_middle_name: true`. An empty or null
`middle_name` with `no_middle_name: true` is allowed. A non-empty `middle_name` may be
supplied with `no_middle_name: false`.
**Allowed with `full_name`:** `full_name` and `no_middle_name` may be sent together.
That is not the same as supplying `middle_name` — when the flag is `true`, parsing
stores only a first name and surname, and any token the parser would have treated as
a middle name is folded into the last name (for example `full_name: "John Quincy Doe"`
becomes first name `John` and last name `Quincy Doe`, with `middle_name` empty).
Setting this to `true` clears a middle name already stored on a referenced profile.
Supplying a non-empty `middle_name` without this field sets `no_middle_name` to `false`.
When `true`, products that perform criminal-record identity matching exclude records
with a middle name, narrowing matches to subjects with no middle name on record.
When supplied with `profile_id`, the value is persisted to the referenced profile
(same account-scoped profile the check is created against).
Leave as `false` (or omit) if unsure.

  - `results.requested_profile.last_name` (string)
    The last name of the person.

  - `results.requested_profile.dob` (string)
    Date of birth in the form YYYYMMDD.
Must be a valid date and cannot be in the future.
If invalid, the API returns a 400 with a `validation_error` pointing to `/dob`.
    Example: 19950401

  - `results.requested_profile.phone` (string)
    A phone number in the form +[country code][number including area code].
([E.164 format](https://en.wikipedia.org/wiki/E.164)).
Please note that U.S. phone numbers have a country code of "1" so all U.S. phone numbers ought to start with "+1".
A U.S. number supplied in national format (for example "(415) 555-0123") is normalized to E.164
on write. If the value cannot be parsed as a valid phone number, the API returns a 400 with a
`validation_error`.
    Example: +14155552671

  - `results.requested_profile.country_code` (string)
    The phone country calling code supplied for a reverse phone verification (for example, "1" or "54").

  - `results.requested_profile.email` (string)
    An email address.
    Example: john.doe@example.com

  - `results.requested_profile.ssn` (any)
    US Social Security Number.
**Masked by default** — API responses return `XXX-XX-{last4}`. Full SSN is
available via `?unmask_ssn=true` on endpoints that support it (driver checks and
identity verifications), subject to your account's product configuration. Contact
your account representative to enable SSN unmasking.
**Always `null` on list/index endpoints** (e.g. `GET /profiles`, `GET /checks`), regardless
of masking or unmasking settings. Fetch the individual resource (e.g. `GET /profiles/{id}`)
to see the masked or unmasked value for a specific record.
May also be null on a single-resource response when no SSN was provided.
    Example: XXX-XX-6789

  - `results.requested_profile.address` (object)
    A US postal address supplied in a **request** (for example on check create or profile create/update).
When this object is present, `street`, `city`, `state`, and `zip_code` are required.

  - `results.requested_profile.address.street` (string, required)
    Street address, including house/building number and street name.
Apartment or unit numbers may be included; they are stored but are not used for criminal-record address matching.
    Example: 123 Main St

  - `results.requested_profile.address.city` (string, required)
    The name of the city or municipality.
    Example: Frankfort

  - `results.requested_profile.address.state` (string, required)
    A two-letter US state code.
    Example: CA

  - `results.requested_profile.address.zip_code` (string, required)
    US Postal Service ZIP code (5-digit or 9-digit ZIP+4 format).
    Example: 94105

  - `results.requested_profile.address.country` (string)
    A two-letter country code in ISO 3166-1 alpha-2 format.
    Example: US

  - `results.requested_profile.addresses` (array)
    **Request only.** Array of addresses supplied by the caller. Index 0 is the primary address.
When the property is provided, at least one address entry is required.
Maximum 30 addresses.
For check requests, records may be matched against any address in the array.
The singular `address` field remains supported for backwards compatibility and maps to the primary address.

  - `results.requested_profile.custom_id` (string)
    An identifier of your choice, if you wish to use one. Limited to 64 alphanumeric characters, underscores, and hyphens.
    Example: my-custom-id-123

  - `results.requested_profile.driver_license_number` (string)
    The driver license number. Format dependent on State.
    Example: D1234567

  - `results.passenger` (object)

  - `results.passenger.validity` (string)
    Note: for Texas (TX), this reflects Texas DPS's driver eligibility status (license fees,
compliance, and medical certification standing) -- not license validity. It cannot
detect an expired license, and does not indicate the license's expiration date or class.
    Enum: "VALID", "INVALID", "NOT FOUND"

  - `results.order_details` (object)
    Order metadata

  - `results.order_details.result_code` (string)
    Enum: "FOUND", "NOT FOUND", "REJECTED", "LOCKED"

  - `results.driver_information` (object)
    Information regarding the driver's PII

  - `results.driver_information.date_of_birth` (string)
    The driver's date of birth
Note: the following jurisdictions do not provide this information:
- Georgia (GA)
- Illinois (IL)
- New Jersey (NJ)

  - `results.driver_information.license` (object)
    License information

  - `results.driver_information.license.number` (string)
    The license number

  - `results.driver_information.license.jurisdiction` (string)
    The jurisdiction that issued the license

  - `results.driver_information.name` (object)
    The driver's name broken into separate fields

  - `results.driver_information.name.first` (string)
    The driver's first name

  - `results.driver_information.name.middle` (string)
    The driver's middle name

  - `results.driver_information.name.last` (string)
    The driver's last name

  - `results.driver_information.name.suffix` (string)
    The driver's name suffix

  - `results.driver_information.name.raw` (string)
    The driver's full name as received

  - `results.driver_events` (array)
    Events on a driver's record (convictions, violations, citations, abstracts, etc.)

  - `results.driver_events.description` (string)
    A description of the event

  - `results.driver_events.code` (string)
    Normalized code for this type of event

  - `results.driver_events.acd_code` (string)
    Normalized AAMVA Code Dictionary (ACD) code for this event

  - `results.driver_events.type` (string)
    The type of event (conviction, suspension, etc.)

  - `results.driver_events.jurisdiction` (string)
    The jurisdiction the event took place in

  - `results.driver_events.location` (string)
    A more specific location of the event (if provided)

  - `results.driver_events.date` (string)
    The date the event occurred

  - `results.driver_events.disposition_date` (string)
    The date the disposition took effect (if provided)

  - `results.driver_events.disposition` (string)
    The current status or final outcome of the event

  - `results.driver_events.points` (string)
    (Jurisdiction-specific) the number of points affected, added, etc.

  - `results.driver_events.additional_detail` (string)
    Additional detail about the event normally pertaining to speed such as the speed the vehicle was traveling, how fast it was going above the speed limit, whether or not the vehicle was traveling over 100 MPH, etc.

  - `results.crashes` (array)
    Crashes on a driver's record

  - `results.crashes.date` (string)
    An ISO 8601 formatted date string.
    Example: 2020-01-01

  - `results.crashes.type` (string)
    The type of crash

  - `results.crashes.jurisdiction` (string)
    The jurisdiction where the crash occurred.

  - `results.crashes.location` (string)
    A more specific location of the crash (if provided)

  - `results.crashes.description` (string)
    A description of the crash

  - `results.crashes.severity` (string)
    Enum: "AC0", "AC1", "AC2", "AC3", "NEW"

  - `results.crashes.was_citation_issued` (boolean)
    Whether or not a citation was issued for this crash

  - `results.crashes.comments` (array)
    Information related to the section that could not be associated with a named field

  - `results.jurisdiction_actions` (array)
    Actions taken by a jurisdiction on or against a driver (suspensions, revocations, withdrawals, etc.)

  - `results.jurisdiction_actions.type` (string)
    The type of action taken (i.e. suspension, revocation, withdrawal, etc.)

  - `results.jurisdiction_actions.group` (string)
    Removal of Driving Privileges (RDP) Group. This provides additional context as to why an action was taken.
    Enum: "RDP00", "RDP01", "RDP10", "RDP11", "RDP20", "RDP30", "RDP31", "RDP32", "RDP33", "RDP40", "RDP50", "RDP60", "RDP70", "RDP71"

  - `results.jurisdiction_actions.extent_of_action` (string)
    The extent of what privileges are affected by this action

  - `results.jurisdiction_actions.description` (string)
    A description of the action

  - `results.jurisdiction_actions.initiating_jurisdiction` (string)
    The jurisdiction that took or initiated this action

  - `results.jurisdiction_actions.comments` (array)
    Information related to the section that could not be associated with a named field.

  - `results.licenses` (array)
    Licenses associated with the driver

  - `results.licenses.type` (string)
    If the license type is PREVIOUS or OUT OF STATE, the rest of the license information may not be present.
    Enum: "CDL", "CDL PERMIT", "MOTORCYCLE", "MOTORCYCLE PERMIT", "PASSENGER", "PASSENGER PERMIT", "MOPED", "ID CARD", "PREVIOUS", "OUT OF STATE"

  - `results.licenses.validity` (string)
    Enum: "VALID", "INVALID", "UNKNOWN"

  - `results.licenses.jurisdiction` (string)
    The jurisdiction that issued the license

  - `results.licenses.number` (string)
    The license number. Format dependent on State.

  - `results.licenses.class_code` (string)
    Code representing the license class (may not have a value if class_description is provided)

  - `results.licenses.class_description` (string)
    Description of the license class (may not have a value if class_code is provided)

  - `results.licenses.status_code` (string)
    Code representing the license status (may not have a value if status_description is provided)

  - `results.licenses.status_description` (string)
    Description of the license status (may not have a value if status_code is provided)

  - `results.licenses.restrictions` (array)
    Restrictions that apply to the license (must wear corrective lenses, cannot operate a certain type of vehicle, etc.)

  - `results.licenses.restrictions.code` (string)
    Code for the restriction

  - `results.licenses.restrictions.description` (string)
    Description of the restriction

  - `results.licenses.restrictions.category` (string)
    The category of restriction

  - `results.licenses.endorsements` (array)
    Endorsements applied to the license (can drive school buses, drive HAZMAT vehicles, drive truck with double or triple trailers, etc.)

  - `results.licenses.endorsements.code` (string)
    Code for the endorsement

  - `results.licenses.endorsements.description` (string)
    Description of the endorsement

  - `results.licenses.endorsements.category` (string)
    The category of endorsement

  - `results.licenses.comments` (array)
    Information related to the section that could not be associated with a named field

  - `results.miscellaneous` (array)
    Miscellaneous information that could not be categorized into permanent data attributes

  - `results.miscellaneous.description` (string)
    A description of the miscellaneous information

  - `results.miscellaneous.comments` (array)
    Information related to the section that could not be associated with a named field

  - `check_type` (string)
    Enum: "driver_license_status", "motor_vehicle_report"

  - `reference_id` (string)
    A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.
    Example: ref-123

  - `profile_id` (string, required)
    Identifier of an existing profile containing search criteria.
    Example: 2b8313e8-4efd-45a1-b578-952b8313e890

  - `profile` (object, required)
    A profile containing personal information used for checks and verifications.

  - `profile.full_name` (string)
    The full name of the person. Must not be combined with first_name, middle_name, or last_name.
May be combined with `no_middle_name` on create/update; when that flag is `true`, parsing
stores only a first name and surname (any middle token is folded into the last name).

  - `profile.first_name` (string)
    The first name of the person.

  - `profile.middle_name` (string)
    The middle name of the person. Can be null if not provided.

  - `profile.last_name` (string)
    The last name of the person.

  - `profile.dob` (string)
    Date of birth in the form YYYYMMDD.
Must be a valid date and cannot be in the future.
If invalid, the API returns a 400 with a `validation_error` pointing to `/dob`.
    Example: 19950401

  - `profile.country_code` (string)
    The phone country calling code supplied for a reverse phone verification (for example, "1" or "54").

  - `profile.ssn` (any)
    US Social Security Number.
**Masked by default** — API responses return `XXX-XX-{last4}`. Full SSN is
available via `?unmask_ssn=true` on endpoints that support it (driver checks and
identity verifications), subject to your account's product configuration. Contact
your account representative to enable SSN unmasking.
**Always `null` on list/index endpoints** (e.g. `GET /profiles`, `GET /checks`), regardless
of masking or unmasking settings. Fetch the individual resource (e.g. `GET /profiles/{id}`)
to see the masked or unmasked value for a specific record.
May also be null on a single-resource response when no SSN was provided.
    Example: XXX-XX-6789

  - `profile.driver_license_number` (string)
    The driver license number. Format dependent on State.
    Example: D1234567

## Response 400:

  - `400` (unknown)
    Error response

## Response 400 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 401:

  - `401` (unknown)
    Error response

## Response 401 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name

## Response 500:

  - `500` (unknown)
    Error response

## Response 500 fields (application/json):

  - `code` (string, required)
    A machine-readable error code.
    Example: invalid_request

  - `title` (string, required)
    A human-readable error title.
    Example: Invalid Request

  - `source` (object)
    An object containing references to the source of the error.

  - `source.pointer` (string)
    A JSON Pointer [RFC6901] to the associated entity in the request document.
    Example: /data/attributes/first_name