Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Arity Driving Engine and Booking Authentication API
version: unversioned
description: Arity Driving Engine (authentication, trip intelligence, registration, groups, scoring, activation) and Booking API, as documented at apidocs.arity.com.
x-generated-from: postman-collection
x-source-url: https://apidocs.arity.com/
x-ae-authored: true
x-last-validated: '2026-10-13'
x-note: Converted by API Evangelist from Arity's published Postman Documenter collection (2966050/TW76E5ZE). Arity does not publish an OpenAPI. Response schemas are not documented in the source and are not invented here.
servers:
- url: https://api.arity.com
security:
- oauth2: []
tags:
- name: Authentication
paths:
/platform/oauth/v1/token:
post:
operationId: GeneratetokenB2B
summary: generateToken (b2b)
tags:
- Authentication
description: Generate an access token that you can use for authorization on subsequent API calls. The b2b scope identifies the organization, and is required when calling the Arity platform from your back-end systems.
responses:
default:
description: Response shape not documented in the source collection.
/registration/v2/users/{userId}:
get:
operationId: validateMobileToken
summary: validateMobileToken
tags:
- Authentication
description: Use this endpoint to get a user's details from a userId. By passing the user's mobile scope token for authentication, you can validate the token with a success response form this endpoint. This is the same endpoint as getUserDetails API, but you will typically call that with your b2b token from the back-end.
responses:
default:
description: Response shape not documented in the source collection.
parameters:
- name: userId
in: path
required: true
schema:
type: string
components:
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.arity.com/platform/oauth/v1/token
scopes: {}