Karhoo for Developers | Mobility Exchange API and SDK reference
Home
API Reference
Guides
Changelog
Karhoo.com
{{user.name}}
Log In
Karhoo for Developers | Mobility Exchange API and SDK reference
Home
Guides
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
Changelog
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
How-To Guides
How to authenticate
How to change password
How to check API availability
How to use Karhoo APIs
How to use Postman with Karhoo APIs
How to get access to the platform
How to integrate third-party auth system
How to process Karhoo webhooks
Demand Tutorials
Introduction to Demand
Book trips using APIs
Getting started
Get quotes
Book a trip
Trip updates
Trip completion
Build mobile apps using our SDKs
Choosing the best approach
Introduction to Mobile Network SDK
Getting started
Configuration and Authentication
Plan a trip
Get quotes
Book a Trip
Track a Trip
Introduction to Mobile Pre-built UI SDK
Getting started
UI SDK Configuration and Authentication
UI SDK Drop-In Implementation
UI SDK Component Implementation
Address Screen
Booking Screen
Checkout Screen
Address Bar Component
Quote List Component
Booking Request Component
Integration via deeplink v2
Generic deeplink params structure and validation logic
Deeplink to landing page
Deeplink to trip create page
Deeplink to quotes page
Supply Tutorials
Introduction to Supply
Integrate a DMS
Getting started
Quotes
Bookings
Trip updates
Settlements
Testing
Concept Guides
What is the Agent Portal?
API Versioning
What is a Bearer Token?
What are Environments?
What are Karhoo POIs?
Quote service latency
Using the Fleet simulator
Country specific setup for Fleet simulator
Vehicle and Driver details
Vehicle Type & Tags
Vehicle Class
Driver Details
Vehicle Capacity
Trip IDs
Notifications
Brand Loyalty Programs
Airport Flows
Trip States
Errors
Interpreting errors
Authentication Errors
error
K6001
Availability Errors
error
K5001
error
K5002
error
K5003
Bookings Errors
error
K4001
error
K4002
error
K4003
error
K4004
error
K4005
error
K4006
error
K4007
error
K4008
error
K4009
error
K4010
error
K4011
error
K4012
error
K4013
error
K4014
error
K4015
error
K4020
error
K4025
Directory Errors
error
K1001
error
K1003
error
K1004
error
K1005
error
K1006
error
K1007
error
K1008
error
K1009
error
K1010
error
K1011
General Errors
error
K0001
error
K0002
error
K0003
error
K0004
error
K0005
error
K0006
error
K0007
Integration errors
error
K8100
KPOI Errors
error
K7001
error
K7002
error
K7003
error
K7004
error
K7005
error
K7006
error
K7007
error
K7008
error
K7009
error
K7010
error
K7011
Locations Errors
error
K2001
error
K2002
Quotes Errors
error
K3001
error
K3002
error
K3003
SDK Errors
error
KSDK01
error
KSDK02
error
KSDK03
error
KSDK04
error
KSDK05
Supply Errors
error
K8001
error
K8002
Support
Getting help
How-To Guides
How to authenticate
How to change password
How to check API availability
How to use Karhoo APIs
How to use Postman with Karhoo APIs
How to get access to the platform
How to integrate third-party auth system
How to process Karhoo webhooks
Demand Tutorials
Introduction to Demand
Book trips using APIs
Getting started
Get quotes
Book a trip
Trip updates
Trip completion
Build mobile apps using our SDKs
Choosing the best approach
Introduction to Mobile Network SDK
Getting started
Configuration and Authentication
Plan a trip
Get quotes
Book a Trip
Track a Trip
Introduction to Mobile Pre-built UI SDK
Getting started
UI SDK Configuration and Authentication
UI SDK Drop-In Implementation
UI SDK Component Implementation
Address Screen
Booking Screen
Checkout Screen
Address Bar Component
Quote List Component
Booking Request Component
Integration via deeplink v2
Generic deeplink params structure and validation logic
Deeplink to landing page
Deeplink to trip create page
Deeplink to quotes page
Supply Tutorials
Introduction to Supply
Integrate a DMS
Getting started
Quotes
Bookings
Trip updates
Settlements
Testing
Concept Guides
What is the Agent Portal?
API Versioning
What is a Bearer Token?
What are Environments?
What are Karhoo POIs?
Quote service latency
Using the Fleet simulator
Country specific setup for Fleet simulator
Vehicle and Driver details
Vehicle Type & Tags
Vehicle Class
Driver Details
Vehicle Capacity
Trip IDs
Notifications
Brand Loyalty Programs
Airport Flows
Trip States
Errors
Interpreting errors
Authentication Errors
error
K6001
Availability Errors
error
K5001
error
K5002
error
K5003
Bookings Errors
error
K4001
error
K4002
error
K4003
error
K4004
error
K4005
error
K4006
error
K4007
error
K4008
error
K4009
error
K4010
error
K4011
error
K4012
error
K4013
error
K4014
error
K4015
error
K4020
error
K4025
Directory Errors
error
K1001
error
K1003
error
K1004
error
K1005
error
K1006
error
K1007
error
K1008
error
K1009
error
K1010
error
K1011
General Errors
error
K0001
error
K0002
error
K0003
error
K0004
error
K0005
error
K0006
error
K0007
Integration errors
error
K8100
KPOI Errors
error
K7001
error
K7002
error
K7003
error
K7004
error
K7005
error
K7006
error
K7007
error
K7008
error
K7009
error
K7010
error
K7011
Locations Errors
error
K2001
error
K2002
Quotes Errors
error
K3001
error
K3002
error
K3003
SDK Errors
error
KSDK01
error
KSDK02
error
KSDK03
error
KSDK04
error
KSDK05
Supply Errors
error
K8001
error
K8002
Support
Getting help
Welcome to the Karhoo API
Karhoo API Explorer
5 Minutes to Book a Trip
Your journey starts here
post
Plan a trip
get
Retrieve quotes
post
Book a trip
Receive confirmation
Authentication API 1.0
Auth
post
Get an Access Token
post
Refresh Access Token
delete
Revoke Refresh Token
Health Check
get
Check Services
Quotes API 2.0
Quotes
post
Request Quotes
get
Retrieve Quote List
get
Verify quote price with DMS before booking
Coverage
get
Check Coverage
Healthcheck
get
Check Services
Bookings API 1.0
Bookings
post
Book a Trip
post
Book a Trip only if the preauthorisation of the payment_nonce is successful
get
Get Booking Details
post
Cancel a Booking
get
Retrieve the estimated cancellation fee
get
Get Booking History
get
Get Booking Status
get
Get Position of a Trip
post
Search Booking History
get
Get Trips for an Organisation
get
Get Trips for a Fleet
get
Follow a Booking
post
Cancel a Booking given a follow link
get
Get cancellation fee for a Booking given a follow code
Healthcheck
get
Check Services
Identity API 1.0
OAuth 2.0
get
Authorize endpoint
post
Token endpoint
get
Getting user details
post
Revoking issued tokens
Token exchange
post
Authenticating with third-party tokens
Fares API 1.0
final-fare
get
Get final fare from trip id
Webhooks API 1.0
Webhooks
post
Register webhook endpoint
get
Returns the active subscription
delete
Removes active subscription
Network SDK
User Service
register
login
logout
resetPassword
currentUser
User object schemas
Auth Service
login (token)
revoke
Address Service
placeSearch
locationInfo
reverseGeocode
Address object schemas
Quotes Service
quotes
Quotes object schemas
Trip Service
book
cancel
search
trackTrip
status
Trip object schemas
Driver Tracking Service
trackDriver
Driver Tracking object schemas
UI SDK
Custom styling
Injectable components
Deeplink
Address screen
iOS implementation
Android implementation
Booking screen
iOS implementation
Android implementation
Trip screen
iOS implementation
Android implementation
Rides screen
iOS implementation
Android implementation
Ride Details screen
iOS implementation
Android implementation
Additional Feedback screen
iOS implementation
Android implementation
Supply API 1.0
[Push] Availability
post
Stream fleet wide vehicle availability to Karhoo
post
DMS Trip Status Push to Karhoo
[Push] Trip Status
[DMS Endpoint] Receive New Trips
post
DMS hosted API endpoint for receiving Karhoo trip bookings
[DMS Endpoint] Provide Trip Details
get
DMS Hosted endpoint to respond to Karhoo Trip Detail requests
[DMS Endpoint] Cancel Trip
delete
DMS Hosted endpoint to respond to Karhoo Trip Cancellation requests
[DMS Endpoint] Update Trip
put
DMS Hosted API endpoint to respond to Karhoo Trip Update requests to your DMS platform.
[DMS Endpoint] Quote Request
post
DMS hosted API endpoint for responding to quote requests
[DMS Endpoint] ETA Request
post
DMS hosted API endpoint for responding to ETA requests
[DMS Endpoint] Availability Request
post
Karhoo Availability Request to DMS
Healthcheck
get
Health check endpoint
Loyalty API
Loyalty
get
Get loyalty exchange rates
get
Get user loyalty points balance
post
Burn loyalty points
post
Refund loyalty points
Healthcheck
get
Check the health of your API
Onboarding API 1.0
Fleet Labels
get
/fleet/labels
post
Create labels.
post
Labels selected fleet.
delete
Removes a label from selected fleet.
Supply partner
get
Get supply partner by ID
put
Update supply partner
put
Update supply partner logo
get
Get supply products by partner ID
Payments API 3.0
Loyalty
get
Loyalty points user's balance
get
Loyalty points conversion rates
Quick Starter
Perform your first taxi booking using Karhoo API in just 5 minutes.
Demand Partner API
Add taxi booking and e-hailing capabilities to your mobile apps and websites.
Read more about Karhoo for Brands
Supply Partner API
Connect your dispatch solution and join Karhoo Mobility Exchange as supplier.
Read more about Karhoo for Fleets
How-To Guides
How to authenticate
How to change password
How to check API availability
View All 8
Demand Tutorials
Introduction to Demand
Book trips using APIs
Build mobile apps using our SDKs
View All 6
Supply Tutorials
Introduction to Supply
Integrate a DMS
Concept Guides
What is the Agent Portal?
API Versioning
What is a Bearer Token?
View All 13
Errors
Interpreting errors
Authentication Errors
Availability Errors
View All 12
Support
Getting help
