Skip to main content

driver-view-external v1.6.0

Service to retrieve driver, and optionally tachograph and CPC data for a driving licence number

Click here to see this OpenAPI specification in JSON format.

Base URLs

Authentication

  • API Key (jwtAuth)

    • Parameter Name: Authorization, in: header. Valid JWT token issued as a result of authentication against the API gateway.
  • API Key (apiKeyAuth)

    • Parameter Name: X-API-Key, in: header. API key used to access the service.

Full Driver Enquiry API

post__v1_driving-licences_retrieve

POST /v1/driving-licences/retrieve

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


Parameters

Name In Type Required Restrictions Description
body body drivingLicenceRequest true none The full driving licence number to be enquired upon including the check digits. Options are available to include CPC and tachograph data and to accept/reject partial responses (when unexpected techncial problems prevent CPC or tachograph data from being retrieved for the enquiry).

Example Request

curl -X POST  -d '{
  "drivingLicenceNumber": "ABCDE123456AB1AB",
  "includeCPC": false,
  "includeTacho": false,
  "acceptPartialResponse": "false"
}' https://driver-vehicle-licensing.api.gov.uk/full-driver-enquiry/v1/driving-licences/retrieve \
 -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: API_KEY'

Responses

Status Meaning Description Schema
200 OK Successful Response. Returns a combination of driver, tachograph and cpc data viewDriverResponse
400 Bad Request Bad Request. The server could not understand the request due to invalid syntax. errorResponse
401 Unauthorized Unauthorised. errorResponse
403 Forbidden Forbidden. No access to the requested resource. errorResponse
404 Not Found Record for supplied driving licence number cannot be found. errorResponse
429 Too Many Requests Too many requests in a given period of time. errorResponse
500 Internal Server Error The service encountered an unspecified error. errorResponse
502 Bad Gateway The service encountered an unspecified error. errorResponse
503 Service Unavailable The service encountered an unspecified error. errorResponse
504 Gateway Time-out The service encountered an unspecified network error. errorResponse

Additional common error responses are listed in the Common Error Responses page.

Example Response

Successful Response - Full driving licence with restrictions and endorsements

