VANITYPASS
White-label APIGround Transport

Ground Transport

Airport transfers and ride-hailing for your users — search, book, track, and cancel.

Ground Transport

Ground transport endpoints live under /v1/travel/ground-transport, covering airport transfers, private cars, shuttles, and ride-hailing in 500+ cities. Let your users book a ride to or from the airport directly inside your app.

Requests use white-label (JWT) authentication:

  • Authorization: Bearer <JWT> — issued by your OAuth2 flow
  • X-App-Id: <uuid> (or X-App-Slug: <slug>) — identifies your white-label app
  • X-Environment: Sandbox | Production — routes to the right environment

Async Search & Book Flow

Ground transport uses an async two-step poll pattern for both search and booking. A POST kicks off the work and returns a search_id; you then poll a GET endpoint until the result is ready.

POST /v1/travel/ground-transport → search_id

GET /v1/travel/ground-transport/{search_id}/poll   (repeat until status = complete)
  ↓ pick a result_id
POST /v1/travel/ground-transport/bookings → search_id

GET /v1/travel/ground-transport/bookings/{search_id}/poll   (repeat until status = confirmed)

Recommended poll interval: 2 seconds. Search typically completes in 5–15 seconds.

Endpoints

EndpointMethodPurpose
/v1/travel/ground-transportPOSTStart a search — returns a search_id.
/v1/travel/ground-transport/{search_id}/pollGETPoll for search results.
/v1/travel/ground-transport/bookingsPOSTBook a selected option — returns a search_id.
/v1/travel/ground-transport/bookings/{search_id}/pollGETPoll for booking confirmation.
/v1/travel/ground-transport/bookings/cancelPOSTCancel a booking.
/v1/travel/ground-transport/bookings/historyGETList the user's past bookings.

Next Steps

  • Search — search available rides and poll for results.
  • Bookings — book a ride, poll for confirmation, cancel, and review history.