Skip to content
Recruso API

Get one of a worker's driving licences

GET
/v1/workers/{workerId}/licences/{id}
curl --request GET \
  --url https://api2.recruso.co.uk/v1/workers/1/licences/1 \
  --header 'Authorization: <Authorization>'

Returns a single driving licence held by a worker in your own agency, with a count of the convictions recorded against it. The convictions themselves are listed by their own operation.

A licence that belongs to a different worker, or to another agency, returns 404 rather than 403, so its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workerId
required
integer format: int32

The workerId path parameter

id
required
integer format: int32

The id path parameter

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
workerLicenceId

The licence record’s identifier.

integer format: int64
licenceNumber

The licence number.

string
issueDate

The date the licence was issued.

string format: date
nullable
expiryDate

The date the licence expires.

string format: date
nullable
issueNumberChecked

Whether the issue number has been checked against the DVLA record.

boolean
nullable
convictionCount

How many convictions are recorded against this licence.

integer format: int32
Example
{
  "workerLicenceId": 5120,
  "licenceNumber": "BAKER905124A99AB",
  "issueDate": "2019-06-03",
  "expiryDate": "2029-06-02",
  "issueNumberChecked": true,
  "convictionCount": 1
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}