{
  "driver": {
    "drivingLicenceNumber": "TCAEU610267NO9EK",
    "firstNames": "NPBPG OYOT",
    "lastName": "TCAEUCJ",
    "gender": "Male",
    "dateOfBirth": "1967-10-26",
    "address": {
      "unstructuredAddress": {
        "line1": "78 A TEST DATA DO NOT DELIVER",
        "line5": "GREAT YARMOUTH",
        "postcode": "NR30 4BH"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "entitlement": [
    {
      "categoryCode": "A",
      "categoryLegalLiteral": "A motorcycle of a power exceeding 35 kW or with a power to weight ratio exceeding 0.2 kW per kg, or A motorcycle of a power not exceeding 35 kW with a power to weight ratio not exceeding 0.2 kW per kg and derived from a vehicle of more than double its power. A motor tricycle with a power exceeding 15 kW",
      "categoryType": "Full",
      "fromDate": "2013-01-19",
      "expiryDate": "2037-10-25",
      "restrictions": [
        {
          "restrictionCode": "79(03)",
          "restrictionLiteral": "Restricted to tricycles"
        }
      ]
    }
  ],
  "endorsements": [
    {
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2018-04-28",
      "penaltyPoints": 3
    }
  ],
  "token": {
    "validFromDate": "1999-04-11",
    "validToDate": "2037-10-25",
    "issueNumber": "69"
  }
}

Successful Response - Full driving licence, driver disqualified for life

{
  "driver": {
    "drivingLicenceNumber": "LQZVJ603206B99ZY",
    "firstNames": "BKNTPL",
    "lastName": "LQZVJMTJ",
    "gender": "Male",
    "dateOfBirth": "1966-03-20",
    "address": {
      "unstructuredAddress": {
        "line1": "02 B TEST DATA DO NOT DELIVER",
        "line5": "LIVERPOOL",
        "postcode": "L8 0SW"
      }
    },
    "disqualifiedForLife": true
  },
  "licence": {
    "type": "Full",
    "status": "Disqualified",
    "statusQualifier": "For life"
  },
  "endorsements": [
    {
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2017-07-04",
      "penaltyPoints": 3
    },
    {
      "offenceCode": "SP50",
      "offenceLegalLiteral": "Exceeding speed limit on a motorway",
      "offenceDate": "2017-08-19",
      "penaltyPoints": 3
    },
    {
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2018-05-01",
      "penaltyPoints": 3
    },
    {
      "disqualification": {
        "forLife": true
      },
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2022-12-21",
      "convictionDate": "2023-01-01"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B1",
      "categoryLegalLiteral": "Motor vehicles with 4 wheels up to 400 kg unladen or 550 kg if they're designed for carrying goods",
      "categoryType": "Full",
      "fromDate": "1991-06-18",
      "expiryDate": "2023-01-01"
    }
  ],
  "token": {
    "validFromDate": "1991-07-03",
    "validToDate": "2036-03-19",
    "issueNumber": "94"
  }
}

Successful Response - Full driving licence, driver disqualified until sentenced

{
  "driver": {
    "drivingLicenceNumber": "NDSRZ904116AN9CN",
    "firstNames": "AOE NRKT",
    "lastName": "N'HVCTN",
    "gender": "Male",
    "dateOfBirth": "1996-04-11",
    "address": {
      "unstructuredAddress": {
        "line1": "941  TEST DATA DO NOT DELIVER",
        "line5": "BIRMINGHAM",
        "postcode": "B25 8SN"
      }
    },
    "disqualifiedPendingSentence": true
  },
  "licence": {
    "type": "Full",
    "status": "Disqualified",
    "statusQualifier": "Pending sentence"
  },
  "entitlement": [
    {
      "categoryCode": "C",
      "categoryLegalLiteral": "Vehicles weighing over 3,500 kg (with a trailer up to 750 kg), with no more than 8 passengers and driver",
      "categoryType": "Full",
      "fromDate": "2015-07-08",
      "expiryDate": "2019-01-21"
    }
  ],
  "endorsements": [
    {
      "offenceCode": "DD10",
      "offenceLegalLiteral": "Causing serious injury by dangerous driving",
      "offenceDate": "2017-12-15",
      "convictionDate": "2019-01-21"
    }
  ],
  "token": {
    "validFromDate": "2016-03-18",
    "validToDate": "2020-08-03",
    "issueNumber": "21"
  }
}

Provisional licence

{
  "driver": {
    "drivingLicenceNumber": "BBUWI604072H99JF",
    "firstNames": "HZFW",
    "lastName": "BBUWIQUZD",
    "gender": "Male",
    "dateOfBirth": "1962-04-07",
    "address": {
      "unstructuredAddress": {
        "line1": "9 PH TEST DATA DO NOT DELIVER",
        "line5": "WHITLEY BAY",
        "postcode": "NE26 3P"
      }
    }
  },
  "licence": {
    "type": "Provisional",
    "status": "Valid"
  },
  "entitlement": [
    {
      "categoryCode": "C1",
      "categoryLegalLiteral": "Vehicles weighing between 3,500 and 7,500 kg (with a trailer up to 750 kg), with no more than 8 passengers and driver",
      "categoryType": "Provisional",
      "fromDate": "1984-03-21",
      "expiryDate": "2032-04-06"
    }
  ],
  "endorsements": [],
  "token": {
    "validFromDate": "1984-03-21",
    "validToDate": "2032-04-06",
    "issueNumber": "33"
  }
}

Successful Response - Full driving licence, CPC and tachograph data

{
  "driver": {
    "drivingLicenceNumber": "AFEBL412082FW9CT",
    "lastName": "AFEBL",
    "gender": "Male",
    "firstNames": "FOXBRJG WKVT O",
    "dateOfBirth": "1942-12-08",
    "address": {
      "unstructuredAddress": {
        "line1": "57 G TEST DATA DO NOT DELIVER",
        "line2": "RUMNEY",
        "line5": "CARDIFF",
        "postcode": "CF3 3LX"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "endorsements": [
    {
      "penaltyPoints": 3,
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2016-07-07"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B",
      "categoryLegalLiteral": "Vehicles up to 3,500 kg Maximum Authorised Mass (MAM) with up to 8 passenger seats and driver (with a trailer up to 750 kg). Can also tow heavier trailers if the total weight of vehicle and trailer isn't more than 3,500 kg. Physically disabled drivers with provisional category B entitlement will also have provisional entitlement to ride category A1 or A motor tricycles. Able-bodied drivers can no longer ride motor tricycles with a provisional category B licence",
      "categoryType": "Full",
      "fromDate": "1975-07-15",
      "expiryDate": "2021-12-07",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "token": {
    "issueNumber": "01",
    "validFromDate": "2018-10-11",
    "validToDate": "2021-12-07"
  },
  "cpc": {
    "cpcs": [
      {
        "lgvValidTo": "2023-03-27",
        "pcvValidTo": "2022-06-09"
      }
    ]
  },
  "dqc": {
    "dqcs": [
      {
        "issueDate": "2019-05-04"
      }
    ]
  },
  "holder": {
    "tachoCards": [
      {
        "cardNumber": "DB08311162038002",
        "cardStatus": "DISPATCHED",
        "cardExpiryDate": "2028-03-01",
        "cardStartOfValidityDate": "2023-03-02"
      }
    ]
  }
}

Successful Response - Full driving licence and CPC data

{
  "driver": {
    "drivingLicenceNumber": "AFEBL412082FW9CT",
    "lastName": "AFEBL",
    "gender": "Male",
    "firstNames": "FOXBRJG WKVT O",
    "dateOfBirth": "1942-12-08",
    "address": {
      "unstructuredAddress": {
        "line1": "57 G TEST DATA DO NOT DELIVER",
        "line2": "RUMNEY",
        "line5": "CARDIFF",
        "postcode": "CF3 3LX"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "endorsements": [
    {
      "penaltyPoints": 3,
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2016-07-07"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B",
      "categoryLegalLiteral": "Vehicles up to 3,500 kg Maximum Authorised Mass (MAM) with up to 8 passenger seats and driver (with a trailer up to 750 kg). Can also tow heavier trailers if the total weight of vehicle and trailer isn't more than 3,500 kg. Physically disabled drivers with provisional category B entitlement will also have provisional entitlement to ride category A1 or A motor tricycles. Able-bodied drivers can no longer ride motor tricycles with a provisional category B licence",
      "categoryType": "Full",
      "fromDate": "1975-07-15",
      "expiryDate": "2021-12-07",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "token": {
    "issueNumber": "01",
    "validFromDate": "2018-10-11",
    "validToDate": "2021-12-07"
  },
  "cpc": {
    "cpcs": [
      {
        "lgvValidTo": "2023-03-27",
        "pcvValidTo": "2022-06-09"
      }
    ]
  },
  "dqc": {
    "dqcs": [
      {
        "issueDate": "2019-05-04"
      }
    ]
  }
}

Successful Response - Full driving licence and tachograph data

{
  "driver": {
    "drivingLicenceNumber": "AFEBL412082FW9CT",
    "lastName": "AFEBL",
    "gender": "Male",
    "firstNames": "FOXBRJG WKVT O",
    "dateOfBirth": "1942-12-08",
    "address": {
      "unstructuredAddress": {
        "line1": "57 G TEST DATA DO NOT DELIVER",
        "line2": "RUMNEY",
        "line5": "CARDIFF",
        "postcode": "CF3 3LX"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "endorsements": [
    {
      "penaltyPoints": 3,
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2016-07-07"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B",
      "categoryLegalLiteral": "Vehicles up to 3,500 kg Maximum Authorised Mass (MAM) with up to 8 passenger seats and driver (with a trailer up to 750 kg). Can also tow heavier trailers if the total weight of vehicle and trailer isn't more than 3,500 kg. Physically disabled drivers with provisional category B entitlement will also have provisional entitlement to ride category A1 or A motor tricycles. Able-bodied drivers can no longer ride motor tricycles with a provisional category B licence",
      "categoryType": "Full",
      "fromDate": "1975-07-15",
      "expiryDate": "2021-12-07",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "token": {
    "issueNumber": "01",
    "validFromDate": "2018-10-11",
    "validToDate": "2021-12-07"
  },
  "holder": {
    "tachoCards": [
      {
        "cardNumber": "DB08311162038002",
        "cardStatus": "DISPATCHED",
        "cardExpiryDate": "2028-03-01",
        "cardStartOfValidityDate": "2023-03-02"
      }
    ]
  }
}

Successful Response - Full driving licence, CPC and tachograph data (accept partial response, CPC and tachograph services unavailable)

{
  "driver": {
    "drivingLicenceNumber": "AFEBL412082FW9CT",
    "lastName": "AFEBL",
    "gender": "Male",
    "firstNames": "FOXBRJG WKVT O",
    "dateOfBirth": "1942-12-08",
    "address": {
      "unstructuredAddress": {
        "line1": "57 G TEST DATA DO NOT DELIVER",
        "line2": "RUMNEY",
        "line5": "CARDIFF",
        "postcode": "CF3 3LX"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "endorsements": [
    {
      "penaltyPoints": 3,
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2016-07-07"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B",
      "categoryLegalLiteral": "Vehicles up to 3,500 kg Maximum Authorised Mass (MAM) with up to 8 passenger seats and driver (with a trailer up to 750 kg). Can also tow heavier trailers if the total weight of vehicle and trailer isn't more than 3,500 kg. Physically disabled drivers with provisional category B entitlement will also have provisional entitlement to ride category A1 or A motor tricycles. Able-bodied drivers can no longer ride motor tricycles with a provisional category B licence",
      "categoryType": "Full",
      "fromDate": "1975-07-15",
      "expiryDate": "2021-12-07",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "token": {
    "issueNumber": "01",
    "validFromDate": "2018-10-11",
    "validToDate": "2021-12-07"
  },
  "errors": [
    {
      "status": "503",
      "code": "ENQ068",
      "detail": "CPC data currently unavailable"
    },
    {
      "status": "503",
      "code": "ENQ069",
      "detail": "Tachograph data currently unavailable"
    }
  ]
}

Successful Response - Full driving licence, CPC and tachograph data (accept partial response, CPC data unavailable)

{
  "driver": {
    "drivingLicenceNumber": "AFEBL412082FW9CT",
    "lastName": "AFEBL",
    "gender": "Male",
    "firstNames": "FOXBRJG WKVT O",
    "dateOfBirth": "1942-12-08",
    "address": {
      "unstructuredAddress": {
        "line1": "57 G TEST DATA DO NOT DELIVER",
        "line2": "RUMNEY",
        "line5": "CARDIFF",
        "postcode": "CF3 3LX"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "endorsements": [
    {
      "penaltyPoints": 3,
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2016-07-07"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B",
      "categoryLegalLiteral": "Vehicles up to 3,500 kg Maximum Authorised Mass (MAM) with up to 8 passenger seats and driver (with a trailer up to 750 kg). Can also tow heavier trailers if the total weight of vehicle and trailer isn't more than 3,500 kg. Physically disabled drivers with provisional category B entitlement will also have provisional entitlement to ride category A1 or A motor tricycles. Able-bodied drivers can no longer ride motor tricycles with a provisional category B licence",
      "categoryType": "Full",
      "fromDate": "1975-07-15",
      "expiryDate": "2021-12-07",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "token": {
    "issueNumber": "01",
    "validFromDate": "2018-10-11",
    "validToDate": "2021-12-07"
  },
  "holder": {
    "tachoCards": [
      {
        "cardNumber": "DB08311162038002",
        "cardStatus": "DISPATCHED",
        "cardExpiryDate": "2028-03-01",
        "cardStartOfValidityDate": "2023-03-02"
      }
    ]
  },
  "errors": [
    {
      "status": "503",
      "code": "ENQ068",
      "detail": "CPC data currently unavailable"
    }
  ]
}

Successful Response - Full driving licence, CPC and tachograph (accept partial response, tachograph service unavailable)

{
  "driver": {
    "drivingLicenceNumber": "AFEBL412082FW9CT",
    "lastName": "AFEBL",
    "gender": "Male",
    "firstNames": "FOXBRJG WKVT O",
    "dateOfBirth": "1942-12-08",
    "address": {
      "unstructuredAddress": {
        "line1": "57 G TEST DATA DO NOT DELIVER",
        "line2": "RUMNEY",
        "line5": "CARDIFF",
        "postcode": "CF3 3LX"
      }
    }
  },
  "licence": {
    "type": "Full",
    "status": "Valid"
  },
  "endorsements": [
    {
      "penaltyPoints": 3,
      "offenceCode": "SP30",
      "offenceLegalLiteral": "Exceeding statutory speed limit on a public road",
      "offenceDate": "2016-07-07"
    }
  ],
  "entitlement": [
    {
      "categoryCode": "B",
      "categoryLegalLiteral": "Vehicles up to 3,500 kg Maximum Authorised Mass (MAM) with up to 8 passenger seats and driver (with a trailer up to 750 kg). Can also tow heavier trailers if the total weight of vehicle and trailer isn't more than 3,500 kg. Physically disabled drivers with provisional category B entitlement will also have provisional entitlement to ride category A1 or A motor tricycles. Able-bodied drivers can no longer ride motor tricycles with a provisional category B licence",
      "categoryType": "Full",
      "fromDate": "1975-07-15",
      "expiryDate": "2021-12-07",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "token": {
    "issueNumber": "01",
    "validFromDate": "2018-10-11",
    "validToDate": "2021-12-07"
  },
  "cpc": {
    "cpcs": [
      {
        "lgvValidTo": "2023-03-27",
        "pcvValidTo": "2022-06-09"
      }
    ]
  },
  "dqc": {
    "dqcs": [
      {
        "issueDate": "2019-05-04"
      }
    ]
  },
  "errors": [
    {
      "status": "503",
      "code": "ENQ069",
      "detail": "Tachograph data currently unavailable"
    }
  ]
}

400 Response

{
  "errors": [
    {
      "status": "400",
      "code": "BRQ001",
      "detail": "Bad request"
    }
  ]
}

401 Response

{
  "errors": [
    {
      "status": "401",
      "code": "Unauthorized",
      "detail": "API Key or JWT is either not provided, expired or invalid"
    }
  ]
}

403 Response

{
  "errors": [
    {
      "status": "403",
      "code": "Forbidden",
      "detail": "Access Denied"
    }
  ]
}

404 Response - Record for supplied driving licence number cannot be found.

{
  "errors": [
    {
      "status": "404",
      "code": "ENQ018",
      "detail": "For the given drivingLicenceNumber field, no driver record could be found"
    }
  ]
}

404 Response - Record for supplied driving licence number not available for enquiry via this service.

{
  "errors": [
    {
      "status": "404",
      "code": "ENQ037",
      "detail": "Record for supplied driving licence number not available for enquiry via this service"
    }
  ]
}

429 Response

{
  "errors": [
    {
      "status": "429",
      "code": "Throttled",
      "detail": "Too many requests"
    }
  ]
}

500 Response

{
  "errors": [
    {
      "status": "500",
      "code": "ENQ000",
      "detail": "System error occurred"
    }
  ]
}

502 Response

{
  "errors": [
    {
      "status": "502",
      "code": "ENQ000",
      "detail": "System error occurred"
    }
  ]
}

502 Response - CPC and tachograph data unavailable and partial response not acceptable to consumer.

{
  "errors": [
    {
      "code": "ENQ068",
      "detail": "CPC data currently unavailable",
      "status": "503"
    },
    {
      "code": "ENQ069",
      "detail": "Tachograph data currently unavailable",
      "status": "503"
    }
  ]
}

502 Response - CPC data unavailable and partial response not acceptable to consumer.

{
  "errors": [
    {
      "code": "ENQ068",
      "detail": "CPC data currently unavailable",
      "status": "503"
    }
  ]
}

502 Response - Tachograph data unavailable and partial response not acceptable to consumer.

{
  "errors": [
    {
      "code": "ENQ069",
      "detail": "Tachograph data currently unavailable",
      "status": "503"
    }
  ]
}

504 Response

{
  "errors": [
    {
      "status": "504",
      "code": "ENQ000",
      "detail": "System error occurred"
    }
  ]
}

Response Headers

Status Header Type Format Description
200 X-DVLA-Request-Id string uuid Request Id to trace the API request.
400 X-DVLA-Request-Id string uuid Request Id to trace the API request.
401 X-DVLA-Request-Id string uuid Request Id to trace the API request.
403 X-DVLA-Request-Id string uuid Request Id to trace the API request.
404 X-DVLA-Request-Id string uuid Request Id to trace the API request.
429 X-DVLA-Request-Id string uuid Request Id to trace the API request.
500 X-DVLA-Request-Id string uuid Request Id to trace the API request.
502 X-DVLA-Request-Id string uuid Request Id to trace the API request.
503 X-DVLA-Request-Id string uuid Request Id to trace the API request.
504 X-DVLA-Request-Id string uuid Request Id to trace the API request.

Schemas

drivingLicenceRequest

{
  "drivingLicenceNumber": "ABCDE123456AB1AB",
  "includeCPC": true,
  "includeTacho": true,
  "acceptPartialResponse": "false"
}

Properties

Name Type Required Restrictions Description
drivingLicenceNumber drivingLicenceNumber true none A UK driving licence number
includeCPC includeCPC false none Optional boolean indicating whether to return CPC data. Defaults to false.
includeTacho includeTacho false none Optional boolean indicating whether to return tachograph data. Defaults to false.
acceptPartialResponse acceptPartialResponse false none 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’.

viewDriverResponse

{
  "driver": {
    "drivingLicenceNumber": "ABCDE123456AB1AB",
    "firstNames": "JOHN",
    "lastName": "DOE",
    "gender": "Male",
    "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",
    "disqualifiedForLife": true,
    "disqualifiedPendingSentence": true
  },
  "licence": {
    "type": "Provisional",
    "status": "Valid",
    "statusQualifier": "For re-assessment only"
  },
  "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",
      "categoryType": "Provisional",
      "fromDate": "2019-12-31",
      "expiryDate": "2019-12-31",
      "restrictions": [
        {
          "restrictionCode": "01",
          "restrictionLiteral": "Eyesight Correction"
        }
      ]
    }
  ],
  "endorsements": [
    {
      "disqualification": {
        "type": "string",
        "forLife": true,
        "years": 3,
        "months": 1,
        "days": 1
      },
      "offenceCode": "DD30",
      "offenceLegalLiteral": "string",
      "offenceDate": "2019-12-31",
      "convictionDate": "2019-12-31",
      "penaltyPoints": 0
    }
  ],
  "token": {
    "validFromDate": "2019-12-31",
    "validToDate": "2019-12-31",
    "issueNumber": "string"
  },
  "cpc": {
    "cpcs": [
      {
        "lgvValidTo": "2019-12-31",
        "pcvValidTo": "2019-12-31"
      }
    ]
  },
  "dqc": {
    "dqcs": [
      {
        "issueDate": "2019-12-31"
      }
    ]
  },
  "holder": {
    "tachoCards": [
      {
        "cardNumber": "string",
        "cardStatus": "string",
        "cardExpiryDate": "2019-12-31",
        "cardStartOfValidityDate": "2019-12-31"
      }
    ]
  },
  "errors": [
    {
      "status": "string",
      "code": "string",
      "detail": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
driver driver false none Driver details for a given driving licence number
licence licence false none Details of a drivers licence information
entitlement [entitlementRecord] false none none
endorsements [endorsements] false none none
token token false none The driving licence details as on the physical driving licence
cpc cpcResponse false none none
dqc dqcResponse false none none
holder holder false none none
errors errors false none none

drivingLicenceNumber

"ABCDE123456AB1AB"

A UK driving licence number

Properties

Name Type Required Restrictions Description
anonymous string false Pattern: ^[a-zA-Z0-9]*$
Min length: 5
Max length: 16
A UK driving licence number

includeCPC

true

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

Properties

Name Type Required Restrictions Description
anonymous boolean false none Optional boolean indicating whether to return CPC data. Defaults to false.

includeTacho

true

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

Properties

Name Type Required Restrictions Description
anonymous boolean false none Optional boolean indicating whether to return tachograph data. Defaults to false.

acceptPartialResponse

"false"

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’.

Properties

Name Type Required Restrictions Description
anonymous string false Enum: 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’.

Enumerated Values

Property Value
anonymous true
anonymous false
anonymous onConditionCPCAvailable
anonymous onConditionTachoAvailable

driver

{
  "drivingLicenceNumber": "ABCDE123456AB1AB",
  "firstNames": "JOHN",
  "lastName": "DOE",
  "gender": "Male",
  "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",
  "disqualifiedForLife": true,
  "disqualifiedPendingSentence": true
}

Driver details for a given driving licence number

Properties

Name Type Required Restrictions Description
drivingLicenceNumber drivingLicenceNumber true none A UK driving licence number
firstNames firstNames false none First name(s) of a driver
lastName lastName false none Last name of a driver
gender gender false none none
dateOfBirth date false none Date in the format YYYY-MM-DD
address address false none Address in a unstructured format
disqualifiedUntil date false none Date in the format YYYY-MM-DD
disqualifiedForLife boolean false none If present, will only be true and replaces disqualifiedUntil
disqualifiedPendingSentence boolean false none If present, will only be true and replaces disqualifiedUntil

licence

{
  "type": "Provisional",
  "status": "Valid",
  "statusQualifier": "For re-assessment only"
}

Details of a drivers licence information

Properties

Name Type Required Restrictions Description
type licenceType true none The type of licence
status licenceStatus true none The current activation state of the licence
statusQualifier statusQualifier false none Information or restrictions relating to the status of a licence

entitlementRecord

{
  "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",
  "categoryType": "Provisional",
  "fromDate": "2019-12-31",
  "expiryDate": "2019-12-31",
  "restrictions": [
    {
      "restrictionCode": "01",
      "restrictionLiteral": "Eyesight Correction"
    }
  ]
}

Properties

Name Type Required Restrictions Description
categoryCode categoryCode false none Licence category code
categoryLegalLiteral categoryLegalLiteral false none none
categoryType categoryType false none none
fromDate date false none Date in the format YYYY-MM-DD
expiryDate date false none Date in the format YYYY-MM-DD
restrictions [object] false none none
» restrictionCode restrictionCode true none Restriction code
» restrictionLiteral string false none none

endorsements

{
  "disqualification": {
    "type": "string",
    "forLife": true,
    "years": 3,
    "months": 1,
    "days": 1
  },
  "offenceCode": "DD30",
  "offenceLegalLiteral": "string",
  "offenceDate": "2019-12-31",
  "convictionDate": "2019-12-31",
  "penaltyPoints": 0
}

Properties

Name Type Required Restrictions Description
disqualification disqualification false none none
offenceCode offenceCode false none The code of the offence causing the endorsement
offenceLegalLiteral string false none none
offenceDate date false none Date in the format YYYY-MM-DD
convictionDate date false none Date in the format YYYY-MM-DD
penaltyPoints integer false none none

token

{
  "validFromDate": "2019-12-31",
  "validToDate": "2019-12-31",
  "issueNumber": "string"
}

The driving licence details as on the physical driving licence

Properties

Name Type Required Restrictions Description
validFromDate date false none Date in the format YYYY-MM-DD
validToDate date false none Date in the format YYYY-MM-DD
issueNumber string false none none

cpcResponse

{
  "cpcs": [
    {
      "lgvValidTo": "2019-12-31",
      "pcvValidTo": "2019-12-31"
    }
  ]
}

Properties

Name Type Required Restrictions Description
cpcs [cpc] false none none

cpc

{
  "lgvValidTo": "2019-12-31",
  "pcvValidTo": "2019-12-31"
}

Properties

Name Type Required Restrictions Description
lgvValidTo date false none Date in the format YYYY-MM-DD
pcvValidTo date false none Date in the format YYYY-MM-DD

dqcResponse

{
  "dqcs": [
    {
      "issueDate": "2019-12-31"
    }
  ]
}

Properties

Name Type Required Restrictions Description
dqcs [dqc] false none none

dqc

{
  "issueDate": "2019-12-31"
}

Properties

Name Type Required Restrictions Description
issueDate date false none Date in the format YYYY-MM-DD

holder

{
  "tachoCards": [
    {
      "cardNumber": "string",
      "cardStatus": "string",
      "cardExpiryDate": "2019-12-31",
      "cardStartOfValidityDate": "2019-12-31"
    }
  ]
}

Properties

Name Type Required Restrictions Description
tachoCards [tachoCard] false none none

tachoCard

{
  "cardNumber": "string",
  "cardStatus": "string",
  "cardExpiryDate": "2019-12-31",
  "cardStartOfValidityDate": "2019-12-31"
}

Properties

Name Type Required Restrictions Description
cardNumber string false none none
cardStatus string false none The current state of the card
cardExpiryDate date false none Date in the format YYYY-MM-DD
cardStartOfValidityDate date false none Date in the format YYYY-MM-DD

firstNames

"JOHN"

First name(s) of a driver

Properties

Name Type Required Restrictions Description
anonymous string false none First name(s) of a driver

lastName

"DOE"

Last name of a driver

Properties

Name Type Required Restrictions Description
anonymous string false none Last name of a driver

gender

"Male"

Properties

Name Type Required Restrictions Description
anonymous string false Enum: Male,Female
none

Enumerated Values

Property Value
anonymous Male
anonymous Female

date

"2019-12-31"

Date in the format YYYY-MM-DD

Properties

Name Type Required Restrictions Description
anonymous string(date) false none Date in the format YYYY-MM-DD

address

{
  "unstructuredAddress": {
    "line1": "5 HIGH STREET",
    "line2": "GARNET",
    "line3": "AMMANFORD",
    "line4": "CARMARTHENSHIRE",
    "line5": "WALES",
    "postcode": "SA18 1AB"
  }
}

Address in a unstructured format

Properties

Name Type Required Restrictions Description
unstructuredAddress unstructuredAddress false none Unstructured address

unstructuredAddress

{
  "line1": "5 HIGH STREET",
  "line2": "GARNET",
  "line3": "AMMANFORD",
  "line4": "CARMARTHENSHIRE",
  "line5": "WALES",
  "postcode": "SA18 1AB"
}

Unstructured address

Properties

Name Type Required Restrictions Description
line1 string false Min length: 1
Max length: 45
none
line2 string false Max length: 45
none
line3 string false Max length: 45
none
line4 string false Max length: 45
none
line5 string false Max length: 45
none
postcode string false none none

licenceType

"Provisional"

The type of licence

Properties

Name Type Required Restrictions Description
anonymous string false Enum: Provisional,Full
The type of licence

Enumerated Values

Property Value
anonymous Provisional
anonymous Full

licenceStatus

"Valid"

The current activation state of the licence

Properties

Name Type Required Restrictions Description
anonymous string false Enum: Valid,Disqualified,Revoked,Surrendered,Expired,Exchanged,Refused
The current activation state of the licence

Enumerated Values

Property Value
anonymous Valid
anonymous Disqualified
anonymous Revoked
anonymous Surrendered
anonymous Expired
anonymous Exchanged
anonymous Refused

statusQualifier

"For re-assessment only"

Information or restrictions relating to the status of a licence

Properties

Name Type Required Restrictions Description
anonymous string false Enum: For re-assessment only,Photo licence invitation sent,Short period disqualification,Until test passed,Until extended test passed,Pending sentence,For life
Information or restrictions relating to the status of a licence

Enumerated Values

Property Value
anonymous For re-assessment only
anonymous Photo licence invitation sent
anonymous Short period disqualification
anonymous Until test passed
anonymous Until extended test passed
anonymous Pending sentence
anonymous For life

categoryCode

"A1"

Licence category code

Properties

Name Type Required Restrictions Description
anonymous string false none Licence category code

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"

Properties

Name Type Required Restrictions Description
anonymous string false none none

categoryType

"Provisional"

Properties

Name Type Required Restrictions Description
anonymous string false Enum: Provisional,Full
none

Enumerated Values

Property Value
anonymous Provisional
anonymous Full

restrictionCode

"01"

Restriction code

Properties

Name Type Required Restrictions Description
anonymous string false none Restriction code

disqualification

{
  "type": "string",
  "forLife": true,
  "years": 3,
  "months": 1,
  "days": 1
}

Properties

Name Type Required Restrictions Description
type string false none none
forLife boolean false none none
years years false none Number of years
months months false none Number of months
days days false none Number of days

years

3

Number of years

Properties

Name Type Required Restrictions Description
anonymous integer false none Number of years

months

1

Number of months

Properties

Name Type Required Restrictions Description
anonymous integer false none Number of months

days

1

Number of days

Properties

Name Type Required Restrictions Description
anonymous integer false none Number of days

offenceCode

"DD30"

The code of the offence causing the endorsement

Properties

Name Type Required Restrictions Description
anonymous string false none The code of the offence causing the endorsement

errorResponse

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "detail": "string"
    }
  ]
}

List of error responses

Properties

Name Type Required Restrictions Description
errors errors false none none

errors

[
  {
    "status": "string",
    "code": "string",
    "detail": "string"
  }
]

Properties

Name Type Required Restrictions Description
anonymous [error] false none none

error

{
  "status": "string",
  "code": "string",
  "detail": "string"
}

Properties

Name Type Required Restrictions Description
status string false none HTTP status code
code string false none DVLA reference code
detail string false none A meaningful description of the error which has occurred