Shared Mobility Solutions API | Arity Developer Portal

Manage risk, recruit and retain drivers and maximize efficiency using our transportation models built with machine learning.

Step 0

Follow the Get Started guide to create an account, add an app and generate a b2b-scope access token.

Step 1 – Arity PreQual℠

Use Arity PreQual to obtain a risk assessment for each of your drivers. A PreQual request has two header parameters and a JSON request body. The response contains scores, projected loss amounts and relativity values to indicate risk, as well as unique IDs for each driver.

Headers

Authorization: Your access token from step 0 above.
driverId: A unique identifier for each driver. We encourage you to provide a meaningful value. However, the parameter is optional; if you leave it blank, Arity will automatically generate a 32-character hexadecimal driverId.
In some instances we use the term userId instead of driverId. Note that they represent the same value. (We know this can be confusing and we’re sorry.)

Body

The JSON request body contains general information about your driver, including data from a motor vehicle record (MVR).

Response

The response contains 15 values to indicate the risk of a driver. These values are scores, expected loss amounts, and relativity values.

Score: A value from 100-900 representing the risk of a driver, where 100 is the highest risk and 900 is the lowest risk.
Amount: Expected losses (in USD) for a driver per year.
Relativity: Expresses a specific driver’s risk relative to the average driver, where 1.00 is equal, 2.00 is twice as risky, 0.50 is half as risky, etc.

The response also contains the driverId and the associated deviceId. These values are used together in step 2 below, so we recommend storing them together. They get lonely otherwise.

If you are only using PreQual, disregard the remaining steps. If you are using other Shared Mobility Solutions, such as Vehicle Utilization or Driver Performance, continue following the steps below.

Step 2 – Mobile Authorization

To collect and upload actual driving data with Arity’s SDK, you must first generate a mobile authorization token for each driver. This is done with the same Authorization API from step 0. However, this time the scope is mobile (instead of b2b) and you must supply the userId (driverId) and deviceId from the PreQual response.

The response will contain an access token specific to that driver. This token will need to be stored in your app to allow Arity’s SDK to successfully upload trip data for that particular driver.

Step 3 – SDK Integration

Next, you’re ready to download Arity’s Driving Engine SDK and embed it into your own mobile app. The SDK automatically collects trip data from your driver and uploads it to our platform. The mobile-scope access token from step 2 associates trip data with the driver who completed the trip. To track trip data by vehicle, you’ll need to pass the VIN in the metadata field. A valid VIN is required for accurate vehicle usage costs.

Check out the SDK documentation for more information.

Step 4 – More Insights

With the SDK collecting data by driver and vehicle, you’re ready to use more Shared Mobility Solutions to gain insights based on Arity’s algorithms that are run daily. Click a product below to view its complete documentation:

Vehicle Utilization: Access the daily miles driven, repair costs, maintenance costs, and fuel utilization for each vehicle in your fleet.
Driver Performance: Understand driver performance based on contextual speed and other risky behaviors, where the vehicle-driver relationship is fluid.