MyEZToll
POST/api/partner/v1/drivers/{driverId}/license/images

Upload licence images

Attach or replace an existing driver's licence images.

Either side may be sent alone. The images run through the same pipeline as our own registration wizard: the back-side barcode is authoritative, front-side OCR fills what it leaves empty, and the optional manual fields are used when the document cannot be read.

Authorization

X-Api-Key header

Send your partner key on every request. The key is bound to exactly one owner account.

Path parameters

driverIdstringpathrequired

Our driver id OR your own external driver id.

Body

multipart/form-data

Multipart form; send either side or both.

frontSideImagefile

Front of the licence — read by OCR.

backSideImagefile

Back of the licence — its PDF417 barcode is parsed.

licenseNumberstring

Used when the document cannot be read. Outranked by the barcode.

issuingStatestring
expirationDatestring

yyyy-MM-dd

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, re-read after the upload.
400Validation error.
401Missing, unknown or revoked API key.
404The resource does not exist under this owner.