MyEZToll
GET/api/partner/v1/drivers/{driverId}

Get driver

Get one driver, with the full parsed licence.

Authorization

X-Api-Key header

Send your partner key on every request. An owner key acts for its one owner; an integration token also needs the owner's id in the X-Owner-Id header.

Path parameters

driverIdstringpathrequired

Our driver id OR your own external driver id.

Response

200 · application/json
successbooleanrequired
dataobject
userIdstring
externalIdstringnullable

Your own driver id

firstNamestringnullable
lastNamestringnullable
middleNamestringnullable

Comes from the licence document; not settable.

companyNamestringnullable
emailstringnullable
emailConfirmedboolean
phoneNumberstringnullable

E.164.

addressLine1stringnullable
addressLine2stringnullable
citystringnullable
statestringnullable
zipCodestringnullable
countrystringnullable
dateOfBirthstringnullable

yyyy-MM-dd

languagestringnullable
driverLicenseIdstringnullable
driverLicenseIssuingStatestringnullable
driverLicenseExpirationDatestringnullable

yyyy-MM-dd

frontSideImageUrlstring <uri>nullable
backSideImageUrlstring <uri>nullable
licenseobject

Only on the single-driver read; omitted from list rows.

hasCardboolean

A card is on file. Use GET /drivers/{driverId}/card for whether it is usable.

smsConsentboolean

False once the driver replied STOP.

bookingCountinteger

How many bookings this driver has with you.

createdAtUtcstring <date-time>
updatedAtUtcstring <date-time>
errorstringnullable

Status codes

200The driver.
401Missing, unknown or revoked API key.
404The resource does not exist under this owner.