Claim.Revolution API

openapi: 3.1.0
info:
  title: Claim.Revolution API
  version: '2026-10-27'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-27: 40 operation(s) read from 40 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Claim.Revolution has published no machine-readable
    contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 40
    pages-with-code: 0
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-27'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.claimrev.com/reference/post-api-inputfile-v-1
  - https://developer.claimrev.com/reference/get-api-userprofile-v-1
  - https://developer.claimrev.com/reference/get-api-savedsearches-v-1
  - https://developer.claimrev.com/reference/get-api-customersso-v-1-me
  - https://developer.claimrev.com/reference/get-api-userpreferences-v-1
  - https://developer.claimrev.com/reference/post-api-attachment-275-v-1
  - https://developer.claimrev.com/reference/post-api-tickets-v-1-search
  - https://developer.claimrev.com/reference/get-api-attachment-275-v-1-id
  - https://developer.claimrev.com/reference/post-api-workflow-v-1-savetag
  - https://developer.claimrev.com/reference/get-api-diagnostics-v-1-whoami
  - https://developer.claimrev.com/reference/post-api-impersonation-v-1-end
  - https://developer.claimrev.com/reference/get-api-clientconnectconfig-v-1
  - https://developer.claimrev.com/reference/get-api-rulemanager-v-1-newrule
  - https://developer.claimrev.com/reference/get-api-dashboardpreferences-v-1
  - https://developer.claimrev.com/reference/get-api-sharprcm-v-1-getpractice
  - https://developer.claimrev.com/reference/get-api-zitadelinvite-v-1-banner
  - https://developer.claimrev.com/reference/post-api-module-v-1-checkversion
  - https://developer.claimrev.com/reference/get-api-childaccount-v-1-children
  - https://developer.claimrev.com/reference/post-api-attachment-275-v-1-search
  - https://developer.claimrev.com/reference/post-api-childaccount-v-1-children
  - https://developer.claimrev.com/reference/get-api-integrationcheck-v-1-checks
  - https://developer.claimrev.com/reference/post-api-claimview-v-1-searchclaims
  - https://developer.claimrev.com/reference/post-api-communication-v-1-gettoken
  - https://developer.claimrev.com/reference/post-api-payerlist-v-1-searchpayers
  - https://developer.claimrev.com/reference/get-api-edieditor-v-1-loopmap-format
  - https://developer.claimrev.com/reference/post-api-coverageresearch-v-1-search
  - https://developer.claimrev.com/reference/post-api-ocrreview-v-1-flagocrreview
  - https://developer.claimrev.com/reference/get-api-analytics-v-1-reports-araging
  - https://developer.claimrev.com/reference/get-api-codes-v-1-getservicetypecodes
  - https://developer.claimrev.com/reference/get-api-ediresponsefile-v-1-getreport
  - https://developer.claimrev.com/reference/get-api-enrollment-v-1-validate-token
  - https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-status
  - https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-submit
  - https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-upload
  - https://developer.claimrev.com/reference/get-api-aimodelconfig-v-1-resolvemodel
  - https://developer.claimrev.com/reference/get-api-analytics-v-1-config-agegroups
  - https://developer.claimrev.com/reference/get-api-supportinfo-v-1-getsupportinfo
  - https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-preview
  - https://developer.claimrev.com/reference/put-api-analytics-v-1-config-agegroups
  - https://developer.claimrev.com/reference/get-api-analytics-v-1-reports-chargelag
