MyEZToll
POST/api/partner/v1/drivers

Create or update driver

Create or update a driver (renter), optionally with license images.

Send as multipart/form-data so the optional license images ride along in one call. Pass userId to update an existing driver (for example to attach images later); omit it to create — in which case firstName, lastName and email are required.

Authorization

X-Api-Key header

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

Body

multipart/form-data

Multipart form. firstName/lastName/email required unless userId is set (update).

userIdstring

Set to update an existing driver; omit to create. Our id or your external id.

externalIdstring

Your own driver id — recorded so you can use it everywhere.

firstNamestring
lastNamestring
emailstring <email>
companyNamestring

Business renter — stored as the driver's company.

phoneNumberstring
addressstring
address2string
citystring
statestring
zipCodestring
countrystring
dateOfBirthstring

e.g. 1990-05-21

driverLicenseIdstring
driverLicenseIssuingStatestring
driverLicenseExpirationDatestring
languagestring
smsConsentboolean
Default: true
frontSideImagefile

Optional front-of-license image.

backSideImagefile

Optional back-of-license image (PDF417).

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 created / updated driver.
400Validation error.
401Missing, unknown or revoked API key.
404The resource does not exist under this owner.