Update an existing Driver License

Request

Updates an existing Driver License for a given candidate.

Note: Updating an existing license to current: true will set any existing current license to current: false.

Security

basic_auth

Path

driver_license_idstringrequired

The Driver License ID.

candidate_idstringrequired

The Candidate's ID.

Bodyapplication/jsonrequired

numberstring

The updated number of the driver license.

Example:"F1111111"

statestring

The updated state that issued the driver license.

Example:"CA"

issued_datestring, (date)

The updated issued date of the driver license.

Example:"2010-01-30"

currentboolean

The updated current status of the driver 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/{driver_license_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "F1111111",
    "state": "CA",
    "issued_date": "2010-01-30",
    "current": true
  }'

Responses

Driver License was successfully updated

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"
}