[API] GET Risk Assessment V3
Get the risk profile of the driver partner.
¶ Resource
/v3/vehicle-suppliers/partners/me/risk-profile
¶ HTTP Method
GET
¶ Access Method
¶ Required scopes
vehicle_suppliers.partners.risk_profile.v3
¶ Example Request
curl -i -X GET "https://api.uber.com/v3/vehicle-suppliers/partners/me/risk-profile?risk_models=PRO_STATUS,FIRST_TRIP_TIMESTAMP,TRIPS_OF_LAST_7DAYS,RISK_ASSESSMENT_SCORE" \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json"
¶ Request Query Parameters
Name | Type | Description |
---|---|---|
risk_models |
string | Comma-separated list of risk model names to retrieve. |
¶ Risk Models
These risk model names can be provided in a comma-separated list as the query parameter.
Name | Type | Description |
---|---|---|
PRO_STATUS |
string | Indicates if partner has an Uber Pro status and it’s level |
FIRST_TRIP_TIMESTAMP |
string | Timestamp of the first trip as a driver |
TRIPS_OF_LAST_7DAYS |
string | Number of trips in the last 7 days |
RISK_ASSESSMENT_SCORE |
string | Uber data-centric driver risk score |
<CUSTOM_MODEL> | … | Custom model specific to the vehicle supplier |
¶ Response Body Fields
Name | Type | Description |
---|---|---|
scores |
object | Multiple Score objects, corresponding to the number of comma-separated risk_models passed on the request |
Name | Type | Description |
---|---|---|
risk_model |
object | For every Risk Model available, an Assessment object is returned |
Name | Type | Description |
---|---|---|
value |
string | The assessment value for the risk score model. If there is an errorMsg , value will be an empty string "" |
errorMsg |
(Optional) string | In case of an error, string code is returned. Current options: "no_record" |
timestamp |
int | Unix timestamp for the moment the value was obtained |
¶ Example Response
Status-code: 200 OK
{
"scores": {
"PRO_STATUS": {
"value": "TIER_2",
"timestamp":1564522725
},
"FIRST_TRIP_TIMESTAMP": {
"value": "1564511234",
"timestamp":1564522725
},
"TRIPS_OF_LAST_7DAYS": {
"value": "0",
"timestamp":1564522725
},
"RISK_ASSESSMENT_SCORE": {
"value": "0.06442590057849884",
"timestamp": 1564522725
}
}
}
** A Response (Optional) parameter is one that can be present or not.
¶ Rate Limit
- Rate limit for this endpoint is 100 rph (requests per hour)
¶ Endpoint Specific Errors
Http Status Code | Code | Message |
---|---|---|
400 |
bad_request | Invalid request |
400 |
partner_not_found | Partner not found |
401 |
unauthorized | Invalid OAuth 2.0 credentials provided |
429 |
rate_limited | Number of requests exceeds allowed limit |
500 |
internal_server_error | Internal server error |
503 |
service_unavailable | Service unavailable |