Audatex

Audatex API Gateway (Intelligent Vehicle Inspection)

The Audatex.APIGateway exposes Solera's guided image capture and intelligent vehicle inspection services: send image-capture requests by SMS, link or QR code, upload images, audio and video, run AI Triage, VI damaged-parts and VI calculation requests, fetch damage-detection reports, create claims, assessments, jobs, templates, reminders and intelligent offers, search repairers, and register webhooks for 14 event types. OpenAPI 3.0.1, 75 operations, JWT Bearer authorization. Published from Audatex's pre-production acceptance-test (PAT) host.

GitHub OpenAPI

Operations 95

POST /api/v2/AiTriage POST AI Triage v2 request
GET /api/v2/AiTriage/{imageCaptureId}/{calculationId} GET an AI Triage v2 Request
POST /api/v1/Assessment/Post Create an assessment
POST /api/v1/Audio Upload a File
GET /api/v1/Audio Get content of a file by fileId
DELETE /api/v1/Audio delete content of a file by fileId
POST /api/v1/Audio/Info Create a file space in the service to be used to upload a file stream
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
POST /api/v1/ClaimRepairers Creates a claim then returns list of Repairers that can service the claim.
POST /api/v1/ClientConfiguration Add a Client Configuration associated to the EntityId
GET /api/v1/ClientConfiguration Get the Client Configuration associated to the EntityId
GET /api/v1/FraudCheck/{imageCaptureId} Gets metadata about an image capture
POST /api/v1/FraudCheck/{imageCaptureId} Add/Update metadata used in fraud check for an image capture
POST /api/v1/HeroImage Uploads a Hero Image
GET /api/v1/HeroImage Retrieves a list of Hero Images
POST /api/v1/Image/Post Add images to an assessmentId
GET /api/v1/Image/Logo Retrieves a list of logo Images
POST /api/v1/Image/Logo Uploads a Logo Image
POST /api/v1/ImageAttachment POST image capture image attachment
GET /api/v1/ImageAttachment/{imageCaptureId}/{imageAttachmentId} GET image capture image attachment
POST /api/v1/ImageCapture Send image capture SMS
POST /api/v1/ImageCapture/UsingTemplate Send image capture SMS using a template
POST /api/v1/ImageCapture/WithLink Send image capture SMS and get the link in the response
POST /api/v1/ImageCapture/WithQR Create image capture request with QR code
GET /api/v1/ImageCapture/{imageCaptureId}/WithQR Get QR code for image capture request
POST /api/v1/ImageCapture/{imageCaptureId}/Duplicate Duplicate an expired image capture
GET /api/v1/ImageCapture/{imageCaptureId} Gets details about an image capture
DELETE /api/v1/ImageCapture/{imageCaptureId} Delete Image Request
GET /api/v1/ImageCapture/{imageCaptureId}/integration Gets details about an image capture including the external image id
GET /api/v1/ImageCapture/Query/{imageCaptureId} Gets only some information about an image capture
POST /api/v1/ImageCapture/Query/{imageCaptureId} Gets only some information about an image capture
POST /api/v1/ImageCaptureExternal Allows you to upload images from an external image capture solution
GET /api/v1/ImageCaptureExternal/{imageCaptureId} Gets details about an external image capture
POST /api/v2/ImageCaptureExternal/Open Create a new image capture external v2
PUT /api/v2/ImageCaptureExternal/{imageRequestId}/Complete Complete the image capture external v2
GET /api/v2/ImageCaptureExternal/{imageCaptureId} Gets details about an external image capture v2
POST /api/v2/ImageCaptureExternal/{imageRequestId}/Images Upload images info via image capture external v2
GET /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}/{format} Get image by imageId
PUT /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId} This endpoint will allow you to upload an image associate them with an imageId
DELETE /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId} Delete an image by imageId
PUT /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}/binary This endpoint will allow you to upload an image associate them with an imageId
PUT /api/v2/ImageCaptureExternal/{imageRequestId}/Images/{imageId}/base64
GET /api/Introspection/Dependencies
GET /api/Introspection/AppDetails
GET /api/Introspection/ErrorCodes
GET /api/Introspection/Events
POST /api/v1/Job Add a Job associated to an EntityId
GET /api/v1/Job Get the job list
GET /api/v1/Job/{id} Get the job for a given id
PUT /api/v1/Job/{jobId} Update the job
DELETE /api/v1/Job/{jobId} Delete Job
GET /api/LogManagement
PUT /api/LogManagement
POST /api/v1/Offer Create a new Intelligent Offer request
GET /api/v1/Offer/{offerId} Get details about an Intelligent Offer request
GET /api/v1/Offer/Query/{offerId} Gets only some information about an Intelligent Offer
POST /api/v1/Offer/Query/{offerId} Gets only some information about an Intelligent Offer (POST version)
POST /api/v1/PingEvent Creates a ping
GET /api/v1/PingEvent/{pingId} Gets details about a ping
POST /api/v1/Reminder Create a reminder message
GET /api/v1/Reminder/{reminderId} Gets details about a reminder message
GET /api/v1/Repairer/Get Get the details of a repairer by repairerId
GET /api/v1/Repairers/search Search repairers by name
GET /api/v1/Reports/{format}/IntelligentDamageDetection/{imageCaptureId}/{commandId}/{language} GET a Report of a VI case translated to the selected language, in the format that was selected
POST /api/v1/Template Add a Template associated to an EntityId
GET /api/v1/Template Get the template list
GET /api/v1/Template/{id} Get the template for a given id
PUT /api/v1/Template/{id} Update the template
DELETE /api/v1/Template/{templateId} Delete Template
GET /api/v1/Template/Default Get the default template
PUT /api/v1/Template/Default/{name} Update the default template
POST /api/v1/Vass Creates a new Video Assessment instance
GET /api/v1/Vass/{vassId} Get an existing Video Assessment instance details by ID
GET /api/v1/Vehicle/Get Get details of a vehicle by vehicleId
POST /api/v1/ViDamagedParts POST Vi DamagedParts request
GET /api/v1/ViDamagedParts/{imageCaptureId}/{calculationId} GET a VI DamagedParts request
POST /api/v1/Video Upload a File
GET /api/v1/Video Get content of a file by fileId
DELETE /api/v1/Video delete content of a file by fileId
POST /api/v1/Video/Info Create a file space in the service to be used to upload a file stream
POST /api/v1/ViFullCalculation POST Full VI Calculation request
GET /api/v1/ViFullCalculation/{imageCaptureId}/{calculationId} GET a Full VI Calculation response
POST /api/v1/ViNoCalculation POST VI Calculation request
GET /api/v1/ViNoCalculation/{imageCaptureId}/{calculationId} GET a VI Calculation request
GET /api/v1/ViNoCalculation/{imageCaptureId}/{calculationId}/images/{imageId}/{format} GET an image of a VI Calculation request, with contours
POST /api/v2/ViNoCalculation POST VI Calculation V2 request
GET /api/v2/ViNoCalculation/{imageCaptureId}/{calculationId} GET a VI Calculation V2 request
GET /api/v1/Webhooks Gets all Webhooks
POST /api/v1/Webhooks Creates a new Webhook
GET /api/v1/Webhooks/{id} Gets Webhook by Id
DELETE /api/v1/Webhooks/{id} Deletes a Webhook
PUT /api/v1/Webhooks/{id} Updates a Webhook
GET /api/v1/Webhooks/debug Returns webhook debug information by imageCaptureId and optional event types

