Hive Civilization

Hive Civilization Clear API

The Clear API from Hive Civilization — 12 operation(s) for clear.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/clear/how_to_pay Learn how to pay for CLEAR services · Clear How To Pay #
Ask an LLM
“What payment options can my agent use to settle into HiveMorph CLEAR?”
“Is there any out-of-band setup needed before paying for CLEAR calls?”
Tell an agent
Show me the payment options for settling CLEAR calls.
Get the inline how-to-pay instructions for CLEAR.
GET /v1/clear/health Check the CLEAR service health · Health #
Ask an LLM
“Is the CLEAR prior authorization service up right now?”
“Can I ping CLEAR to confirm it is responding?”
Tell an agent
Check the health of the CLEAR service.
Confirm CLEAR is online.
GET /v1/clear/pricing Get CLEAR pricing · Pricing #
Ask an LLM
“What does CLEAR charge for prior authorization receipts and attestations?”
“Where can I see the current CLEAR price list?”
Tell an agent
Show the CLEAR pricing table.
Get current CLEAR prices.
POST /v1/clear/pa/submit Submit a prior authorization request · Pa Submit #
Ask an LLM
“How do I submit a prior authorization with CPT and ICD-10 codes and get a signed receipt?”
“Can I mark a prior authorization as urgent when submitting it?”
Tell an agent
Submit a PA from {provider} to payer {payer} for member {member}: CPT {cpt}, ICD-10 {icd10}, doc hash {doc_hash}.
File an {urgency} PA for member {member} with payer {payer}, provider {provider}, CPT {cpt}, ICD-10 {icd10}, doc {doc_hash}.
GET /v1/clear/pa/{pa_id} Retrieve a stored prior authorization · Pa Get #
Ask an LLM
“Can I pull back the details of a prior authorization I already submitted?”
“What was stored for a given PA id?”
Tell an agent
Get prior authorization {pa_id}.
Show me the stored PA record {pa_id}.
POST /v1/clear/pa/verify Verify a prior authorization's signed receipt · Pa Verify #
Ask an LLM
“How can I check that a PA's dual-signed receipt is valid?”
“Is the submission receipt for this prior authorization authentic?”
Tell an agent
Verify the dual-signed receipt for PA {pa_id}.
Check the submission signature on prior authorization {pa_id}.
POST /v1/clear/decision/attest Attest a payer's approve, deny or pend decision · Decision Attest #
Ask an LLM
“How do I record a payer's approval or denial of a prior authorization?”
“Does a decision attestation need a reason code?”
Tell an agent
Attest payer decision {decision} with reason {decision_reason_code} on PA {pa_id}, chained to {prior_attestation_id}.
Record that the payer denied PA {pa_id} with code {decision_reason_code}, after attestation {prior_attestation_id}; decision {decision}.
POST /v1/clear/p2p/attest Attest a peer-to-peer review outcome · P2P Attest #
Ask an LLM
“How do I record the outcome of a peer-to-peer review on a PA decision?”
“Can a peer-to-peer review be chained to the decision it challenged?”
Tell an agent
Attest peer-to-peer outcome {p2p_outcome} for decision {decision_id} on PA {pa_id}, chained to {prior_attestation_id}.
Log the peer-to-peer review of decision {decision_id} (PA {pa_id}) as {p2p_outcome}, prior attestation {prior_attestation_id}.
POST /v1/clear/appeal/attest Attest an appeal of a denial · Appeal Attest #
Ask an LLM
“How do I record an appeal against a prior authorization denial?”
“Can I note which appeal level was reached and how it turned out?”
Tell an agent
Attest a level {appeal_level} appeal of decision {decision_id} on PA {pa_id} with outcome {appeal_outcome}, chained to {prior_attestation_id}.
Record appeal outcome {appeal_outcome} at level {appeal_level} against denial {decision_id} for PA {pa_id}, after {prior_attestation_id}.
POST /v1/clear/chain/verify Verify a PA's full lifecycle chain · Chain Verify #
Ask an LLM
“Can I verify every attestation from submission through appeal for a prior authorization?”
“Is the whole decision and appeal chain for this PA intact?”
Tell an agent
Verify the full lifecycle chain for PA {pa_id}.
Check that every attestation linked to PA {pa_id} chains correctly.
GET /v1/clear/by-payer/{payer_did} List prior authorizations sent to a payer · By Payer #
Ask an LLM
“Which prior authorizations have been submitted to a particular payer?”
“Can I page through a payer's PA history?”
Tell an agent
List PA submissions for payer {payer_did}.
Show {limit} PAs for payer {payer_did} starting at offset {offset}.
GET /v1/clear/by-provider/{provider_did} List prior authorizations from a provider · By Provider #
Ask an LLM
“What prior authorizations has a given care provider submitted?”
“Can I paginate a provider's PA submission history?”
Tell an agent
List PA submissions from provider {provider_did}.
Show {limit} PAs submitted by provider {provider_did}, offset {offset}.

