Create Driver Profile
Body Parameters
UUID of the user account to associate with this driver profile
Driver license number (1-50 characters, must be unique)
License expiration date in ISO 8601 format
URL to the driver license image
Background check status. Defaults to
pending_background_checkpending_background_checkapprovedrejected
Date when background check was performed (ISO 8601)
Whether the driver is approved to operate. Defaults to
falseEmergency contact information
Operational status of the driver. Defaults to
pending_docsactive- Approved and actively drivingsuspended- Temporarily suspendedon_vacation- On vacationpending_docs- Awaiting documentationdeactivated- Account deactivated
Date until which the driver has paid priority status (ISO 8601)
Optional vehicle to create alongside the driver profile during onboarding
Response
Indicates if the operation was successful
Response message
Created driver profile
List Driver Profiles
Query Parameters
Page number for pagination
Number of items per page
Filter by user UUID
Filter by driver license number (1-50 characters)
Filter by background check status
pending_background_checkapprovedrejected
Filter by approval status
Filter by driver operational status
activesuspendedon_vacationpending_docsdeactivated
Response
Indicates if the operation was successful
Response message
Array of driver profiles
Pagination metadata
Get Driver Profile
Path Parameters
UUID of the driver profile
Response
Indicates if the operation was successful
Response message
Driver profile details
Update Driver Profile
Path Parameters
UUID of the driver profile to update
Body Parameters
New driver license number (1-50 characters)
New license expiration date (ISO 8601)
New URL to driver license image
Updated emergency contact information
New operational status
activesuspendedon_vacationpending_docsdeactivated
New paid priority expiration date (ISO 8601)
New background check status
pending_background_checkapprovedrejected
New background check date (ISO 8601)
Updated approval status
Response
Indicates if the operation was successful
Response message
Updated driver profile
Delete Driver Profile
Path Parameters
UUID of the driver profile to delete
Response
Indicates if the operation was successful
Response message
Returns null for deleted resources