Solera

Audatex Assignment Get Document API (GetImage)

Claim image document retrieval. The claim-image callback publishes a HATEOAS link into this surface, and the client GETs the referenced document by locator. Version 1.0 exposes the claim-document-by-locator operation; version 2.0 exposes a version endpoint. OpenAPI 3.0.1, and the only Solera surface that declares its bearer credential as an apiKey-style Authorization header scheme rather than an oauth2 scheme, with the API version carried in an api-version request header. Served anonymously from the Swagger UI on both the demo and production hosts.

GitHub OpenAPI

Documentation

📖
APIReference
https://api-prod.audatex.com/GetImage/docs/index.html
📖
Documentation
https://na.api.solera.com/files/ClaimImage%20Return%20API.pdf
📖
Authentication
https://dispatch-login.audatex.com/.well-known/openid-configuration

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/solera/refs/heads/main/openapi/solera-getimage-v1-openapi.json
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/solera/refs/heads/main/openapi/solera-getimage-v2-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/solera/refs/heads/main/overlays/solera-getimage-v1-overlay.yaml
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/solera/refs/heads/main/overlays/solera-getimage-v2-overlay.yaml

OpenAPI Specification

solera-getimage-v1-openapi.json Raw ↑ 
{
  "openapi": "3.0.1",
  "info": {
    "title": "Audatex Assignment Get Document API",
    "description": "Cancel an assignment to the Audatex system. Assignment messages are transmitted in the CIECA BMS format.",
    "contact": {
      "name": "Audatex",
      "email": "http://www.audatex.us/product.asp?pageid=zContact_us"
    },
    "license": {
      "name": "@Audatex North America, Inc. All rights reserved",
      "url": "http://www.audatex.us/"
    },
    "version": "1.0"
  },
  "paths": {
    "/api/v{version}/claims/document/{locator}": {
      "get": {
        "tags": [
          "GetClaimImageResponse"
        ],
        "parameters": [
          {
            "name": "locator",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "nullable": true
            }
          },
          {
            "name": "version",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "description": "The requested API version",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "description": "Authorization header using the Bearer scheme",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Bearer": [ ]
    }
  ]
}