Documentation

📖
Documentation
https://thehiveryiq.com/developers
📖
APIReference
https://receipts.thehiveryiq.com/docs
📖
GettingStarted
https://thehiveryiq.com/agents
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/authentication/thehiveryiq-com-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/rate-limits/thehiveryiq-com-rate-limits.yml
📖
Documentation
https://thehiveryiq.com/sdk-quickstart/

Specifications

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

Other Resources

🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/llms/thehiveryiq-com-receipts-llms.txt
🔗
LLMsTxt
https://receipts.thehiveryiq.com/llms.txt
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/data-model/thehiveryiq-com-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/asyncapi/thehiveryiq-com-webhooks.yml
🔗
StatusPage
https://receipts.thehiveryiq.com/status
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/conventions/thehiveryiq-com-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/conventions/thehiveryiq-com-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/errors/thehiveryiq-com-problem-types.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/sandbox/thehiveryiq-com-sandbox.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/llms/thehiveryiq-com-hivecompute-llms.txt
🔗
LLMsTxt
https://api.thehiveryiq.com/llms.txt
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/thehiveryiq-com/refs/heads/main/mcp/thehiveryiq-com-tool-crosswalk.yml

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/thehiveryiq-com:thehiveryiq-com-clear-api"
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

thehiveryiq-com-clear-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HiveMorph v0.1 Clear API
  description: 'Polymorphic agent runtime — single shape (Merchant), single supermodel (W2 MERCHANT). Three gates: NEED + YIELD + CLEAN-MONEY.'
  version: 0.1.0
