Arity Developer Portal

The Driving Insights API is built to help you better evaluate risk for your drivers, improve the accuracy of insurance pricing, and influence good driving behavior.

Using Arity’s SDK, you will be able to collect detailed driving data from your users and send it to the Arity platform. In return, we’ll use our scoring models to provide you a unique driving score for each user (or group of users) via the Driving Insights API. The Driving Insights API allows you to control everything around enabling data collection and retrieving a driving score for your users:

Create and manage groups of users (e.g., all individuals on a policy)
Assign Arity’s scoring models to groups
Generate activation codes for your users (which will allow their mobile devices to send driving data to the Arity platform)
Get a driving score for a group of users

group-controller

Method

Description

POST

createGroup

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups

Create a group within the organization specified in the request.

GET

getGroup

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}

Retrieve the properties of a group, including modelName, groupId, orgId, and a list of userIds in that group.

DELETE

removeGroupFromOrg

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}

Remove a group from an org.

PUT

updateModelForGroup

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}/model

Update the scoring model for a group.

PUT

addUserToGroup

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}/users

Add a user to a group. If the user is already in a group, they will be removed from that group and added to the group specified in the request.

DELETE

removeUserFromGroup

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}/users/{userId}

Remove a user from a group.

user-controller

Method

Description

GET

getGroupForUser

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/users/{userId}/group

Retrieve the group information for a user.

GET

getModelForUser

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/users/{userId}/model

Retrieve the scoring model for a particular user.

activation-code-controller

Method

Description

POST

generateActivationCode

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/users/{userId}/activation

Generate a single-use activation code for a user. The code expires 30 days after being issued.

score-controller

Method

Description

GET

getScoreForGroup

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}/score

Retrieve the score for a group.

GET

getUserDetails

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/users/{userId}

Retrieve user's details for org.

GET

getScoreForUser

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/users/{userId}/user-score

Retrieve the score for a user.

GET

getUsers

https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/users

Retrieve all users' details for org.