API
Driver management API for UK operators
The Zerity driver management API is how a UK operator connects driver, document and pay-run records to systems they already run. It is not a dispatch API. Zerity stores the licence record, the date it was checked and the expiry. Track every expiry date in one place. There is no public endpoint list on this page. Access is arranged with Zerity for a named integration.
Records a customer asks to connect
We confirm the exact fields when access is arranged. This table is the scope of the conversation, not a list of live routes.
| Record | What it is |
|---|---|
| Drivers | The driver record: who they are, which depot they belong to, and whether onboarding is finished. |
| Documents and expiry | The document you have stored, and the expiry date on it. Zerity stores the licence record, the date it was checked and the expiry. Track every expiry date in one place. |
| Depots | The depot and network tag on the driver, so a multi-depot account stays split. |
| Pay-run status | Whether a self-billed pay run is in progress. The API does not book jobs or track vans by GPS. |
Operators usually want the ledger (Xero or Sage) or their existing transport system to receive a pay-run status or a driver record. Whether that connection is an export or an API is confirmed for that integration. It is not assumed on this page.
Read the records the platform holds, security of data in transit, or the support centre if you already have access and something failed.
How access is arranged
- 1. Name the records. Tell us which of the records above you need, and which system should receive them.
- 2. We confirm what exists. We say what can be read or written today. We do not document a route that is not in production.
- 3. You test the agreed records. Nothing in a live pay run changes until you accept the sample.
- 4. We agree the failure path. If a document feed or a pay-run status stops, you know who is told.
Questions
- What is the Zerity API for?
- It connects driver, document and pay-run records to the systems a depot already uses. It does not book jobs or track vans by GPS.
- Can the API run a driving-record query?
- No. The API can carry the document and the expiry you have stored. Zerity stores the licence record, the date it was checked and the expiry. Track every expiry date in one place.
- Is API access included with every account?
- API access is arranged for operators who need to connect their own systems. It is not switched on for every account by default. Ask which records you need, and the endpoints are confirmed for that account.