tags:
- name: Clear
paths:
  /v1/clear/how_to_pay:
    get:
      summary: Clear How To Pay
      description: 'Inline payment-options surface. Any agent / facilitator can hit this

        and learn how to settle into HiveMorph without any out-of-band setup.'
      operationId: clear_how_to_pay_v1_clear_how_to_pay_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Clear
  /v1/clear/health:
    get:
      tags:
      - Clear
      summary: Health
      operationId: health_v1_clear_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Health V1 Clear Health Get
  /v1/clear/pricing:
    get:
      tags:
      - Clear
      summary: Pricing
      operationId: pricing_v1_clear_pricing_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Pricing V1 Clear Pricing Get
  /v1/clear/pa/submit:
    post:
      tags:
      - Clear
      summary: Pa Submit
      description: Submit a Prior Authorization and return a dual-signed receipt.
      operationId: pa_submit_v1_clear_pa_submit_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PASubmitRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Pa Submit V1 Clear Pa Submit Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/pa/{pa_id}:
    get:
      tags:
      - Clear
      summary: Pa Get
      description: Retrieve a stored PA by id.
      operationId: pa_get_v1_clear_pa__pa_id__get
      parameters:
      - name: pa_id
        in: path
        required: true
        schema:
          type: string
          title: Pa Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Pa Get V1 Clear Pa  Pa Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/pa/verify:
    post:
      tags:
      - Clear
      summary: Pa Verify
      description: Verify a stored PA's dual-signed receipt.
      operationId: pa_verify_v1_clear_pa_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PAVerifyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Pa Verify V1 Clear Pa Verify Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/decision/attest:
    post:
      tags:
      - Clear
      summary: Decision Attest
      description: Attest a payer decision (approve/deny/pend) with chain pointer to PA.
      operationId: decision_attest_v1_clear_decision_attest_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecisionAttestRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Decision Attest V1 Clear Decision Attest Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/p2p/attest:
    post:
      tags:
      - Clear
      summary: P2P Attest
      description: Attest a peer-to-peer review with chain pointer to the decision.
      operationId: p2p_attest_v1_clear_p2p_attest_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/P2PAttestRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response P2P Attest V1 Clear P2P Attest Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/appeal/attest:
    post:
      tags:
      - Clear
      summary: Appeal Attest
      description: Attest an appeal with chain pointer to the denial decision.
      operationId: appeal_attest_v1_clear_appeal_attest_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppealAttestRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Appeal Attest V1 Clear Appeal Attest Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/chain/verify:
    post:
      tags:
      - Clear
      summary: Chain Verify
      description: Verify the full lifecycle chain for a PA.
      operationId: chain_verify_v1_clear_chain_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hivemorph__hive_clear__models__ChainVerifyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Chain Verify V1 Clear Chain Verify Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/by-payer/{payer_did}:
    get:
      tags:
      - Clear
      summary: By Payer
      description: Paginated PA submission history by payer DID.
      operationId: by_payer_v1_clear_by_payer__payer_did__get
      parameters:
      - name: payer_did
        in: path
        required: true
        schema:
          type: string
          title: Payer Did
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response By Payer V1 Clear By Payer  Payer Did  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/clear/by-provider/{provider_did}:
    get:
      tags:
      - Clear
      summary: By Provider
      description: Paginated PA submission history by provider DID.
      operationId: by_provider_v1_clear_by_provider__provider_did__get
      parameters:
      - name: provider_did
        in: path
        required: true
        schema:
          type: string
          title: Provider Did
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response By Provider V1 Clear By Provider  Provider Did  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UrgencyEnum:
      type: string
      enum:
      - standard
      - expedited
      title: UrgencyEnum
    PASubmitRequest:
      properties:
        payer_did:
          type: string
          title: Payer Did
          description: DID of the payer (did:hive:...)
        provider_did:
          type: string
          title: Provider Did
          description: DID of the provider (did:hive:...)
        member_did:
          type: string
          title: Member Did
          description: Opaque/pseudonymous member DID — no PHI stored (did:hive:...)
        cpt_codes:
          items:
            type: string
          type: array
          title: Cpt Codes
          description: CPT procedure codes
        icd10_codes:
          items:
            type: string
          type: array
          title: Icd10 Codes
          description: ICD-10 diagnosis codes
        clinical_doc_hash:
          type: string
          title: Clinical Doc Hash
          description: sha256 hex of canonical clinical doc bundle — no raw document stored
        urgency:
          $ref: '#/components/schemas/UrgencyEnum'
          description: standard or expedited
          default: standard
      type: object
      required:
      - payer_did
      - provider_did
      - member_did
      - cpt_codes
      - icd10_codes
      - clinical_doc_hash
      title: PASubmitRequest
      description: Request to submit a Prior Authorization.
    hivemorph__hive_clear__models__ChainVerifyRequest:
      properties:
        pa_id:
          type: string
          title: Pa Id
          description: pa_id to trace the full chain for
      type: object
      required:
      - pa_id
      title: ChainVerifyRequest
      description: Request to verify the full lifecycle chain for a PA.
    AppealOutcomeEnum:
      type: string
      enum:
      - upheld
      - overturned
      - pending
      title: AppealOutcomeEnum
    DecisionEnum:
      type: string
      enum:
      - approve
      - deny
      - pend
      title: DecisionEnum
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    P2PAttestRequest:
      properties:
        pa_id:
          type: string
          title: Pa Id
          description: pa_id of the PA under review
        decision_id:
          type: string
          title: Decision Id
          description: Chain pointer to the denial decision
        p2p_outcome:
          $ref: '#/components/schemas/P2POutcomeEnum'
          description: upheld / overturned / pending
        prior_attestation_id:
          type: string
          title: Prior Attestation Id
          description: UUID chain pointer to the decision envelope
      type: object
      required:
      - pa_id
      - decision_id
      - p2p_outcome
      - prior_attestation_id
      title: P2PAttestRequest
      description: Request to attest a peer-to-peer review.
    PAVerifyRequest:
      properties:
        pa_id:
          type: string
          title: Pa Id
          description: pa_id to verify
      type: object
      required:
      - pa_id
      title: PAVerifyRequest
      description: Request to verify a stored PA.
    P2POutcomeEnum:
      type: string
      enum:
      - upheld
      - overturned
      - pending
      title: P2POutcomeEnum
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DecisionAttestRequest:
      properties:
        pa_id:
          type: string
          title: Pa Id
          description: pa_id of the PA being decided
        decision:
          $ref: '#/components/schemas/DecisionEnum'
          description: approve / deny / pend
        decision_reason_code:
          type: string
          title: Decision Reason Code
          description: Payer reason code for the decision
        prior_attestation_id:
          type: string
          title: Prior Attestation Id
          description: UUID chain pointer to the PA submission envelope (pa_id)
      type: object
      required:
      - pa_id
      - decision
      - decision_reason_code
      - prior_attestation_id
      title: DecisionAttestRequest
      description: Request to attest a payer decision on a PA.
    AppealLevelEnum:
      type: string
      enum:
      - internal
      - external_irO
      - state_doi
      - federal
      title: AppealLevelEnum
    AppealAttestRequest:
      properties:
        pa_id:
          type: string
          title: Pa Id
          description: pa_id of the PA being appealed
        decision_id:
          type: string
          title: Decision Id
          description: Chain pointer to the denial decision
        appeal_level:
          $ref: '#/components/schemas/AppealLevelEnum'
          description: internal / external_irO / state_doi / federal
        appeal_outcome:
          $ref: '#/components/schemas/AppealOutcomeEnum'
          description: upheld / overturned / pending
        prior_attestation_id:
          type: string
          title: Prior Attestation Id
          description: UUID chain pointer to the denial decision envelope
      type: object
      required:
      - pa_id
      - decision_id
      - appeal_level
      - appeal_outcome
      - prior_attestation_id
      title: AppealAttestRequest
      description: Request to attest an appeal.
x-provenance:
  method: harvested
  publisher: Hive Civilization
  source: https://receipts.thehiveryiq.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)