Health API Introduction
¶ Overview
Uber’s Health API provides a way to manage transportation for your guests via the Uber Platform.
The Health API is an HIPAA compliant endpoint and integration solution.
Your guests are not required to have an Uber account, but you will need to provide some guest details when requesting a ride.
This API resource is designed to allow you to request and pay for rides, for multiple guests at the same time.
You can find API best practices here.
¶ Developer Guides
- Authentication - Authentication for the Health API is done using OAuth 2.0 client credentials using the
healthscope for production endpoints andhealth.sandboxscope for Sandbox endpoints. - Errors - There are different errors that may need to be handled in different ways.
- Sandbox - The Sandbox can be used to test endpoints without actually requesting a trip.
- Webhooks - Setup a webhook to receive data from the Uber Platform.
¶ Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/health/trips | Retrieves a paginated list all trips. |
| GET | /v1/health/trips/:trip_id | Retrieves a single trip. |
| POST | /v1/health/trips | Requests a new trip. |
| PUT | /v1/health/trips | Update an active trip. |
| DELETE | /v1/health/trips/:trip_id | Cancels a single trip. |
| POST | /v1/health/trips/call | Initiates a call between the given phone number and the driver of the given trip id. |
| POST | /v1/health/trips/tip | Adds a tip to a completed trip. |
| POST | /v1/health/trips/estimates | Retrieves list of products available and corresponding price estimates for a given route. |
| GET | /v1/health/zones | Retrieves a list of zones corresponding to specialized pickup locations. |
| PUT | /v1/health/trips/communication | Create or update a communication session with the driver for a trip |
| GET | /v1/health/trips/{}/receipt | Retrieve a receipt of a past trip. |
| POST | /v1/health/trips/{}/message | Send a message to the driver of an active trip. |
| GET | /v1/health/guests/phone-info/ | Retrieves health rider phone information. |
| POST | /v1/health/trips/{}/dispatch | Dispatch a flexible trip. |
| GET | /v1/health/address/autocomplete/ | Address autocomplete. |