Driver Documents

Taxi & Private Hire › Products › Fleet › Driver Documents

Generally available

HTTP API for driver compliance documents: list / get / upload / replace / soft-delete licences, certifications, badges, training certificates. Each document carries expiry tracking so the operator console can warn ahead of compliance lapses. Attached to Driver entities.

Example request

POST /client/{clientId}/driver/{driverId}/driverdocument ▷ Try it

See the API reference for the full request and response schema.

Endpoints

Method	Path
POST	/client/{clientId}/driver/{driverId}/driverdocument · primary	▷ Try it
GET	/client/{clientId}/driver/{driverId}/driverdocument/{driverdocumentId}	▷ Try it
GET	/client/{clientId}/driver/{driverId}/driverdocument	▷ Try it
GET	/client/{clientId}/driver/{driverId}/driverdocument/search	▷ Try it
POST	/client/{clientId}/driver/{driverId}/driverdocument/{driverdocumentId}	▷ Try it
POST	/client/{clientId}/driverdocument	▷ Try it
GET	/client/{clientId}/driverdocument/{driverdocumentId}	▷ Try it
GET	/client/{clientId}/driverdocument	▷ Try it
GET	/client/{clientId}/driverdocument/search	▷ Try it
POST	/client/{clientId}/driverdocument/{driverdocumentId}	▷ Try it

Full request/response schemas and an interactive explorer will live in the API reference (coming soon).

Use cases

Operator flows that exercise this feature.

Onboard a driver

config risk: low

Register a new driver and attach their compliance documents.

1. POST /client/{clientId}/driver
2. POST /client/{clientId}/driver/{driverId}/driverdocument

Add a driver document

config risk: low

Attach or renew a compliance document on a driver (licence, insurance, DBS).

1. POST /client/{clientId}/driver/{driverId}/driverdocument

Related

• Drivers
• Document Storage