paths:
  /api/AiModelConfig/v1/ResolveModel:
    get:
      operationId: get_api_AiModelConfig_v1_ResolveModel
      tags:
      - Api
      summary: Resolves which AI model will be used for the given feature, considering account config, system defaults, and the optional user-picked
        model.
      x-source: https://developer.claimrev.com/reference/get-api-aimodelconfig-v-1-resolvemodel
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAimodelconfigV1ResolvemodelResponse'
      x-evidence:
        kind: documentation
  /api/Analytics/v1/Config/AgeGroups:
    get:
      operationId: get_api_Analytics_v1_Config_AgeGroups
      tags:
      - Api
      summary: Returns the configured age-group buckets used by analytics reports for the given account.
      x-source: https://developer.claimrev.com/reference/get-api-analytics-v-1-config-agegroups
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_Analytics_v1_Config_AgeGroups
      tags:
      - Api
      summary: Updates the account's age-group bucket configuration. At least one group is required.
      x-source: https://developer.claimrev.com/reference/put-api-analytics-v-1-config-agegroups
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Analytics/v1/Reports/ArAging:
    get:
      operationId: get_api_Analytics_v1_Reports_ArAging
      tags:
      - Api
      summary: Returns AR-aging buckets (0-30, 31-60, 61-90, 90+) by payer.
      x-source: https://developer.claimrev.com/reference/get-api-analytics-v-1-reports-araging
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Analytics/v1/Reports/ChargeLag:
    get:
      operationId: get_api_Analytics_v1_Reports_ChargeLag
      tags:
      - Api
      summary: Returns lag metrics between date-of-service and charge-submission date.
      x-source: https://developer.claimrev.com/reference/get-api-analytics-v-1-reports-chargelag
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Attachment275/v1:
    post:
      operationId: post_api_Attachment275_v1
      tags:
      - Api
      summary: Creates or updates an attachment from the editor. AttachmentId on the VM dictates create (null/empty) vs. update. AccountNumber
        is forced server-side.
      x-source: https://developer.claimrev.com/reference/post-api-attachment-275-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Attachment275/v1/{id}:
    get:
      operationId: get_api_Attachment275_v1_id
      tags:
      - Api
      summary: Returns a single attachment's editor view.
      x-source: https://developer.claimrev.com/reference/get-api-attachment-275-v-1-id
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Attachment275/v1/{id}/Preview:
    post:
      operationId: post_api_Attachment275_v1_id_Preview
      tags:
      - Api
      summary: 'Read-only "Generate EDI" preview: builds and returns the outbound 275 EDI text (with attachment bytes) so the user can eyeball
        what would ship.'
      description: Generates the outbound 275 EDI text for an attachment without side effects; status remains unchanged and no outbound file is
        queued.
      x-source: https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-preview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Attachment275/v1/{id}/Status:
    post:
      operationId: post_api_Attachment275_v1_id_Status
      tags:
      - Api
      summary: Manually sets an attachment's status (e.g. Matched / Error / SentToPayer).
      x-source: https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-status
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAttachment275V1IdStatusResponse'
      x-evidence:
        kind: documentation
  /api/Attachment275/v1/{id}/Submit:
    post:
      operationId: post_api_Attachment275_v1_id_Submit
      tags:
      - Api
      summary: Generates the outbound 275 EDI text for an attachment and flips status to ReadyToSend. Returns the EDI text so the UI can preview
        what was generated.
      x-source: https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-submit
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Attachment275/v1/{id}/Upload:
    post:
      operationId: post_api_Attachment275_v1_id_Upload
      tags:
      - Api
      summary: Uploads one or more files to an existing attachment. Each file is chunked and stored in GCS (one chunk per object). LxSequence
        numbers are assigned globally across the transaction's existing file set.
      x-source: https://developer.claimrev.com/reference/post-api-attachment-275-v-1-id-upload
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Attachment275/v1/Search:
    post:
      operationId: post_api_Attachment275_v1_Search
      tags:
      - Api
      summary: Paged, filtered search. AccountNumber is forced to the caller's default account; other filters are pass-through.
      x-source: https://developer.claimrev.com/reference/post-api-attachment-275-v-1-search
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ChildAccount/v1/Children:
    get:
      operationId: get_api_ChildAccount_v1_Children
      tags:
      - Api
      summary: The caller's child accounts, disabled ones included.
      x-source: https://developer.claimrev.com/reference/get-api-childaccount-v-1-children
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_ChildAccount_v1_Children
      tags:
      - Api
      summary: Creates a child account. Sending an ExternalReferenceId again returns the child already created for it.
      x-source: https://developer.claimrev.com/reference/post-api-childaccount-v-1-children
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ClaimView/v1/SearchClaims:
    post:
      operationId: post_api_ClaimView_v1_SearchClaims
      tags:
      - Api
      summary: Search Claims in the system based on the ClaimSearchModel object passed in
      x-source: https://developer.claimrev.com/reference/post-api-claimview-v-1-searchclaims
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiClaimviewV1SearchclaimsResponse'
      x-evidence:
        kind: documentation
  /api/ClientConnectConfig/v1:
    get:
      operationId: get_api_ClientConnectConfig_v1
      tags:
      - Api
      summary: Returns the active client-app configuration for the current caller's account.
      x-source: https://developer.claimrev.com/reference/get-api-clientconnectconfig-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Codes/v1/GetServiceTypeCodes:
    get:
      operationId: get_api_Codes_v1_GetServiceTypeCodes
      tags:
      - Api
      summary: Returns all EDI service type codes for use in dropdowns and lookups.
      x-source: https://developer.claimrev.com/reference/get-api-codes-v-1-getservicetypecodes
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Communication/v1/GetToken:
    post:
      operationId: post_api_Communication_v1_GetToken
      tags:
      - Api
      summary: Issues a short-lived Azure Communication Services access token for the current user so the portal can establish voice/chat sessions.
      x-source: https://developer.claimrev.com/reference/post-api-communication-v-1-gettoken
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/CoverageResearch/v1/Search:
    post:
      operationId: post_api_CoverageResearch_v1_Search
      tags:
      - Api
      summary: Search CMS national (NCD) or local (LCD) coverage documents.
      x-source: https://developer.claimrev.com/reference/post-api-coverageresearch-v-1-search
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/CustomerSso/v1/me:
    get:
      operationId: get_api_CustomerSso_v1_me
      tags:
      - Api
      summary: Whether the signed-in person signs in through their organization's SSO.
      x-source: https://developer.claimrev.com/reference/get-api-customersso-v-1-me
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/DashboardPreferences/v1:
    get:
      operationId: get_api_DashboardPreferences_v1
      tags:
      - Api
      summary: Returns the dashboard widget preferences for the current user under their default account.
      x-source: https://developer.claimrev.com/reference/get-api-dashboardpreferences-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Diagnostics/v1/WhoAmI:
    get:
      operationId: get_api_Diagnostics_v1_WhoAmI
      tags:
      - Api
      summary: 'Describes the caller as this API sees them: whether the token authenticated, which client application it belongs to, which account
        it resolves to, the scopes it carries, and when its secret expires.'
      x-source: https://developer.claimrev.com/reference/get-api-diagnostics-v-1-whoami
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/EdiEditor/v1/LoopMap/{format}:
    get:
      operationId: get_api_EdiEditor_v1_LoopMap_format
      tags:
      - Api
      summary: Returns the loop/segment map describing the structure of the given EDI format (e.g. 837P, 837I) for use by the front-end editor.
      x-source: https://developer.claimrev.com/reference/get-api-edieditor-v-1-loopmap-format
      parameters:
      - name: format
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/EdiResponseFile/v1/GetReport:
    get:
      operationId: get_api_EdiResponseFile_v1_GetReport
      tags:
      - Api
      summary: Get the EDI Response files that are waiting to download by type
      x-source: https://developer.claimrev.com/reference/get-api-ediresponsefile-v-1-getreport
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Impersonation/v1/end:
    post:
      operationId: post_api_Impersonation_v1_end
      tags:
      - Api
      summary: Called with the impersonated token when the staff member exits.
      x-source: https://developer.claimrev.com/reference/post-api-impersonation-v-1-end
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/InputFile/v1:
    post:
      operationId: post_api_InputFile_v1
      tags:
      - Api
      summary: Post your Edi File to this End Point.
      x-source: https://developer.claimrev.com/reference/post-api-inputfile-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/IntegrationCheck/v1/Checks:
    get:
      operationId: get_api_IntegrationCheck_v1_Checks
      tags:
      - Api
      summary: Every check the console may offer, each with a prefilled, editable sample body.
      x-source: https://developer.claimrev.com/reference/get-api-integrationcheck-v-1-checks
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Module/v1/CheckVersion:
    post:
      operationId: post_api_Module_v1_CheckVersion
      tags:
      - Api
      summary: Resolve the version-check response for an install.
      x-source: https://developer.claimrev.com/reference/post-api-module-v-1-checkversion
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiModuleV1CheckversionResponse'
      x-evidence:
        kind: documentation
  /api/OcrReview/v1/FlagOcrReview:
    post:
      operationId: post_api_OcrReview_v1_FlagOcrReview
      tags:
      - Api
      summary: User flags their own OCR draft for support review (bad extraction).
      x-source: https://developer.claimrev.com/reference/post-api-ocrreview-v-1-flagocrreview
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiOcrreviewV1FlagocrreviewResponse'
      x-evidence:
        kind: documentation
  /api/PayerList/v1/SearchPayers:
    post:
      operationId: post_api_PayerList_v1_SearchPayers
      tags:
      - Api
      summary: Returns payers matching the supplied search criteria for the public payer directory.
      x-source: https://developer.claimrev.com/reference/post-api-payerlist-v-1-searchpayers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/RuleManager/v1/NewRule:
    get:
      operationId: get_api_RuleManager_v1_NewRule
      tags:
      - Api
      summary: Returns an empty rule set template for the editor.
      x-source: https://developer.claimrev.com/reference/get-api-rulemanager-v-1-newrule
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/SavedSearches/v1:
    get:
      operationId: get_api_SavedSearches_v1
      tags:
      - Api
      summary: get-api-savedsearches-v1
      x-source: https://developer.claimrev.com/reference/get-api-savedsearches-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/SharpRcm/v1/GetPractice:
    get:
      operationId: get_api_SharpRcm_v1_GetPractice
      tags:
      - Api
      summary: Returns the practice for the user's default account with PHI obfuscated.
      x-source: https://developer.claimrev.com/reference/get-api-sharprcm-v-1-getpractice
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/SupportInfo/v1/GetSupportInfo:
    get:
      operationId: get_api_SupportInfo_v1_GetSupportInfo
      tags:
      - Api
      summary: Returns ClaimRev support contact details (phone, support email, sales email) as an anonymous object.
      x-source: https://developer.claimrev.com/reference/get-api-supportinfo-v-1-getsupportinfo
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Tickets/v1/Search:
    post:
      operationId: post_api_Tickets_v1_Search
      tags:
      - Api
      summary: Search tickets visible to the current user.
      x-source: https://developer.claimrev.com/reference/post-api-tickets-v-1-search
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiTicketsV1SearchResponse'
      x-evidence:
        kind: documentation
  /api/UserPreferences/v1:
    get:
      operationId: get_api_UserPreferences_v1
      tags:
      - Api
      summary: get-api-userpreferences-v1
      description: Responses 200 OK
      x-source: https://developer.claimrev.com/reference/get-api-userpreferences-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/UserProfile/v1:
    get:
      operationId: get_api_UserProfile_v1
      tags:
      - Api
      summary: Returns the client app configuration for the current user (menu, default account, feature flags, etc.).
      x-source: https://developer.claimrev.com/reference/get-api-userprofile-v-1
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/Workflow/v1/SaveTag:
    post:
      operationId: post_api_Workflow_v1_SaveTag
      tags:
      - Api
      summary: Creates or updates a workflow tag for the caller's resolved account and returns the saved tag.
      description: Creates or updates a workflow tag for the caller's resolved account and returns the saved tag.
      x-source: https://developer.claimrev.com/reference/post-api-workflow-v-1-savetag
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/ZitadelInvite/v1/banner:
    get:
      operationId: get_api_ZitadelInvite_v1_banner
      tags:
      - Api
      summary: Which banner, if any, the caller should see.
      x-source: https://developer.claimrev.com/reference/get-api-zitadelinvite-v-1-banner
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/enrollment/v1/validate/{token}:
    get:
      operationId: get_api_enrollment_v1_validate_token
      tags:
      - Api
      summary: Validates an enrollment invitation token and, if valid, returns the associated form type so the public UI can render the correct
        form.
      x-source: https://developer.claimrev.com/reference/get-api-enrollment-v-1-validate-token
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiAimodelconfigV1ResolvemodelResponse:
      type: object
      properties:
        model:
          type: string
    PostApiAttachment275V1IdStatusResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK
        '400':
          type: string
          description: Bad Request
        '404':
          type: string
          description: Not Found
    PostApiClaimviewV1SearchclaimsResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK
        '403':
          type: string
          description: Forbidden
    PostApiModuleV1CheckversionResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK
        '400':
          type: string
          description: Bad Request
    PostApiOcrreviewV1FlagocrreviewResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK
        '403':
          type: string
          description: Forbidden
    PostApiTicketsV1SearchResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK
tags:
- name: Api