Audatex

Audatex Claim API

The Claim API from Audatex — 3 operation(s) for claim.

GitHub OpenAPI

Operations 3

GET /api/v1/Claim/Get Get details of a claim by claimId #
GET /api/v1/Claim/GetByClaimnumber Get details of a claim by claimnumber #
POST /api/v1/Claim/Post Add an assessment to a claim #

Documentation

📖
Documentation
https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/help
📖
APIReference
https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/help
📖
Authentication
https://audaconnect.ax-aee.co.uk/AudaAPI.BMSAPI/home/help
📖
GettingStarted
https://audaconnect.ax-aee.co.uk/AudaAPI.BMSAPI/home/register
📖
Documentation
https://audaconnect.ax-aee.co.uk/AudaAPI.BMSAPI/home/help
📖
Documentation
https://services-pat.auda-target.com/APIGateway/swagger/index.html
📖
APIReference
https://services-pat.auda-target.com/APIGateway/swagger/index.html
📖
Documentation
https://api-demo.audatex.com/TestGICapi/docs/index.html
📖
Documentation
https://api-demo.audatex.com/TestAssignmentapi/docs/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/openapi/audatex-claim-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://audaconnect.ax-aee.co.uk/AudaAPI.Portal/
🔗
Sandbox
https://audaconnect-demo.ax-aee.co.uk/AudaAPI.WebAPI/
🔗
Webhooks
https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/Help/Topic/NotificationTopics
🔗
Sandbox
https://audaconnect-demo.ax-aee.co.uk/AudaAPI.Bmsapi/
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/asyncapi/audatex-webhooks.yml
🔗
Sandbox
https://api-demo.audatex.com/TestGICapi/docs/index.html
🔗
Sandbox
https://api-demo.audatex.com/TestAssignmentapi/docs/index.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/audatex:audatex-claim-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

audatex-claim-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Audatex.APIGateway Claim API
  termsOfService: https://www.solera.com/legal/
  contact:
    name: Solera Development Team
    url: https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio
    email: development@solera.com
  license:
    name: License
    url: https://www.solera.com/legal/
  version: V1
servers:
- url: /APIGateway
security:
- Bearer: []
- Bearer: []
tags:
- name: Claim
paths:
  /api/v1/Claim/Get:
    get:
      tags:
      - Claim
      summary: Get details of a claim by claimId
      description: The details return about the claim are controlled via the OAuth2 scopes.
      parameters:
      - name: claimId
        in: query
        description: The id of the claim
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the claim details
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ClaimRespViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimRespViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ClaimRespViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorised
      deprecated: true
      operationId: getApiV1ClaimGet
      x-operation-id-source: derived
  /api/v1/Claim/GetByClaimnumber:
    get:
      tags:
      - Claim
      summary: Get details of a claim by claimnumber
      description: The details return about the claim are controlled via the OAuth2 scopes.
      parameters:
      - name: claimnumber
        in: query
        description: The claimnumber of the claim
        schema:
          type: string
      responses:
        '200':
          description: Returns the claim details
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ClaimRespViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimRespViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ClaimRespViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorised
      deprecated: true
      operationId: getApiV1ClaimGetByClaimnumber
      x-operation-id-source: derived
  /api/v1/Claim/Post:
    post:
      tags:
      - Claim
      summary: Add an assessment to a claim
      description: This endpoint will allow you to add an assessmet with the AEG AssessmentId, Assessment Number and Originator to a claim.
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ClaimReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ClaimReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ClaimReqViewModel'
        required: true
      responses:
        '201':
          description: Returns a created response
        '400':
          description: Returns an error if the request fails validation or if the claimnumber does not exist or if the assessment failed to create
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      deprecated: true
      operationId: postApiV1ClaimPost
      x-operation-id-source: derived
