API Reference
SupportAPI Feedback

Add a new Driver

post
https://{environment}/api/v4/drivers

Adds a new driver to the system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

RequestBody to create the driver.

string
required

Indicates the Drivers first name.

string
required

Indicates the Drivers last name.

uuid
required

The unique Azuga ID of the role assigned to the Driver in UUID format

phoneNumber
object
required

Drivers phone number object with fields for countrycode and number

string
required

The drivers's email address. All communications from Azuga will be delivered to this email address.

string
required

Timezone in which the Driver is located.

string

The unique Azuga ID of the Vehicle. This is automatically generated when the Vehicle object is created and cannot be altered.

string
length ≤ 50

Indicates the unique identifer of the drivers license

string

A unique identifier assigned to an employee.

string

A unique identifier assigned to a fuel card associated to a driver

string

Indicates the web address (URL) of the page displayed to the user immediately following a successful login

boolean
string
required

Username of the driver

password
required
length between 8 and 15

The password set by the user for the driver account.

string
string
string

The state or region where the driver's license was originally issued.

date

The date on which the driver's license was officially issued

date

The date on which the driver''s license is set to expire.

integer
enum

The pairingTypeId field represents the method used to pair the driver with the system. It accepts an integer value corresponding to one of the predefined pairing methods:

0 - Web Pairing 1 - Bluetooth Pairing 2 - Beacon Pairing 4 - Tablet Pairing 5 - Manual Pairing 6 - Beacon Button Pairing 7 - QR Code Pairing 8 - Mobile Pairing

Allowed:
boolean
string

Date of birth of the Driver in DD-MM-YYYY format

integer

Indicates the Drivers age

string

Driver's blood group

string
length ≤ 50

A unique identification number assigned to a driver

date

The expiration date of the driver’s badge number

date

The date on which the driver officially started employment with the organization.

date

The date on which the driver officially ended their employment with the organization.

integer

The total number of years the driver has been professionally driving.

date

The date on which the driver’s police verification or background check was completed and officially recorded.

date

The date on which the driver completed a Defensive Driving Course (DDC).

boolean

Indicates whether the driver has passed the required medical examination where true = passed, false = not passed

boolean

Indicates the current status of the driver’s police or background verification where true = verified, false = not verified

string

Listing the safety training courses the driver has completed or is enrolled in

string

Current status of the driver, if the driver is active or inactive

string

The URL of the afn.

string
required
length between 4 and 4

A numeric code typically 4 digits to authenticate during login

hoursOfService
object
Responses

Updated 10 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago