Arity Developer Portal

Devices

Method

Description

PUT

Update device effective end date by User

https://api-sandbox.arity.com/registration/v2/users/{userId}/devices/{deviceId}

Update Device effective end date for a user.

PUT

Add device to vehicle

https://api-sandbox.arity.com/registration/v2/devices/{deviceId}/vehicle/{vehicleId}

This endpoint allows you to add an existing device to an existing vehicle. You can use this route with a device with no previous vehicle or a device already assigned to a different vehicle. If the device is already assigned to a different vehicle, the association will be updated. The old vehicle will no longer have a relationship with this device, and the new vehicle will from that point forward. If the vehicle already has a relationship with a different device, that association will be updated also. The old device will no longer have a relationship with this vehicle. This route will return the updated details of the device passed in.

PUT

Update user's only active device

https://api-sandbox.arity.com/registration/v2/users/{userId}/devices

Replace a user's only active device with the user's id and an optional new device Id. The user's old active device will be deactivated and a new device will be created, activated, and assigned to the user. If the user has multiple active devices, this route will throw a Bad Request. In that case, use the PUT /devices/{deviceId} route to specify which device to replace.

PUT

Add an existing device to an existing user.

https://api-sandbox.arity.com/registration/v2/devices/{deviceId}/users/{userId}

This endpoint allows you to add an existing device to an existing user. You can use this route with a device with no previous users or a device already assigned to a different user. If the device is already assigned to a different user, the association will be updated. The old user will no longer have a relationship with this device, and the new user will from that point forward.

PUT

Update Device Status to Active/Inactive

https://api-sandbox.arity.com/registration/v2/devices/{deviceId}/status

Update Device Status to Active/Inactive

GET

Get Devices By User

https://api-sandbox.arity.com/registration/v2/devices/users/{userId}

This endpoint allows you to get the historical and current devices for a user

GET

Get Device Status

https://api-sandbox.arity.com/registration/v2/devices/{deviceId}

This endpoint returns the details of the device like deviceId, type and user (if the device is associated to a user)

PUT

Replace Device With a New Device

https://api-sandbox.arity.com/registration/v2/devices/{deviceId}

Use this endpoint to replace the phone associated with a given user ID. This should be used in two scenarios- before re-registering a previously enrolled user to the Driving Behavior product, or when a user has replaced their phone and will be uploading data from the new device. The old device will be deactivated and we will no longer collect data from it. We will only collect data from the new device provisioned by this call. The device ID stored on the phone needs to also be replaced.

Vehicles

Method

Description

POST

Create a vehicle with a device

https://api-sandbox.arity.com/registration/v2/vehicles/devices

This endpoint allows you to create a vehicle with a device on the Arity platform.

GET

Get a Vehicle By VehicleId

https://api-sandbox.arity.com/registration/v2/vehicle/{vehicleId}

This endpoint allows you to retrieve details of a vehicle on the Arity platform.

PUT

Update a Vehicle

https://api-sandbox.arity.com/registration/v2/vehicle/{vehicleId}

This endpoint allows you to update a vehicle on the Arity platform.

PUT

https://api-sandbox.arity.com/registration/v2/product/{productName}/vehicle/{vehicleId}/register

This endpoint allows you to register a vehicle to an existing product on the Arity platform.

POST

Create a Vehicle

https://api-sandbox.arity.com/registration/v2/vehicles

This endpoint allows you to create a vehicle on the Arity platform.

Users

Method

Description

GET

Get User by User Id

https://api-sandbox.arity.com/registration/v2/users/{userId}

Use this endpoint to get a user's details from a userId. You will get back the userId, userActive status, the products the user is registered to, and a list of device objects with deviceIds and whether they are active or inactive.

GET

Get User by Device Id

https://api-sandbox.arity.com/registration/v2/users/devices/{deviceId}

Use this endpoint to get a user's details from a deviceId. You will get back the userId, userActive status, the products the user is registered to, and a list of device objects with deviceIds and whether they are active or inactive.

POST

Create a User

https://api-sandbox.arity.com/registration/v2/users

This endpoint allows you to create a user on the Arity platform. Once the user is made, you need to register that user to any Arity products that your organization has access to. There is also a batch process API where you may register a new user and assign them to a new product in one call (POST /users/products)

PUT

PUT Activate or Deactivate a user

https://api-sandbox.arity.com/registration/v2/users/{userId}/activation

This endpoint allows you to activate or deactivate a user by setting status to true or false respectively. An optional device id or product list can be supplied to associate with the user on activation.

PATCH

PATCH Activate or Deactivate a user

https://api-sandbox.arity.com/registration/v2/users/{userId}/activation

POST

Create New User and Register to Products

https://api-sandbox.arity.com/registration/v2/users/products

This endpoint allows you to create a user on the Arity platform and register that user to a product. Once these two steps are completed, the user will be ready to upload data to the platform and have it processed and read.

User Registration

Method

Description

DELETE

Unregister a User from a Product

https://api-sandbox.arity.com/registration/v2/users/{userId}/products/{productName}

This endpoint unregisters an existing user from a product. The same user may later be registered back to the product.

POST

https://api-sandbox.arity.com/registration/v2/users/{userId}/products/{productName}

This endpoint registers an existing user to a product. **We currently do not support re-registering a user to Driving Behavior after they have been previously unenrolled.**

Consents

Method

Description

POST

https://api-sandbox.arity.com/registration/v2/consents

This endpoint allows you to register consent to a version of Terms of Service.

GET

Get Consents by User Id

https://api-sandbox.arity.com/registration/v2/consents/{userId}

Use this endpoint to get a user's Consents.