Skip to main content

Drivers Enquiries Image Service API v0.0.11

An enquiry service for external consumers of DVLA Driver Data

Click here to see this OpenAPI specification in JSON format.

Image Enquiries

post__v1_images_retrieve

POST /v1/images/retrieve

Retrieve photo and signatures information, for a given Driving Licence Number.


Parameters

Name In Type Required Restrictions Description
Authorization header string true none Valid JWT token issued as a result of authentication against the API Gateway
x-api-key header string true none API key used to access the service
X-Correlation-ID header string(uuid) true none CorrelationID to track the request from the API gateway through the Enquiries stack
body body imageRequest true none The full Driving Licence Number including the check digits.

Example Request

curl -X POST  -d '{
  "drivingLicenceNumber": "ABCDE123456AB1AB",
  "requiredImage": "photograph"
}' /v1/images/retrieve \
 -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: string' -H 'x-api-key: string' -H 'X-Correlation-ID: dbcf549a-43db-4b95-aea8-1e6b792397bb'

Responses

Status Meaning Description Schema
200 OK Success. Returns the requested images for the given driving licence number. imageResponse
400 Bad Request Bad Request. The server could not understand the request due to invalid syntax. #/components/responses/400/content/application~1json/schema
401 Unauthorized Unauthorised. #/components/responses/401/content/application~1json/schema
403 Forbidden Forbidden. No access to the requested resource. #/components/responses/401/content/application~1json/schema
404 Not Found Record for supplied driving licence number cannot be found. #/components/responses/400/content/application~1json/schema
429 Too Many Requests Too many requests in a given amount of time. #/components/responses/401/content/application~1json/schema
500 Internal Server Error The service encountered an unspecified error. #/components/responses/400/content/application~1json/schema

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

Example Response

200 Response

{
  "photograph": {
    "image": "string",
    "imageFormat": "image/jpeg"
  },
  "signature": {
    "image": "string",
    "imageFormat": "image/jpeg"
  },
  "driverRedirect": true
}

Schemas

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

imageRequest

{
  "drivingLicenceNumber": "ABCDE123456AB1AB",
  "requiredImage": "photograph"
}

Properties

Name Type Required Restrictions Description
drivingLicenceNumber drivingLicenceNumber true none A UK driving licence number
requiredImage string false Enum: photograph,signature
 none

Enumerated Values

Property Value
requiredImage photograph
requiredImage signature

imageResponse

{
  "photograph": {
    "image": "string",
    "imageFormat": "image/jpeg"
  },
  "signature": {
    "image": "string",
    "imageFormat": "image/jpeg"
  },
  "driverRedirect": true
}

Properties

Name Type Required Restrictions Description
photograph imageType false none returned image type, (signature or photograph)
signature imageType false none returned image type, (signature or photograph)
driverRedirect boolean false none Indicates if record was redirected from cross reference record.

imageType

{
  "image": "string",
  "imageFormat": "image/jpeg"
}

returned image type, (signature or photograph)

Properties

Name Type Required Restrictions Description
image string true none image as a base 64 string
imageFormat string true Enum: image/jpeg,image/tiff
 image format

Enumerated Values

Property Value
imageFormat image/jpeg
imageFormat image/tiff