Documentation

📖
Documentation
https://services-pat.auda-target.com/APIGateway/swagger/index.html
📖
APIReference
https://services-pat.auda-target.com/APIGateway/swagger/index.html

Specifications

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

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/asyncapi/audatex-webhooks.yml
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/overlays/audatex-api-gateway-overlay.yaml

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-api-gateway"
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-api-gateway-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Audatex.APIGateway
  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
paths:
  /api/v2/AiTriage:
    post:
      tags:
      - AiTriage
      summary: POST AI Triage v2 request
      description: This endpoint will allow you to request a AI Triage
      parameters:
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AiTriageReqV2VM'
          application/json:
            schema:
              $ref: '#/components/schemas/AiTriageReqV2VM'
          text/json:
            schema:
              $ref: '#/components/schemas/AiTriageReqV2VM'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AiTriageReqV2VM'
      responses:
        '202':
          description: Returns an accepted response. The CalculationId returned, can be used in subsequent GET requests for
            aiTriage.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CalculationSelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CalculationSelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CalculationSelfViewModel'
        '400':
          description: Returns an error if the request fails validation or if the imageCapture cannot be found or if the imageCapture
            status is not yet complete
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Returns an error if the user is not authorised
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Returns an error if the image request id is not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Sorry, an unexpected error has occurred
  /api/v2/AiTriage/{imageCaptureId}/{calculationId}:
    get:
      tags:
      - AiTriage
      summary: GET an AI Triage v2 Request
      description: This endpoint will allow you to get the details of a AI Triage
      parameters:
      - name: imageCaptureId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: calculationId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a response with the details of an AI Triage
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AiTriageRespVM'
            application/json:
              schema:
                $ref: '#/components/schemas/AiTriageRespVM'
            text/json:
              schema:
                $ref: '#/components/schemas/AiTriageRespVM'
        '500':
          description: Sorry, an unexpected error has occurred
        '400':
          description: Returns an error if the request fails validation
        '401':
          description: Returns an error if the user is not authorised
  /api/v1/Assessment/Post:
    post:
      tags:
      - Assessment
      summary: Create an assessment
      description: This endpoint will allow you to create an assessment
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AssessmentReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/AssessmentReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AssessmentReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AssessmentReqViewModel'
        required: true
      responses:
        '201':
          description: Returns a created response
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SelfWithErrorModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SelfWithErrorModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SelfWithErrorModel'
        '400':
          description: Returns an error if the request fails validation 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
        '409':
          description: Returns a conflict response if a assessment is already created with the given assessment number and
            originator
      deprecated: true
  /api/v1/Audio:
    post:
      tags:
      - Audio
      summary: Upload a File
      description: This endpoint will allow a file to be uploaded
      responses:
        '201':
          description: Returns a created response
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
    get:
      tags:
      - Audio
      summary: Get content of a file by fileId
      description: This API will allow you to get a file stream
      parameters:
      - name: fileId
        in: query
        description: The id of the file
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the file stream
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Stream'
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
            text/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '404':
          description: Returns an error if the file is not found
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
    delete:
      tags:
      - Audio
      summary: delete content of a file by fileId
      description: This API will allow you to delete a file stream
      parameters:
      - name: fileId
        in: query
        description: The id of the file
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the file stream
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Stream'
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
            text/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
  /api/v1/Audio/Info:
    post:
      tags:
      - Audio
      summary: Create a file space in the service to be used to upload a file stream
      description: This endpoint will create the file data necessary in DB to upload a file
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/FileModel'
          application/json:
            schema:
              $ref: '#/components/schemas/FileModel'
          text/json:
            schema:
              $ref: '#/components/schemas/FileModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FileModel'
      responses:
        '201':
          description: Returns a created response with the fileId
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
  /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
  /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
  /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
  /api/v1/ClaimRepairers:
    post:
      tags:
      - ClaimRepairers
      summary: Creates a claim then returns list of Repairers that can service the claim.
      description: This endpoints creates a claim and returns a list of Repairers that can service the claim.
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ClaimRepairersReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimRepairersReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ClaimRepairersReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ClaimRepairersReqViewModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClaimRepairerRespViewModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClaimRepairerRespViewModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClaimRepairerRespViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Sorry, an unexpected error has occurred
        '201':
          description: Returns a created response
        '401':
          description: Returns an error if the user is not authorised
  /api/v1/ClientConfiguration:
    post:
      tags:
      - ClientConfiguration
      summary: Add a Client Configuration associated to the EntityId
      description: ''
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ClientConfigurationReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ClientConfigurationReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ClientConfigurationReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ClientConfigurationReqViewModel'
      responses:
        '201':
          description: Returns a created response
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
    get:
      tags:
      - ClientConfiguration
      summary: Get the Client Configuration associated to the EntityId
      description: This endpoint will allow you to get the Client Configuration associated to the EntityId
      responses:
        '200':
          description: Returns the Client Configuration
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ClientConfigurationResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ClientConfigurationResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ClientConfigurationResViewModel'
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '409':
          description: Returns an error if there is conflicting information
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
  /api/v1/FraudCheck/{imageCaptureId}:
    get:
      tags:
      - FraudCheck
      summary: Gets metadata about an image capture
      description: This API will allow you to get metadata of an image capture
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '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
        '200':
          description: Returns details
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageMetadataRespModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataRespModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataRespModel'
        '401':
          description: Returns an error if the user is not authorised
        '500':
          description: Sorry, an unexpected error has occurred
    post:
      tags:
      - FraudCheck
      summary: Add/Update metadata used in fraud check for an image capture
      description: This API will allow you to add/update some metadata of an image capture
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema: {}
          application/json:
            schema: {}
          text/json:
            schema: {}
          application/*+json:
            schema: {}
      responses:
        '400':
          description: 'Returns an error if the request fails validation: empty new data, image id not found, etc'
          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
        '200':
          description: Returns details of the image capture
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageMetadataRespModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataRespModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageMetadataRespModel'
        '401':
          description: Returns an error if the user is not authorised
        '500':
          description: Sorry, an unexpected error has occurred
  /api/v1/HeroImage:
    post:
      tags:
      - HeroImage
      summary: Uploads a Hero Image
      description: This endpoint will allow a hero image to be uploaded
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/HeroImageVM'
          application/json:
            schema:
              $ref: '#/components/schemas/HeroImageVM'
          text/json:
            schema:
              $ref: '#/components/schemas/HeroImageVM'
          application/*+json:
            schema:
              $ref: '#/components/schemas/HeroImageVM'
        required: true
      responses:
        '201':
          description: Returns a created response with the imageId
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
        '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 authorized
    get:
      tags:
      - HeroImage
      summary: Retrieves a list of Hero Images
      description: This endpoint will allow user to retrieve a ist of images that can override the hero images on pages
      responses:
        '200':
          description: Returns an OK response with the list of images
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HeroImageModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HeroImageModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HeroImageModel'
        '400':
          description: Returns an error if the request fails
          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 authorized
  /api/v1/Image/Post:
    post:
      tags:
      - Image
      summary: Add images to an assessmentId
      description: This endpoint wil

# --- truncated at 32 KB (280 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/openapi/audatex-api-gateway-openapi.yml