[API] GET Compliance Info
The Get Compliance Info API enables Rental suppliers to access the up-to-date compliance information for specific drivers within the Uber system. Upon request, this API delivers detailed compliance information.
¶ Use case
In a Rental suppliers platform, the Get Compliance Info API plays a pivotal role in ensuring regulatory compliance. For instance, rental companies can verify a driver’s compliance status by leveraging this API, obtaining real-time compliance info containing the current status and the timestamp of the last update.
¶ Support for Hierarchical Data
The Get Compliance Info API automatically operates within the hierarchical structure of the organization linked to the developer’s account at the time of setup.
¶ Supported supplier types
Rentals
¶ Scopes
vehicle_suppliers.partners.compliance
¶ Resource
/v1/vehicle-suppliers/partners/me/compliance
¶ HTTP Method
GET
¶ Authorization
¶ Example Request
curl "https://api.uber.com/v1/vehicle-suppliers/partners/me/compliance" \
-H "Authorization: Bearer <TOKEN>"
Request Body parameters
Name | Type | Description | Required |
---|---|---|---|
Authorization | String | Bearer token for authentication | Yes |
¶ Example Response
Status-code: 200 OK
{
"compliance_info":{
"status":"ACTIVE",
"updated_at":1556864358
}
}
¶ Response Body Parameters
Name | Type | Description |
---|---|---|
compliance_info |
Object | This object will contain information regarding the compliance status of the driver. |
¶ Response Fields - Compliance Info
Name | Type | Description |
---|---|---|
status |
String | Driver’s status within the Uber system. Along with their possible values, and their semantics, is defined in this section. |
updated_at |
Long | Epoch timestamp representing when the driver status was last modified. |
¶ Driver Compliance Flags
compliance_info.status | Meaning |
---|---|
ONBOARDING |
A driver is currently in the onboarding funnel and is not eligible to drive on Uber. |
ONBOARDED |
Driver is ready to drive on Uber. All the compliance and background checks are done. |
ACTIVE |
Driver is currently engaged in driving activities on the Uber platform. |
WAITLISTED |
Driver is waitlisted temporarily. If this status persists for a long time, the rental company should repossess the vehicle back from the driver. |
REJECTED |
A driver is rejected from the Uber platform and the rental company should immediately get the vehicle back from the driver. |
¶ Rate limit
The rate limit for this endpoint is 2000 requests per hour (RPH).
¶ Endpoint Specific Errors
Http Status Code | Code | Message |
---|---|---|
401 |
unauthorized | The requesting user is not authorized to perform the action. |
404 |
|
|
409 |
forbidden (The account used for authentication is not a driver account.) | Account does not have driver permissions. Please login with a driver account. |
429 |
rate_limited | Number of requests exceeded allowed limit |
500 |
internal_server_error | Internal server error occurred |
503 |
service_unavailable | Service is currently unavailable |
¶ Notes
Important checks on driver compliance
-
Rental company should only open the contract when the driver status is ONBOARDED or ACTIVE.
-
If the driver’s status is WAITLISTED, the rental company should ask the driver to get activated again. This is generally the case of temporary deactivation due to doc expiry, background check expiry, etc. If the status stays in WAITLISTED for too long, the driver should be asked to return the vehicle.
-
If the driver’s status is REJECTED, the rental company should immediately ask the driver to return the vehicle.