Arity Registration API

openapi: 3.2.0
info:
  title: Arity Driving Engine and Booking Registration 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: Registration
paths:
  /registration/v2/users/products:
    post:
      operationId: createUser
      summary: createUser
      tags:
      - Registration
      description: 'Create User Account

        Create an Arity userId needed to track the driving behavior of your mobile app end-user.

        URL : https://api.arity.com/registration/v2/users/products

        URL parameters : none

        Method : POST

        Auth required : YES - b2b Oauth token

        Data constraints

        Provide userId of account to be created. Alternatively leave this null and we will return a unique string.

        Provide a deviceId for this user. Alternatively leave this null and we will return a unique string.

        Indicate that your user is enrolled in the Driving Behavior product'
      responses:
        default:
          description: Response shape not documented in the source collection.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              userId: ''
              deviceId: ''
              products:
              - Driving Behavior
  /drivinginsights/v1/orgs/{orgId}/groups/{groupId}/users:
    post:
      operationId: groupAddUser
      summary: groupAddUser
      tags:
      - Registration
      description: groupAddUser (as listed in the Arity Postman documentation).
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              userId: '{{userId}}'
  /drivinginsights/v1/orgs/{orgId}/groups/{groupId}/users/{userId}:
    delete:
      operationId: groupRemoveUser
      summary: groupRemoveUser
      tags:
      - Registration
      description: groupRemoveUser (as listed in the Arity Postman documentation).
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        required: true
        schema:
          type: string
      - name: userId
        in: path
        required: true
        schema:
          type: string
  /drivinginsights/v1/orgs/{orgId}/groups/{groupId}:
    get:
      operationId: groupGet
      summary: groupGet
      tags:
      - Registration
      description: groupGet (as listed in the Arity Postman documentation).
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        required: true
        schema:
          type: string
  /drivinginsights/v1/orgs/{orgId}/users/{userId}:
    get:
      operationId: getUserActivationStatus
      summary: getUserActivationStatus
      tags:
      - Registration
      description: getUserActivationStatus (as listed in the Arity Postman documentation).
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: userId
        in: path
        required: true
        schema:
          type: string
  /reporting-insights/orgs/{orgId}/report:
    get:
      operationId: ActivationReportingByDateRange
      summary: Activation Reporting by Date Range
      tags:
      - Registration
      description: Activation Reporting by Date Range (as listed in the Arity Postman documentation).
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
  /drivinginsights/v1/orgs/{orgId}/users/{userId}/group:
    get:
      operationId: getGroupForUser
      summary: getGroupForUser
      tags:
      - Registration
      description: getGroupForUser (as listed in the Arity Postman documentation).
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      - name: userId
        in: path
        required: true
        schema:
          type: string
  /drivinginsights/v1/orgs/{orgId}/groups:
    post:
      operationId: createGroup
      summary: createGroup
      tags:
      - Registration
      description: Create a group and assign one of Arity's scoring models so that any user(s) in the group can be scored according to that model. It is possible to have groups with only one user. In that case we suggest naming the groupId the same as the userId.
      responses:
        default:
          description: Response shape not documented in the source collection.
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              modelName: '{{modelName}}'
              userIds:
              - '{{userId}}'
              groupId: '{{groupId}}'
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.arity.com/platform/oauth/v1/token
          scopes: {}