Arity Developer Portal

Drivers

Method

Description

POST

createDriver

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers

Create a driver on the Arity platform.

Driving Events

Method

Description

POST

createPhase

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/phases

Add rideshare phase (aka period) information associated with a specific driver. Phase 0 - app offline Phase 1 - app online, but no ride request accepted Phase 2 - Ride request accepted, en route to rider location Phase 3 - Rider picked up in car

Risks & Utilization Insights

Method

Description

POST

createPrequalReport

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/prequal-report

Generate a PreQual report on a specific driver by providing information on that driver, who needs to be registered already. This endpoint supports the output of the Checkr MVR, mapped under the "mvr" object in the request payload.

GET

getPrequalReport

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/prequal-report

Return a PreQual report on a specific driver.

GET

getDriverBehavior

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/behavior

Return driving behavior and utilization information on a specific driver. Response is capped at 30 days, when start and end dates provided exceed the limit, information on the latest 30 days will be provided. Ex. when start date is 2018-01-01 and end date is 2018-02-20, information is returned from 2018-01-21 to 2018-02-20.

GET

getDriverRiskProfile

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/risk-profile

Return the profile of the risk scores based on driving data associated with each phase,

GET

getVehicleUtilization

https://api-sandbox.arity.com/shared-mobility-insights/v1/vehicles/{vin}/utilization

Return a utilization report on a specific vehicle. Data on number of days returned is capped at 30 days, when start and end dates provided exceed the limit, information on the latest 30 days will be provided. Ex. when start date is 2018-01-01 and end date is 2018-02-20, information is returned from 2018-01-21 to 2018-02-20.

Mobility Trends

Method

Description

GET

getOriginDataForDestinationZIPCode

https://api-sandbox.arity.com/shared-mobility-insights/v1/zip-codes/{zipCode}/origin-zip-codes

Get data about trips to a destination, organized by where trips are starting from.

GET

getDestinationDataForOriginZIPCode

https://api-sandbox.arity.com/shared-mobility-insights/v1/zip-codes/{zipCode}/destination-zip-codes

Get data about trips from an origin, organized by where trips are ending at.

GET

getOriginBlockDataWithinZIPCode

https://api-sandbox.arity.com/shared-mobility-insights/v1/zip-codes/{zipCode}/origin-blocks

Get data on where trips start within a ZIP code, organized by census blocks. In major cities, census blocks are comparable in size to city blocks.

GET

getDestinationBlockDataWithinZIPCode

https://api-sandbox.arity.com/shared-mobility-insights/v1/zip-codes/{zipCode}/destination-blocks

Get data on where trips end within a ZIP code, organized by census blocks. In major cities, census blocks are comparable in size to city blocks.

Driver Enrollment

Method

Description

PUT

updateDriverEnrollment

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/enrollment

Update the enrollment status of a driver

GET

getDriverEnrollment

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/enrollment

Get the enrollment status of a driver