Uber Developers

Uber

Developers

[API] Search Drivers

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

Search the drivers using search criterias to get driver info. Only authorized rental companies are allowed to use this API to search drivers.

¶ Resource

/v1/vehicle-suppliers/drivers/search

¶ HTTP Method

POST

¶ Access Method

Client Credentials

¶ Required scopes

vehicle_suppliers.drivers.read

¶ Example Request

Search By Phone Number

curl -X POST "https://api.uber.com/v1/vehicle-suppliers/drivers/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <TOKEN>"
  -d '{
    "filters": {
      "phoneNumber": {
        "countryCode": "+1",
        "nationalPhoneNumber": "2223334444"
      }
    }
}'

Search By Email

curl -X POST "https://api.uber.com/v1/vehicle-suppliers/drivers/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <TOKEN>" -d '{
    "filters": {
      "email": "<email address>"
    }
}'

¶ Example Response

Status-code: 200 OK
{
  "drivers": [
    {
      "driverInfo": {
        "id": "<driver_id>",
        "name": {
          "firstName": "<first_name>",
          "lastName": "<last_name>"
        },
        "pictureUrl": "<picture_url>",
        "email": "<email>",
        "phone": {
          "countryCode": "+1",
          "nationalPhoneNumber": "2223334444"
        }
      },
      "complianceInfo": {
        "status": "ACTIVE"
      }
    },
    {
      "additionalInfo": "This driver hasn't consented to share their information. They'll need to visit t.uber.com/rentalconsent and accept the Vehicle Solutions data sharing terms."
    }
  ]
}

¶ Request Body Parameters

Name	Type	Description
`criteria`	object	Search criteria with (only one criteria can be specified).
`criteria.email`	string	Driver email.
`criteria.phone_number`	object	Driver phone number (country code + national phone number).
`criteria.phone_number.country_code`	string	Driver phone number country code.
`criteria.phone_number.national_phone_number`	string	Driver national phone number.

¶ Response Fields

Name	Type	Description
`drivers`	object array	List of `Driver` objects

Driver object

Name	Type	Description
`driverInfo`	object	Driver info
`id`	string	Driver Id
`name`	object	Driver name (first name + last name)
`name.first_name`	string	Driver first name
`name.last_name`	string	Driver last name
`picture_url`	string	Driver profile picture
`email`	string	Driver email
`phone_number`	object	Driver phone number (country code + national phone number)
`phone_number.country_code`	string	Driver phone number country code
`phone_number.national_phone_number`	string	Driver national phone number
`additional_info`	string	Additional info helps clients understand the driver. For example, if the driver does not accept consents, other fields will be empty and show additional info.
`compliance_info`	object	Driver compliance info
`compliance_info.status`	string	Compliance status of the driver:
		ACTIVE: driver is active
		INACTIVE: driver is not active

¶ Endpoint Specific Errors

Http Status Code	Code	Message
`400`	bad_request	Org from request does not belong to any rental organization.
`400`	bad_request	Please search drivers by one of the search fields, and leave other search fields as empty.
`401`	unauthorized	The request user is not authorized to do the action.
`401`	unauthorized	The driver hasn’t consented to share their information. They need to visit t.uber.com/rentalconsent and accept the Vehicle Solutions data sharing terms.
`404`	user_not_found	This driver does not exist. Please instruct the user to sign up to drive with Uber.
`404`	org_not_found	The org does not exist.
`500`	internal_server_error	Internal server error

Request Body Parameters

Response Fields

Endpoint Specific Errors

Uber

Developers