Sign in

v1

latestOpenAPI 3.0.32026-07-23139110.8 KB
Full Driver Enquiry API

Returns driver data for the supplied driving licence number, including licence details. Optionally returns CPC and tachograph data

post/v1/driving-licences/retrieve

Request body

drivingLicenceNumberstring required

A UK driving licence number

includeCPCboolean

Optional boolean indicating whether to return CPC data. Defaults to false.

includeTachoboolean

Optional boolean indicating whether to return tachograph data. Defaults to false.

acceptPartialResponse'true' | 'false' | 'onConditionCPCAvailable' | 'onConditionTachoAvailable'

Optional enum to indicate whether to accept a partial response. 'true' permits a partial to be returned in all cases, 'false' returns an error response if any of the requested data is unavailable, 'onConditionCPCAvailable' permits a partial response only when cpc data is available and 'onConditionTachoAvailable' permits a partial response only when tachograph data is available. This field defaults to 'false'.

Example request

{
  "drivingLicenceNumber": "ABCDE123456AB1AB"
}

Response

Successful Response. Returns a combination of driver, tachograph and cpc data

Example response

{
  "driver": {
    "drivingLicenceNumber": "ABCDE123456AB1AB",
    "firstNames": "JOHN",
    "lastName": "DOE",
    "dateOfBirth": "2019-12-31",
    "address": {
      "unstructuredAddress": {
        "line1": "5 HIGH STREET",
        "line2": "GARNET",
        "line3": "AMMANFORD",
        "line4": "CARMARTHENSHIRE",
        "line5": "WALES",
        "postcode": "SA18 1AB"
      }
    },
    "disqualifiedUntil": "2019-12-31"
  },
  "entitlement": [
    {
      "categoryCode": "A1",
      "categoryLegalLiteral": "Motorbikes with engine size up to 125 cc, power output up to 11 kW and power/weight ratio up to 0.1 kW/kg",
      "fromDate": "2019-12-31",
      "expiryDate": "2019-12-31",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "endorsements": [
    {
      "disqualification": {
        "years": 3,
        "months": 1,
        "days": 1,
        "startDate": "2019-12-31"
      },
      "offenceCode": "DD30",
      "offenceDate": "2019-12-31",
      "convictionDate": "2019-12-31",
      "disqualificationRemovalDate": "2019-12-31",
      "disqualificationReimposedDate": "2019-12-31",
      "disqualificationSuspendedPendingAppealDate": "2019-12-31",
      "sentenceDate": "2019-12-31",
      "penaltyPointsExpiryDate": "2019-12-31"
    }
  ],
  "testPass": [
    {
      "testDate": "2019-12-31"
    }
  ],
  "token": {
    "validFromDate": "2019-12-31",
    "validToDate": "2019-12-31"
  },
  "cpc": {
    "cpcs": [
      {
        "lgvValidTo": "2019-12-31",
        "pcvValidTo": "2019-12-31"
      }
    ]
  },
  "holder": {
    "tachoCards": [
      {
        "cardExpiryDate": "2019-12-31",
        "cardStartOfValidityDate": "2019-12-31"
      }
    ]
  }
}
All 1 operations