components:
  schemas:
    ReservationViewModel:
      type: object
      properties:
        id:
          type: string
          description: The Id of the reservation
          format: uuid
        entityId:
          type: string
          description: The Id of the entity that the reservation was made against
          format: uuid
        estimatorId:
          type: string
          description: The Id of the estimator that the reservation was made against
          format: uuid
        timeSlot:
          $ref: '#/components/schemas/TimeSlotViewModel'
      additionalProperties: false
      description: Details of the reservation
    AssessmentViewModel:
      type: object
      properties:
        id:
          type: string
          description: The Id of the assesment
          format: uuid
        externalAssessmentId:
          type:
          - string
          - 'null'
          description: The external assessment Id
        assessmentNumber:
          type:
          - string
          - 'null'
          description: The assessment number
        originator:
          type:
          - string
          - 'null'
          description: The originator Id for the assessment
      additionalProperties: false
      description: Details of an assessment associated with the claim
    AppointmentViewModel:
      type: object
      properties:
        id:
          type: string
          description: Appointment Id
          format: uuid
        reservation:
          $ref: '#/components/schemas/ReservationViewModel'
      additionalProperties: false
      description: The appointment details
    TimeSlotViewModel:
      type: object
      properties:
        slot:
          type:
          - string
          - 'null'
          description: The slot that was used to create the reservation
        slotNumber:
          type:
          - string
          - 'null'
          description: 'If a day booking was made then this parameter will be visible.

            If a time interval booking was made then this paramater will not be shown'
        date:
          type:
          - string
          - 'null'
          description: This is the date the reservation was made for. It will be display in IS0-8601 format (yyyy-mm-dd)
        timeFrom:
          type:
          - string
          - 'null'
          description: This will only be displayed if a time interval booking was made, e.g. "09:00"
        timeTo:
          type:
          - string
          - 'null'
          description: This will only be displayed if a time interval booking was made, e.g. "09:30"
      additionalProperties: false
      description: The details of the reservation time slot
    ClaimViewModel:
      type: object
      properties:
        claimNumber:
          type:
          - string
          - 'null'
          description: Claim number
        uniqueClientkey:
          type:
          - string
          - 'null'
          description: Unique client key
        policyNumber:
          type:
          - string
          - 'null'
          description: Policy number against the claim
        parties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PartyViewModel'
          description: List of parties if any exist against the claim
      additionalProperties: false
      description: The claim details
    ClaimRespViewModel:
      type: object
      properties:
        id:
          type: string
          description: ClaimId
          format: uuid
        claim:
          $ref: '#/components/schemas/ClaimViewModel'
        appointment:
          $ref: '#/components/schemas/AppointmentViewModel'
        repairer:
          $ref: '#/components/schemas/RepairerViewModel'
        assessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssessmentViewModel'
          description: List of associated assessments
      additionalProperties: false
      description: Claim Response view model for the Get request
    PartyViewModel:
      type: object
      properties:
        id:
          type: string
          description: The Id of the party
          format: uuid
        addressId:
          type:
          - string
          - 'null'
          description: The address Id if one has been associated with the party
          format: uuid
        vehicleId:
          type:
          - string
          - 'null'
          description: The vehicle Id if one has been associated with the party
          format: uuid
        vehicleLocationId:
          type:
          - string
          - 'null'
          description: The vehicle address / location if one has been associated with the vehicle
          format: uuid
        partyType:
          type:
          - string
          - 'null'
          description: The type of party
      additionalProperties: false
      description: Details of a party associated with the claim
    ClaimReqViewModel:
      required:
      - claimId
      - externalAssessmentId
      type: object
      properties:
        claimId:
          type: string
          description: The claim Id for the assessment to be associated with
          format: uuid
        externalAssessmentId:
          maxLength: 50
          minLength: 1
          type: string
          description: The external assessment Id of the assessment to be created
        assessmentNumber:
          maxLength: 50
          type:
          - string
          - 'null'
          description: The assessment number
        originator:
          maxLength: 50
          type:
          - string
          - 'null'
          description: The originator Id for the assessment
      additionalProperties: false
      description: Claim to Allocation request View Model
    RepairerViewModel:
      type: object
      properties:
        id:
          type: string
          description: The repairer Id
          format: uuid
        name:
          type:
          - string
          - 'null'
          description: The repairer name
        siteId:
          type:
          - string
          - 'null'
          description: The site Id
        primaryTerminalId:
          type:
          - string
          - 'null'
          description: The primar terminal Id
      additionalProperties: false
      description: The details of the allocated repairer
  securitySchemes:
    Bearer:
      type: apiKey
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter 'Bearer' [space] and then your token in the text input below.\n\nExample: \"Bearer 12345abcdef\""
      name: Authorization
      in: header