Solera / Audatex EAPI Event Callbacks

asyncapi: 3.0.0
x-apievangelist-generated: '2026-07-25'
x-apievangelist-method: generated
x-apievangelist-spec-type: AsyncAPI
x-apievangelist-source: |
  Generated by API Evangelist from the event surface Solera / Audatex document in prose:
  Estimate Document Return API Integration Guide sections 6.3-6.4 (HATEOAS message data
  dictionary + sample payload), Claim Image Document Return API Integration Guide sections
  6.3.2-6.3.3, and GIC - Image Capture API Integration Guide (M31 event sample). Solera
  publishes NO AsyncAPI document; this is a faithful reconstruction of the published data
  dictionaries and sample messages, not a provider artifact.
info:
  title: Solera / Audatex EAPI Event Callbacks
  version: '1.0.0'
  description: |
    Audatex Integrations (EAPI) pushes claim lifecycle events to a CLIENT-hosted HTTPS
    endpoint. The client registers its callback endpoints and the credentials Audatex
    should use, per assignment, in the `responseRoute` block of the assignment request
    (POST /api/v2/assignments). Audatex then authenticates against the client's own
    authorization server and POSTs a HATEOAS message; the client subsequently
    authenticates back to Audatex and GETs each document referenced in `Body.Links`.

    Delivery is at-least-once. Estimate/claim-image callbacks are retried up to 3 times
    with a 15 second timeout; the GIC M31 event is retried up to 3 times every 10
    seconds. Exhausted messages are routed to an Audatex-side reject queue. There is no
    signature header — authenticity rests on the client-supplied credentials and optional
    IP allowlisting of the Audatex egress addresses (test 170.76.172.18, production
    170.76.172.20).

    THIS DOCUMENT IS AN API EVANGELIST GENERATION from Solera's published prose
    documentation. Solera does not publish an AsyncAPI specification.
  contact:
    name: Audatex Technical Support
    url: https://www.mysupportgarage.com
    email: AXUS.AASupportContact@audatex.com
  license:
    name: Audatex North America, Inc. All rights reserved
    url: https://www.audatex.us/
  tags:
    - name: claims
      description: Automobile physical damage claims lifecycle events.
    - name: estimate-return
      description: Events raised when an Audatex Estimate (ADXE) completes.
    - name: images
      description: Claim image and mobile image-capture events.
    - name: cieca-bms
      description: Payloads reference CIECA BMS 5.7 documents retrieved over HTTP.
defaultContentType: application/json
servers:
  clientEndpoint:
    host: client-defined
    protocol: https
    description: |
      The client's own HTTPS endpoint, supplied per assignment in
      responseRoute.responseMessage[].href. Audatex is the publisher and the client is
      the server; there is no Solera-hosted broker or subscription endpoint.
channels:
  assignmentAcknowledgement:
    address: '{clientAssignmentAckEndpoint}'
    title: Assignment acknowledgement callback
    description: Registered as responseMessage[] entry with type "Assignment".
    parameters:
      clientAssignmentAckEndpoint:
        description: Client-defined endpoint for assignment acknowledgement.
    messages:
      assignmentAck:
        $ref: '#/components/messages/AssignmentAck'
  estimateReturn:
    address: '{clientEstimateReturnEndpoint}'
    title: Estimate complete callback
    description: Registered as responseMessage[] entry with type "EstimateReturn".
    parameters:
      clientEstimateReturnEndpoint:
        description: Client-defined endpoint for the Estimate Return message.
    messages:
      estimateComplete:
        $ref: '#/components/messages/EstimateComplete'
  claimImageReturn:
    address: '{clientClaimImageEndpoint}'
    title: Claim image callback
    description: |
      Registered as responseMessage[] entry with type "ClaimImageReturn". If the client
      does not supply a Claim Image URL, Audatex reuses the Estimate Return URL.
    parameters:
      clientClaimImageEndpoint:
        description: Client-defined endpoint for the Claim Image message.
    messages:
      claimImageComplete:
        $ref: '#/components/messages/ClaimImageComplete'
  m31ImageUpload:
    address: '{clientM31Endpoint}'
    title: M31 mobile image-upload-completed event
    description: |
      Raised by Audatex Estimate (ADXE) once images captured on the mobile client have
      finished uploading. Acknowledged back through
      POST /api/v1/getM31EventAcks on the EAPI GIC Integration API.
    parameters:
      clientM31Endpoint:
        description: Client-defined endpoint notified of the M31 event.
    messages:
      m31Event:
        $ref: '#/components/messages/M31Event'
