DriversApi

All URIs are relative to https://business.apis.kesk.app/v1

Method	HTTP request	Description
activateDriverPartnerDriverVehicle	POST /vendors/`{vendor_id}`/drivers/`{driver_id}`/activate-vehicle/`{vehicle_id}`	Activate a vehicle
getDriverDetails	GET /driver-partners/`{vendor_id}`/drivers/`{driver_id}`	Get driver profile details
getDriverPartnerDetails	GET /driver-partners/`{vendor_id}`	Get driver partner organization details
getDriverPartnerDriverEarnings	GET /vendors/`{vendor_id}`/drivers/`{driver_id}`/reports/earnings	Get earnings breakdown report
getDriverPartnerDriverPayouts	GET /vendors/`{vendor_id}`/drivers/`{driver_id}`/reports/payouts	Get payout history report
getDriverPartnerDriverVehicles	GET /vendors/`{vendor_id}`/drivers/`{driver_id}`/vehicles	List driver vehicles
getDriverReviews	GET /driver-partners/`{vendor_id}`/drivers/`{driver_id}`/reviews	Get driver customer reviews
registerDriverPartnerDriverVehicle	POST /vendors/`{vendor_id}`/drivers/`{driver_id}`/register-vehicle	Register a new vehicle
switchDriverPartnerDriverType	POST /vendors/`{vendor_id}`/drivers/`{driver_id}`/switch-type	Switch driver operational type
syncDriverPartnerDriverLocation	POST /vendors/`{vendor_id}`/drivers/`{driver_id}`/location-sync	Sync driver location

activateDriverPartnerDriverVehicle

MessageResponse activateDriverPartnerDriverVehicle(vendor_id, driver_id, vehicle_id)

Activate a vehicle

Sets a specific vehicle as the active vehicle for the driver. Only one vehicle can be active at a time for order assignment purposes.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver activating the vehicle	[default to null]
vehicle_id	Long	The ID of the vehicle to activate	[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverDetails

DriverDetailsResponse getDriverDetails(vendor_id, driver_id)

Get driver profile details

Retrieves comprehensive profile information for a specific driver including personal details, verification status, and performance metrics.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver to retrieve	[default to null]

Return type

DriverDetailsResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverPartnerDetails

DriverPartnerDetailsResponse getDriverPartnerDetails(vendor_id)

Get driver partner organization details

Retrieves information about the driver partner organization including contact details, operational settings, and service areas.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]

Return type

DriverPartnerDetailsResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverPartnerDriverEarnings

PaginatedResponse_EarningReportResponse getDriverPartnerDriverEarnings(vendor_id, driver_id, start_date, end_date, page, per_page)

Get earnings breakdown report

Retrieves detailed earnings information including trip revenue, tips, bonuses, and fees. Supports date range filtering for analyzing income trends over time.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver requesting the report	[default to null]
start_date	String	Optional start date for filtering (YYYY-MM-DD)	[optional] [default to null]
end_date	String	Optional end date for filtering (YYYY-MM-DD)	[optional] [default to null]
page	Integer	Page number (default: 1)	[optional] [default to null]
per_page	Integer	Items per page (default: 20)	[optional] [default to null]

Return type

PaginatedResponse_EarningReportResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverPartnerDriverPayouts

PaginatedResponse_PayoutReportResponse getDriverPartnerDriverPayouts(vendor_id, driver_id, start_date, end_date, page, per_page)

Get payout history report

Retrieves a detailed history of all payouts made to the driver. Supports filtering by date range and pagination for analyzing payment patterns.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver requesting the report	[default to null]
start_date	String	Optional start date for filtering (YYYY-MM-DD)	[optional] [default to null]
end_date	String	Optional end date for filtering (YYYY-MM-DD)	[optional] [default to null]
page	Integer	Page number (default: 1)	[optional] [default to null]
per_page	Integer	Items per page (default: 20)	[optional] [default to null]

Return type

PaginatedResponse_PayoutReportResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverPartnerDriverVehicles

PaginatedResponse_DriverVehicleResponse getDriverPartnerDriverVehicles(vendor_id, driver_id, page, per_page)

List driver vehicles

Retrieves all vehicles registered by the driver including their approval status and activation state.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver whose vehicles to list	[default to null]
page	Integer	Page number (default: 1)	[optional] [default to null]
per_page	Integer	Items per page (default: 20)	[optional] [default to null]

Return type

PaginatedResponse_DriverVehicleResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverReviews

PaginatedResponse_DriverReview getDriverReviews(vendor_id, driver_id, page, per_page)

Get driver customer reviews

Retrieves recent customer reviews and ratings for the driver. Helps drivers understand customer feedback and identify areas for improvement.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver whose reviews to retrieve	[default to null]
page	Integer	Page number (default: 1)	[optional] [default to null]
per_page	Integer	Items per page (default: 20)	[optional] [default to null]

Return type

PaginatedResponse_DriverReview

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

registerDriverPartnerDriverVehicle

MessageResponse registerDriverPartnerDriverVehicle(vendor_id, driver_id, color, vehicle_type_id, car_model_id, documents, reg_no)

Registers a new vehicle for the driver including vehicle details and required documents. The vehicle enters pending status and requires admin approval before use.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver registering the vehicle	[default to null]
color	String		[default to null]
vehicle_type_id	Long		[default to null]
car_model_id	Long		[default to null]
documents	List		[default to null]
reg_no	String		[optional] [default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json; charset=utf-8

switchDriverPartnerDriverType

DriverSwitchTypeResponse switchDriverPartnerDriverType(vendor_id, driver_id, SwitchTypeInput)

Switch driver operational type

Allows drivers to switch between taxi and delivery modes. Updates driver availability and configures appropriate order assignment settings.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver switching type	[default to null]
SwitchTypeInput	SwitchTypeInput	Operational type configuration

Return type

DriverSwitchTypeResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

syncDriverPartnerDriverLocation

DriverSuccessResponse syncDriverPartnerDriverLocation(vendor_id, driver_id, DriverLocationInput)

Sync driver location

Updates the driver’s current GPS location in real-time. This location is used for order assignment algorithms and enables customers to track driver arrival.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver syncing location	[default to null]
DriverLocationInput	DriverLocationInput	GPS coordinates and heading information

Return type

DriverSuccessResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8