Arity Developer Portal

Mobilize your users with the power to request Roadside Service and monitor real-time rescue status within your app.

Rescue Assist Tool

Method

Description

POST

https://api-sandbox.arity.com/services/roadside/v1/rescue/test/statusUpdate

Allows partners to book a rescue without the assistance of Allstate Roadside. The partners will be able to update status of requested...

Tow To Locations

Method

Description

POST

getTowToLocations

https://api-sandbox.arity.com/services/roadside/v1/rescue/tow/locations

Retrive a list of locations where the consumer vehicle can choose to be towed.

Determine Service

Method

Description

POST

createTireRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/tire

Initiates a service request for a TIRE CHANGE service based on factors such as destination address, service type, vehicle, etc., which will...

POST

createLockoutRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/lockout

Initiates a service request for a LOCKOUT service based on factors such as destination address, service type, vehicle, etc., which will be...

POST

createBatteryRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/battery

Initiates a service request for a BATTERY JUMP service based on factors such as destination address, service type, vehicle, etc., which...

POST

createGasRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/gas

Initiates a service request for a GAS service based on factors such as destination address, service type, vehicle, etc., which will be...

POST

createTowRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/tow

Initiates a service request for a TOW service based on factors such as destination address, service type, vehicle, etc., which will be...

Determine Customer & Vehicle

Method

Description

GET

getMake

https://api-sandbox.arity.com/services/roadside/v1/vehicle/makes

Given a vehicle Year as input, this service provides a list of vehicle Make options.

GET

getServiceAreaValidation

https://api-sandbox.arity.com/services/roadside/v1/rescue/available

Given latitude, longitude and zipCode, this API checks for location where requested service is available or not.

GET

getModel

https://api-sandbox.arity.com/services/roadside/v1/vehicle/makes/{make}/models

Given a vehicle Make and year as input, this service provides a list of vehicle Models.

Get Started

Method

Description

POST

createSession

https://api-sandbox.arity.com/services/roadside/v1/rescue/session

Used to initiate a rescue session when consumer provides a required valid input credentials.

Dispatch & Track Rescue

Method

Description

GET

getETA

https://api-sandbox.arity.com/services/roadside/v1/rescue/eta

Given latitude and longitude values, this API provides average response time in minutes based on recent history.

POST

cancelServiceRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}/cancel

Cancel the initial request for service. The rescue can only be cancelled before the status is APPROACHING and the ETA is greater than 15...

GET

getProviders

https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}/providers

The application will poll on this API method after the rescue request is created. The results will provide all the service provider related...

GET

getServiceRequestInfo

https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}

The application will poll on this API method after the rescue request has been BOOKED.This method returns all rescue service details...

Collect Customer Feedback

Method

Description

POST

createFeedback

https://api-sandbox.arity.com/services/roadside/v1/rescue/feedback

Allows customer to provide feedback of the requested service, once service is completed

Determine Price | Retrieve Benefits

Method

Description

GET

getBenefits

https://api-sandbox.arity.com/services/roadside/v1/rescue/benefits

Retrieve the benefit details associated with member ID credentials.

POST

getServiceCost

https://api-sandbox.arity.com/services/roadside/v1/rescue/costs

Retrieve the cost of rescue service by using the lat/long values of both the disablement location and the destination location. Cost is in...