operations:
  sendAssignmentAck:
    action: send
    channel:
      $ref: '#/channels/assignmentAcknowledgement'
    summary: Audatex acknowledges receipt of a submitted assignment.
    description: |
      POSTed to the client endpoint registered as responseMessage[] type "Assignment"
      on the originating assignment request. Delivered at-least-once.
  sendEstimateComplete:
    action: send
    channel:
      $ref: '#/channels/estimateReturn'
    summary: Audatex notifies the client that an Audatex Estimate (ADXE) completed and
      publishes hypermedia links to every related document.
    description: |
      POSTed to the client endpoint registered as responseMessage[] type "EstimateReturn".
      The client then authenticates back to Audatex and issues an HTTP GET against each
      Body.Links[].Href to retrieve the Base64-encoded document. Retried up to 3 times
      with a 15 second timeout before the message is routed to the Audatex reject queue.
  sendClaimImageComplete:
    action: send
    channel:
      $ref: '#/channels/claimImageReturn'
    summary: Audatex publishes a hypermedia link to a completed claim image document.
    description: |
      POSTed to the client endpoint registered as responseMessage[] type
      "ClaimImageReturn". If the client registered no claim-image endpoint, Audatex
      reuses the Estimate Return endpoint.
  sendM31Event:
    action: send
    channel:
      $ref: '#/channels/m31ImageUpload'
    summary: Audatex Estimate signals that mobile-captured images finished uploading.
    description: |
      Event code M31, raised once the last mobile-captured image has uploaded. Retried up
      to 3 times every 10 seconds before the message is routed to the reject queue.
      Acknowledged back through POST /api/v1/getM31EventAcks on the EAPI GIC Integration
      API.
