Aclaimant Answers API

openapi: 3.2.0
info:
  title: Aclaimant Platform Answers API
  description: Summary of endpoints
servers:
- url: /api
tags:
- name: Answers
paths:
  /v1/answers/{company-ident}/{external-ident}:
    get:
      responses:
        default:
          description: ''
      parameters:
      - in: path
        name: company-ident
        description: ''
        required: true
        title: company-ident
        example: COMPANY_IDENT
        schema:
          type: string
      - in: path
        name: external-ident
        description: The external-ident of the answer bundle
        required: true
        title: external-ident
        example: YOUR_IDENT
        schema:
          type: string
      security:
      - apiKeyAuth: []
      tags:
      - Answers
      summary: Get answers by company ident by external ident
      x-summary-source: derived
      operationId: getV1AnswersByCompanyIdentByExternalIdent
      x-operation-id-source: derived
  /v1/events/{external-ident}:
    patch:
      responses:
        default:
          description: ''
      parameters:
      - in: path
        name: external-ident
        description: external identifier for this event
        required: true
        title: event/external-ident
        example: EVENT_IDENT
        schema:
          type: string
      summary: Update an event
      security:
      - apiKeyAuth: []
      tags:
      - Answers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company-ident:
                  type: string
                  title: company-ident
                  example: COMPANY_IDENT
                event:
                  type: object
                  properties:
                    date:
                      description: date (format like "2011-01-23")
                      title: quay.api/date
                      example: '2011-03-24'
                    type:
                      type: string
                      description: event type (e.g. "Return to Work")
                      title: event/type
                      example: Return to Work
                    category:
                      type: string
                      description: event category string
                      title: event/category
                      example: category name
                    subject:
                      type: array
                      items: {}
                      x-items:
                      - type: string
                      - type:
                        - string
                        - 'null'
                      x-anyOf:
                      - type: array
                        items: {}
                        x-items:
                        - type: string
                        - type:
                          - string
                          - 'null'
                      - enum:
                        - quay.api/delete
                        type: string
                      description: a tuple in the pattern [title subtitle]
                      title: quay.api.patch/subject
                      example:
                      - Title
                      - subtitle
                    note:
                      type: string
                      description: event note string
                      title: event/note
                    location:
                      type: string
                      description: event location string
                      title: event/location
                      example: location of event
                    sub-category:
                      type: string
                      description: event sub-category string
                      title: event/sub-category
                      example: subcategory name
                    external-ident:
                      type: string
                      description: external identifier for this event
                      title: event/external-ident
                      example: EVENT_IDENT
                  title: quay.api.patch/event
              required:
              - company-ident
              - event
        required: true
      operationId: patchV1EventsByExternalIdent
      x-operation-id-source: derived
  /v1/events:
    post:
      responses:
        default:
          description: ''
      summary: Create an event for an existing item
      security:
      - apiKeyAuth: []
      tags:
      - Answers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company-ident:
                  type: string
                  title: company-ident
                  example: COMPANY_IDENT
                external-ident:
                  type: string
                  description: The external-ident of the answer bundle
                  title: external-ident
                  example: YOUR_IDENT
                event:
                  type: object
                  properties:
                    date:
                      description: date (format like "2011-01-23")
                      title: quay.api/date
                      example: '2011-03-24'
                    type:
                      type: string
                      description: event type (e.g. "Return to Work")
                      title: event/type
                      example: Return to Work
                    category:
                      type: string
                      description: event category string
                      title: event/category
                      example: category name
                    subject:
                      type: array
                      items: {}
                      x-items:
                      - type: string
                      - type:
                        - string
                        - 'null'
                      description: a tuple in the pattern [title subtitle]
                      title: event/subject
                      example:
                      - Title
                      - subtitle
                    note:
                      type: string
                      description: event note string
                      title: event/note
                    location:
                      type: string
                      description: event location string
                      title: event/location
                      example: location of event
                    sub-category:
                      type: string
                      description: event sub-category string
                      title: event/sub-category
                      example: subcategory name
                    external-ident:
                      type: string
                      description: external identifier for this event
                      title: event/external-ident
                      example: EVENT_IDENT
                  required:
                  - date
                  - type
                  - category
                  title: quay.api/event
              required:
              - company-ident
              - external-ident
              - event
        required: true
      operationId: postV1Events
      x-operation-id-source: derived
  /v1/answers/prototype:
    post:
      responses:
        default:
          description: ''
      summary: Return the specification for a given workflow and input map
      security:
      - apiKeyAuth: []
      tags:
      - Answers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company-ident:
                  type: string
                  title: company-ident
                  example: COMPANY_IDENT
                workflow-id:
                  type: string
                  format: uuid
                workflow:
                  type: string
                  x-allOf:
                  - type: string
                  - {}
                  description: string that is not empty or whitespace only
                  title: aclaimant.service.routes.quay/workflow
                input-map-id:
                  type: string
                  format: uuid
                input-map:
                  type: string
                  x-allOf:
                  - type: string
                  - {}
                  description: string that is not empty or whitespace only
                  title: aclaimant.service.routes.quay/input-map
              required:
              - company-ident
              - workflow-id
              - workflow
              - input-map-id
              - input-map
        required: true
      operationId: postV1AnswersPrototype
      x-operation-id-source: derived
  /v1/claims/{policy-external-ident}/{claim-number}:
    patch:
      responses:
        default:
          description: ''
      parameters:
      - in: path
        name: claim-number
        description: claim number for the claim
        required: true
        title: claim/claim-number
        example: CLAIM_NUMBER
        schema:
          type: string
      - in: path
        name: policy-external-ident
        description: The external identifier of the policy
        required: true
        title: policy external identifier
        example: POLICY_ID
        schema:
          type: string
      security:
      - apiKeyAuth: []
      tags:
      - Answers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company-ident:
                  type: string
                  title: company-ident
                  example: COMPANY_IDENT
                claim:
                  type: object
                  properties:
                    status-date:
                      description: date (format like "2011-01-23")
                      title: claim/status-date
                      example: '2011-03-24'
                    policy-period-effective-date:
                      description: date (format like "2011-01-23")
                      title: claim/policy-period-effective-date
                      example: '2011-03-24'
                    default-adjuster:
                      type: string
                    status:
                      enum:
                      - closed
                      - open
                      type: string
                      description: claim status (e.g. "open" or "closed")
                      title: claim/status
                      example: open
                    subject:
                      type: array
                      items: {}
                      x-items:
                      - type: string
                      - type:
                        - string
                        - 'null'
                      x-anyOf:
                      - type: array
                        items: {}
                        x-items:
                        - type: string
                        - type:
                          - string
                          - 'null'
                      - enum:
                        - quay.api/delete
                        type: string
                      description: a tuple in the pattern [title subtitle]
                      title: quay.api.patch/subject
                      example:
                      - Title
                      - subtitle
                    default-adjuster-email:
                      type: string
                    claim-number:
                      type: string
                      description: claim number for the claim
                      title: claim.patch/claim-number
                      example: CLAIM_NUMBER
                    submitted-date:
                      description: date (format like "2011-01-23")
                      title: claim.patch/submitted-date
                      example: '2011-03-24'
                    coverage-type:
                      description: coverage type string (e.g. "workers-comp")
                      title: claim/coverage-type
                      example: workers-comp
                    default-adjuster-phone:
                      type: string
                    policy-external-ident:
                      type: string
                      description: The external identifier of the policy
                      title: policy external identifier
                      example: POLICY_ID
                  title: quay.api.patch/claim
                pipeline-run-identifier:
                  type: string
              required:
              - company-ident
              - claim
        required: true
      summary: Update claims by policy external ident by claim number
      x-summary-source: derived
      operationId: patchV1ClaimsByPolicyExternalIdentByClaimNumber
      x-operation-id-source: derived
  /v2/answers:
    post:
      responses:
        default:
          description: ''
      summary: Create or update a response (single answer bundle) to a workflow
      security:
      - apiKeyAuth: []
      tags:
      - Answers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                workflow-id:
                  type: string
                  format: uuid
                source-identifier:
                  type: string
                  description: The source-identifier of the answer-bundle
                  title: answer-bundle source-identifier
                  example: SOURCE_IDENTIFIER
                model-id:
                  type: string
                  format: uuid
                external-identifier:
                  type: string
                  description: The external identifier of the answer-bundle
                  title: answer-bundle external identifier
                  example: ANSWER_BUNDLE_ID
                files:
                  type: array
                  items:
                    type: object
                    properties:
                      filename:
                        type: string
                        description: A filename shown in the files list (e.g. "photo-01.jpg")
                        title: file/filename
                      content-type:
                        type: string
                        description: The content-type of the file data (e.g. "image/jpeg")
                        title: file/content-type
                      content-length:
                        type: integer
                        description: The content-length of the file data measured in bytes
                        title: file/content-length
                      confidential?:
                        type: boolean
                        description: True when file is considered secure and should only be shown to users with view-confidential permission
                        title: file/confidential?
                      tags:
                        type: array
                        items:
                          type: string
                        description: An array of strings to tag the file with. The tags must already be created on the company.
                        title: file/tags
                      external-identifier:
                        type: string
                        description: The external identifier of the file
                        title: file external identifier
                        example: FILE_ID
                    required:
                    - filename
                    - content-type
                    - content-length
                    title: quay.api.v2.answers/file
                input-map-id:
                  type: string
                  format: uuid
                workflow:
                  type: string
                  x-allOf:
                  - type: string
                  - {}
                  description: string that is not empty or whitespace only
                  title: aclaimant.service.routes.quay/workflow
                answers:
                  type: object
                  additionalProperties: {}
                  title: deprecated way of specifying inputs
                search-results:
                  type: object
                  additionalProperties:
                    type: string
                  description: search result ident to look up values by
                  title: quay.api/search-results
                  example:
                    search-name: ident-of-a-search-result
                pipeline-run-identifier:
                  type: string
                events:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        description: date (format like "2011-01-23")
                        title: quay.api/date
                        example: '2011-03-24'
                      type:
                        type: string
                        description: event type (e.g. "Return to Work")
                        title: event/type
                        example: Return to Work
                      category:
                        type: string
                        description: event category string
                        title: event/category
                        example: category name
                      subject:
                        type: array
                        items: {}
                        x-items:
                        - type: string
                        - type:
                          - string
                          - 'null'
                        description: a tuple in the pattern [title subtitle]
                        title: event/subject
                        example:
                        - Title
                        - subtitle
                      note:
                        type: string
                        description: event note string
                        title: event/note
                      location:
                        type: string
                        description: event location string
                        title: event/location
                        example: location of event
                      sub-category:
                        type: string
                        description: event sub-category string
                        title: event/sub-category
                        example: subcategory name
                      external-identifier:
                        type: string
                        description: The external identifier of the event
                        title: event external identifier
                        example: EVENT_ID
                    required:
                    - date
                    - type
                    - category
                    title: quay.api.v2/event
                company-ident:
                  type: string
                  title: company-ident
                  example: COMPANY_IDENT
                state:
                  x-allOf:
                  - {}
                  - enum:
                    - pending
                    - completed
                    - submitted
                    - cancelled
                    - draft
                    type: string
                  description: one of the valid states for an answer bundle (e.g. "draft", "submitted", etc)
                  title: quay.api/state
                  example: submitted
                inputs:
                  type: object
                  additionalProperties: {}
                  title: inputs
                messages:
                  type: array
                  items:
                    type: object
                    properties:
                      sender-phone-number:
                        x-anyOf:
                        - {}
                        - enum:
                          - quay.api/delete
                          type: string
                        description: a valid phone-number or "quay.api/delete"
                        title: message/sender-phone-number
                      external-identifier:
                        type: string
                        description: The external identifier of the message
                        title: message external identifier
                        example: MESSAGE_ID
                      sender-user-id:
                        type: string
                        format: uuid
                        x-anyOf:
                        - type: string
                          format: uuid
                        - enum:
                          - quay.api/delete
                          type: string
                        description: a valid UUID or "quay.api/delete"
                        title: message/sender-user-id
                        example: 9b132a70-522d-469a-ada9-8aaccf55fde7
                      received-at:
                        description: datetime or datetime string (format like "2011-01-23T18:37:49Z")
                        title: message/received-at
                      sender-email:
                        x-anyOf:
                        - {}
                        - enum:
                          - quay.api/delete
                          type: string
                        description: a valid email or "quay.api/delete"
                        title: message/sender-email
                        example: bill.lumberg@initec.com
                      metadata:
                        x-anyOf:
                        - {}
                        - enum:
                          - quay.api/delete
                          type: string
                        description: a map of email metadata fields
                        title: message/metadata
                      confidential?:
                        description: true/false
                        title: message/confidential?
                      body-markdown:
                        type: string
                        description: markdown
                        title: message/body-markdown
                      attachments:
                        x-anyOf:
                        - {}
                        - enum:
                          - quay.api/delete
                          type: string
                      sender-name:
                        type: string
                        x-anyOf:
                        - type: string
                        - enum:
                          - quay.api/delete
                          type: string
                        description: a valid string or "quay.api/delete"
                        title: message/sender-name
                        example: a string
                    required:
                    - received-at
                    - body-markdown
                    - sender-user-id
                    - sender-email
                    - sender-phone-number
                    - sender-name
                    title: quay.api.v2/message
                claims:
                  type: array
                  items:
                    type: object
                    properties:
                      claim-reports:
                        type: array
                        items:
                          type: object
                          properties:
                            reported-date:
                              description: date (format like "2011-01-23")
                              title: claim-report/reported-date
                              example: '2011-03-24'
                            entries:
                              type: array
                              items:
                                type: object
                                properties:
                                  category:
                                    enum:
                                    - medical
                                    - legal
                                    - indemnity
                                    - general
                                    - property-damage
                                    - recovery
                                    - cargo-loss
                                    - vocational
                                    - cargo-damage
                                    - expense
                                    type: string
                                    description: entry category (e.g. "medical")
                                    title: claim-report-entry/category
                                  payments:
                                    description: entry payments amount
                                    type: number
                                    example: 123.42
                                    title: claim-report-entry/payments
                                  oslr:
                                    description: OSLR payments amount
                                    type: number
                                    example: 123.42
                                    title: claim-report-entry/oslr
                                  reserves:
                                    description: reserve payments amount
                                    type: number
                                    example: 123.42
                                    title: claim-report-entry/reserves
                                  recovery:
                                    description: recovery payments amount
                                    type: number
                                    example: 123.42
                                    title: claim-report-entry/recovery
                                required:
                                - category
                                - payments
                                - oslr
                                title: claim-report/entry
                            adjuster:
                              type: string
                              description: adjuster string
                              title: claim-report/adjuster
                            adjuster-phone:
                              type: string
                              description: adjuster phone-number string
                              title: claim-report/adjuster-phone
                            adjuster-email:
                              type: string
                              description: adjuster email address string
                              title: claim-report/adjuster-email
                            external-identifier:
                              type: string
                              description: The external identifier of the claim-report
                              title: claim-report external identifier
                              example: CLAIM_REPORT_ID
                            note:
                              type: string
                              description: note string
                              title: claim-report/note
                            target-close-date:
                              description: date (format like "2011-01-23")
                              title: claim-report/target-close-date
                              example: '2011-03-24'
                          required:
                          - reported-date
                          - entries
                          title: quay.api.v2/claim-report
                      status-date:
                        description: date (format like "2011-01-23")
                        title: claim/status-date
                        example: '2011-03-24'
                      external-identifier:
                        type: string
                        description: The external identifier of the claim
                        title: claim external identifier
                        example: CLAIM_ID
                      policy-period-effective-date:
                        description: date (format like "2011-01-23")
                        title: claim/policy-period-effective-date
                        example: '2011-03-24'
                      default-adjuster:
                        type: string
                      status:
                        enum:
                        - closed
                        - open
                        type: string
                        description: claim status (e.g. "open" or "closed")
                        title: claim/status
                        example: open
                      subject:
                        type: array
                        items: {}
                        x-items:
                        - type: string
                        - type:
                          - string
                          - 'null'
                        description: a tuple in the pattern [title subtitle]
                        title: event/subject
                        example:
                        - Title
                        - subtitle
                      default-adjuster-email:
                        type: string
                      claim-number:
                        type: string
                        description: claim number for the claim
                        title: claim/claim-number
                        example: CLAIM_NUMBER
                      submitted-date:
                        description: date (format like "2011-01-23")
                        title: claim/submitted-date
                        example: '2011-03-24'
                      coverage-type:
                        description: coverage type string (e.g. "workers-comp")
                        title: claim/coverage-type
                        example: workers-comp
                      default-adjuster-phone:
                        type: string
                      transactions:
                        type: array
                        items:
                          type: object
                          properties:
                            tax-id:
                              type: string
                              description: tax identifier string
                              title: transaction/tax-id
                              example: tax identifier
                            payee-type:
                              type: string
                              description: string
                              title: transaction/payee-type
                            diagnosis-code-2:
                              type: string
                              description: string
                              title: transaction/diagnosis-code-2
                            indicator-4850:
                              description: 4859 Indicator?
                              title: transaction/indicator-4850
                              example: 'false'
                            invoice-amount:
                              description: numeric monetary value
                              title: transaction/invoice-amount
                              type: number
                              example: 123.42
                            payee:
                              type: string
                              description: payee string
                              title: transaction/payee
                              example: payee name
                            diagnosis-code-6:
                              type: string
                              description: string
                              title: transaction/diagnosis-code-6
                            diagnosis-code-5:
                              type: string
                              description: string
                              title: transaction/diagnosis-code-5
                            exempt-1099:
                              description: 1099 Exempt?
                              title: transaction/exempt-1099
                              example: 'true'
                            payee-address:
                              type: string
                              description: string
                              title: transaction/payee-address
                            external-identifier:
                              type: string
                              description: The external identifier of the transaction
                              title: transaction external identifier
                             

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