Skip to main content

Insurance providers

This section describes the API used by Insurance providers. It is an extension of the Mobility Data Specification (MDS) provider API 2.0 schema, see above for more on that.

Authentication

Authentication for the Insurance API uses the same API key method as all other Voi APIs. Include your API key in the X-Access-Token request header. See the MDS 2.0 Authentication section for details.

KeyValue
X-Access-Tokenyour-api-key

Legacy Authentication (deprecated)

warning

The previous OAuth 2.0 client_credentials authentication method is deprecated. Existing tokens will continue to work, but credentials will not be renewed upon expiration. Please migrate to the API key method described above.

Versioning

The Insurance MDS APIs handle requests for specific versions of the specification from the clients. Version is communicated through the use of a custom media-type, application/vnd.insurance+json;version=2.0.

See Open Mobility Foundation's MDS description on versioning here.

KeyValue
Acceptapplication/vnd.insurance+json;version=2.0

Trips

A trips request.

# v2.0
$ curl -H "Accept: application/vnd.insurance+json;version=2.0"
api.voiapp.io/v1/partner-apis/insurance/1/trips?end_time=2025-08-16T13

Do not copy ^ as the zone-ID or Accept might not match yours

A trips response.

{
"last_updated": 1755694420855,
"version": "2.0.0",
"trips": [
{
"accessibility_attributes": [],
"city": "Berlin",
"country": "DE",
"device_id": "93d4e213-0d93-5839-a631-8070ded1be5a",
"distance": 5903,
"duration": 3269,
"average_ride_speed": 6,
"start_location": {
"lat": 52.53364,
"lng": 13.4337015
},
"start_time": 1755346018818,
"end_location": {
"lat": 52.57755,
"lng": 13.427708
},
"end_time": 1754482956399,
"is_group_ride": false,
"license_plate": "2025-grün2-625bxi",
"license_plate_id": "e72955c7-c3cc-4cd1-8d0b-4a8c5376b127",
"provider_id": "1f129e3f-158f-4df5-af9c-a80de238e334",
"ride_type": "solo",
"trip_id": "020b1efc-4cf6-4dd6-b6e6-8dfe079c76c1",
"trip_type": [
"rider",
"voi"
],
"user_ride_count": 66,
"vehicle_short_id": "trjs"
}
]
}

Response

The trips: Payload { "trips": [] }, is an array of objects with the following structure.

Field NametypeDefines
accessibility_attributesArrayArray of accessibility features available for this trip
cityStringCity where the trip took place
countryStringCountry code where the trip took place
device_idStringUnique identifier for the device used
distanceNumberDistance of the trip in meters
durationNumberDuration of the trip in seconds
average_ride_speedNumberAverage speed during the trip in kilometers per hour
start_locationObjectObject containing lat/lng coordinates where trip started
start_timeNumberUnix timestamp when trip started
end_locationObjectObject containing lat/lng coordinates where trip ended
end_timeNumberUnix timestamp when trip ended
is_group_rideBooleanWhether this was a group ride
license_plateStringThe Visual License plate of the vehicle
license_plate_idStringUnique identifier for the license plate
provider_idStringUnique identifier for the service provider
ride_typeStringType of ride (e.g. "solo", "group-host","group-guest")
trip_idStringUnique identifier for the trip
trip_typeArrayArray of strings describing the trip type {"rider", "voi", "maas"}
user_ride_countNumberNumber of rides the user has taken
vehicle_short_idStringShort identifier for the vehicle

HTTPS request

GET api.voiapp.io/v1/partner-apis/insurance/{zoneID}/trips

Path parameters

parameterdescriptionpresence
zoneIDThe zone id for the requested tripsrequired

Query parameters

parameterdescriptionpresence
end_timeYYYY-MM-DDTHH, an ISO 8601 extended DateTime representing a UTC hour between 00 and 23.required