components:
  messages:
    AssignmentAck:
      name: assignmentAck
      title: Assignment acknowledgement
      contentType: application/json
      summary: |
        Acknowledgement of a submitted assignment. Solera publishes a live sample of this
        payload at POST /api/v2/assignmentAcks on the Assignment API rather than a schema;
        no field-level data dictionary is published, so no payload schema is asserted here.
    EstimateComplete:
      name: estimateComplete
      title: Audatex.Event.EstimateComplete
      contentType: application/json
      headers:
        type: object
        properties:
          Rquid:
            type: string
            description: The client's CIECA BMS AssignmentRq RQUID.
          MessageType:
            type: string
            const: Audatex.Event.EstimateComplete
      payload:
        $ref: '#/components/schemas/HateoasMessage'
      examples:
        - name: estimateCompleteSample
          summary: Sample published in the Estimate Document Return API Integration Guide
          payload:
            Header:
              Rquid: 08D943266CB6984C-ff54af838aa242a583c
              Cid: 8bdb2311-6cb2-4d5f-a6f8-cc47ebcd629a
              MessageType: Audatex.Event.EstimateComplete
            Body:
              ClaimNumber: '5101762'
              Links:
                - Rel: claimXml
                  Method: GET
                  Href: https://api-demo.audatex.com/GetDocuments/api/<apiversion>/claims/311671832/document/f76da32a-3ea2-46c2-b7cb0be4672ae659
                  Type: application/json
                  Info: null
                - Rel: attachments
                  Method: GET
                  Href: https://api-demo.audatex.com/GetDocuments/api/<apiversion>/claims/539274853/document/a843ecf0-8ced-4b30-a87931d9cbcf2b08
                  Type: application/json
                  Info:
                    Notation: ''
                    FileType: '2'
                    Extension: .jpg
                    AttachmentDatetime: '2021-08-04T07:53:55'
                    EstimateId: '0'
              PassThroughData: 'Loss Description: IV stolen, OK To Pay: YES, Damage Description: '
    ClaimImageComplete:
      name: claimImageComplete
      title: Audatex.Event.EstimateComplete (claim image variant)
      contentType: application/json
      payload:
        $ref: '#/components/schemas/HateoasMessage'
      examples:
        - name: claimImageSample
          summary: Sample published in the Claim Image Document Return API Integration Guide
          payload:
            Header:
              Rquid: 1prod24032022-3761-445a-9e7f-63c9d9d9ddf6
              Cid: 5ED7BC86-4CE8-429B-80CD-875C3C42211C
              MessageType: Audatex.Event.EstimateComplete
            Body:
              ClaimNumber: V2-1PROD24022022
              Links:
                - Rel: claimImage
                  Method: GET
                  Href: https://api-prod.audatex.com/GetImage/api/v1/claims/document/5ED7BC86-4CE8-429B-80CD-875C3C42211C
                  Type: application/json
                  Info: null
              PassThroughData: ''
    M31Event:
      name: m31Event
      title: adxe.estimate.image-upload-for-mobile-completed
      contentType: application/json
      payload:
        $ref: '#/components/schemas/M31EventMessage'
      examples:
        - name: m31Sample
          summary: Sample published in the GIC - Image Capture API Integration Guide
          payload:
            messageType: adxe.estimate.image-upload-for-mobile-completed
            routingKey: adxe.estimate.image-upload-for-mobile-completed
            id: c3ccbaa3-4a87-4826-947a-395d4737686b
            body:
              workAssignmentId: '208092037'
              createdForProfileId: 196TEST0037
              eventSource: adxe.estimate
              eventSourceDetails: Falcon 8.1.325.4a PROD
              eventCode: M31
              eventDescription: Images gets uploaded from the Mobile Client
              eventTime: '2021/11/19T15:54:38.483Z'
              roleCode: 196.TEST,Appraiser:196admin
              roleDescription: ''
              estimateStatus: '0'
              claimGuid: ''
              claimNo: DEVT1_25112021
              claimId: '115259627'
  schemas:
    HateoasMessage:
      type: object
      properties:
        Header:
          type: object
          properties:
            Rquid:
              type: string
              description: Client BMS AssignmentRq RQUID.
            Cid:
              type: string
              description: Audatex correlation identifier.
            MessageType:
              type: string
              description: Event discriminator, e.g. Audatex.Event.EstimateComplete.
        Body:
          type: object
          properties:
            ClaimNumber:
              type: string
            Links:
              type: array
              items:
                $ref: '#/components/schemas/DocumentLink'
            PassThroughData:
              type: string
              description: Free-text data the client supplied on the assignment, echoed back.
    DocumentLink:
      type: object
      properties:
        Rel:
          type: string
          description: Link relation. Published values, verbatim, are claimXml, printImages,
            attachments and claimImage. The Estimate Return data dictionary describes the
            field as Xml/PrintImage/Jpeg.
        Method:
          type: string
          description: HTTP method to use against Href. Published value is GET.
        Href:
          type: string
          format: uri
          description: URL of the related document on the Audatex GetDocuments or GetImage
            surface.
        Type:
          type: string
          description: Mime type.
        Info:
          type: object
          nullable: true
          properties:
            Notation:
              type: string
              description: Notation for attachments.
            FileType:
              type: string
            Extension:
              type: string
              description: File type extension.
            AttachmentDatetime:
              type: string
              description: Attachment creation date/time.
            EstimateId:
              type: string
    M31EventMessage:
      type: object
      properties:
        messageType:
          type: string
        routingKey:
          type: string
        id:
          type: string
        body:
          type: object
          properties:
            workAssignmentId:
              type: string
            createdForProfileId:
              type: string
            eventSource:
              type: string
            eventSourceDetails:
              type: string
            eventCode:
              type: string
              description: Audatex event code. M31 is "Images gets uploaded from the Mobile
                Client".
            eventDescription:
              type: string
            eventTime:
              type: string
            roleCode:
              type: string
            roleDescription:
              type: string
            estimateStatus:
              type: string
            claimGuid:
              type: string
            claimNo:
              type: string
            claimId:
              type: string
  securitySchemes:
    clientHostedOAuth:
      type: oauth2
      description: |
        Audatex authenticates AGAINST THE CLIENT before delivering a callback, using the
        client_Id, client_Secret, audience and scope the client supplied in
        responseRoute.authorization on the assignment request. The client's own
        authorization server issues the token; Audatex presents it as a bearer credential
        in the HTTP Authorization header on the callback POST.
      flows:
        clientCredentials:
          tokenUrl: https://client-defined/oauth/token
          availableScopes: {}