Booking Quickstart Guide

Shared Mobility’s Booking API allows Fleet Utilization OBD-II customers to send additional booking or “rental” data to pair their vehicle trip history to their users or “drivers.” This documentation includes everything needed to successfully pair users to vehicles for an allotted amount of time. If you have any additional questions around using the Booking API, please contact your Customer Success team.

All requests to Arity require authentication and all applications must be registered with us.


  1. Client ID and Client Secret
    Get your Client ID and Client Secret. These have already been created and approved by Arity, and have been sent to you. Contact us if you need help locating them.
  2. Access token
    Generate an access token with the Authorization API. This access token expires every hour and must be passed in the header of all subsequent API calls.
    Use the generateToken endpoint to generate a b2b-scope access token by sending your Client ID and Client Secret. This access token expires every hour and must be passed in the header of all subsequent API calls.
  3. User
    We require a created user to pair them to a vehicle’s trip history. In Fleet Utilization, a user refers to the driver that books or “rents” a vehicle. A dateOfBirth, in the format of YYYY-MM-DD, is not required to create a user or to pair them to a vehicle; however, it is required to receive an Arity PreQual℠ score at another date.
    Use the POST /users/{userId} endpoint to create a new user. You can specify the userId or if you leave it blank, Arity will generate one for you. To create a user with an auto-generated id, leave the userId field NULL or remove the key-value pair entirely.
  4. Vehicle
    In addition to userId data, we require a created vehicle using the Vehicle Identification Number (VIN) in order to later pair a user and a vehicle together. The vin must be 17-digits in length to be considered valid.
  5. Use the POST /vehicles/{vin} method to create a new VIN.
  6. Start Booking
    Once a userId and a vin are created, you can start a Booking. Along with the userId and vin, we require a bookingId and a startTimestamp while an estimatedEndTimestamp is optional to start a Booking. The startTimestamp must be in Epoch format and it indicates the actual time a Booking started. The estimatedEndTimestamp must also be in Epoch format and it indicates the estimated time a Booking will end.
  7. Use the POST /bookings endpoint to start a new Booking.
  8. End Booking
    Once a Booking has started and a user has returned the vehicle, you can then end a Booking. Along with the same bookingId that was used to start the booking, we require an endTimestamp to end a Booking. The endTimestamp must be in Epoch format and it indicates the actual time a Booking ends.
  9. Use the PUT /bookings/{bookingId} endpoint to end a Booking that has already been started.
  10. Retrieve Trip History by Vehicle or User
    At any time following the successful start and ending of a Booking, you may retrieve Trip History data by Vehicle or by User via separate endpoints:
  11. Use the GET /vehicles/{vin}/trips endpoint to retrieve a list of trip summaries for a vehicle.
    Use the GET /users/{userId}/trips endpoint to retrieve a list of trip summaries for a user.

© 2019 Arity, LLC. All rights reserved.  | Privacy Policy | Terms of Use | Legacy APIs