Skip to content

Driver Licenses

The driver licenses resource represents a single driver license for a candidate. Candidates may have one current driver license and may have any number of previous driver licenses.

Operations

Create a new Driver License

Request

Creates a new Driver License for a given candidate.

If a current driver license is created for a candidate with an existing driver license marked current, the existing license will be updated to reflect that it is no longer current.

If a candidate_driver_license exists with the state and number passed in with the POST request, a new license will not be created. The current and issued_date values of the existing license will be updated with on the parameters passed.

Note: When a new driver license is created, Checkr will attempt to apply the new license information to resolve any existing exceptions for the candidate's most recent MVR screening if the screening has not yet produced reportable results.

See Driver License validation in the Reference section for a list of valid driver license number input by state.

Security
basic_auth
Path
candidate_idstringrequired

The Candidate's ID.

Bodyapplication/jsonrequired
numberstringrequired

The driver license number.

Example:"F2222222"
statestringrequired

The state that issued the driver license.

Example:"CA"
issued_datestring, (date)

The issued date of the driver license.

Example:"2010-01-30"
currentbooleanrequired

Defines whether the driver license is the candidate's current license. true if the license is the candidate's current license, false otherwise.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/driver_licenses' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "F2222222",
    "state": "CA",
    "issued_date": "2010-01-30",
    "current": true
  }'

Responses

Driver License was successfully created

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstringread-only
Value:"candidate_driver_license"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/candidates/551564b7865af96a28b13f36/driver_licenses/e44aa283528e6fde7d542194"
candidate_idstring

ID of the candidate.

Example:"551564b7865af96a28b13f36"
numberstring

The driver license number.

Example:"F2222222"
statestring

The state that issued the driver license.

Example:"CA"
issued_datesArray of objects

An array of issued date objects

Example:
[
  {
    "value": "2010-01-30",
    "source": "client"
  }
]
currentboolean

Defines whether the driver license is the candidate's current license.

Example:true
sourcestring

Where/how Checkr learned about the license.

Default:"Other"
Example:"Self-Disclosure"
Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "candidate_driver_license",
  "uri": "/v1/candidates/551564b7865af96a28b13f36/driver_licenses/e44aa283528e6fde7d542194",
  "candidate_id": "551564b7865af96a28b13f36",
  "number": "F2222222",
  "state": "CA",
  "issued_dates": [
    { … }
  ],
  "current": true,
  "source": "Self-Disclosure"
}
© Checkr, Inc.